com.oracle.bedrock.runtime.coherence

Interface CoherenceClusterMember

All Superinterfaces:

Application, AutoCloseable, Closeable, com.oracle.bedrock.extensible.Extensible, JavaApplication, RemoteChannel

All Known Implementing Classes:

AbstractCoherenceClusterMember, CoherenceCacheServer

public interface CoherenceClusterMember
extends JavaApplication

A specialized JavaApplication that represents an Oracle Coherence Cluster Member at runtime.

Copyright (c) 2014. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Brian Oliver

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CoherenceClusterMember.MetaClass The MetaClass for CoherenceClusterMembers.

Nested classes/interfaces inherited from interface com.oracle.bedrock.runtime.concurrent.RemoteChannel

RemoteChannel.AcknowledgeWhen, RemoteChannel.Inject

Field Summary

Fields inherited from interface com.oracle.bedrock.runtime.java.JavaApplication

JAVA_HOME, JAVA_NET_PREFER_IPV4_STACK, JAVA_NET_PREFER_IPV6_STACK, JAVA_RMI_SERVER_HOSTNAME

Method Summary

Modifier and Type	Method and Description
com.tangosol.net.NamedCache	getCache(String cacheName) Obtains a proxy of the specified NamedCache available in the CoherenceClusterMember.
<K,V> com.tangosol.net.NamedCache<K,V>	getCache(String cacheName, Class<K> keyClass, Class<V> valueClass) Obtains a proxy of a strongly-typed NamedCache available in the CoherenceClusterMember.
Set<com.tangosol.util.UID>	getClusterMemberUIDs() Obtains the member UIDs for the CoherenceCluster in which the CoherenceClusterMember is operating.
String	getClusterName() Obtains the cluster name for the local member.
int	getClusterSize() Obtains the number of members in the cluster in which the member represented by this CoherenceClusterMember belongs.
int	getLocalMemberId() Obtains the local member id for the CoherenceClusterMember.
com.tangosol.util.UID	getLocalMemberUID() Obtains the local member UID for the CoherenceClusterMember.
String	getRoleName() Obtains the role name for the local member.
com.oracle.bedrock.runtime.coherence.ServiceStatus	getServiceStatus(String serviceName) Determines the status of a service being run by the CoherenceClusterMember.
String	getSiteName() Obtains the site name for the local member.
boolean	isServiceRunning(String serviceName) Determines if a specified service is being run by the CoherenceClusterMember.
com.oracle.bedrock.util.Trilean	isStorageEnabled(String serviceName) Determines if a specified service is storage enabled.

Methods inherited from interface com.oracle.bedrock.runtime.java.JavaApplication

getProxyFor, getSystemProperties, getSystemProperty, invoke

Methods inherited from interface com.oracle.bedrock.runtime.Application

close, close, exitValue, getDefaultTimeout, getId, getName, getOptions, getPlatform, isOperational, waitFor

Methods inherited from interface com.oracle.bedrock.extensible.Extensible

add, add, get, has, remove

Methods inherited from interface com.oracle.bedrock.runtime.concurrent.RemoteChannel

addListener, get, raise, removeListener, submit, submit

Method Detail

getClusterSize

int getClusterSize()

Obtains the number of members in the cluster in which the member represented by this CoherenceClusterMember belongs.

Returns:

the number of members in the cluster

getLocalMemberId

int getLocalMemberId()

Obtains the local member id for the CoherenceClusterMember.

Returns:

the local member id

getLocalMemberUID

com.tangosol.util.UID getLocalMemberUID()

Obtains the local member UID for the CoherenceClusterMember.

Returns:

the local member UID

getClusterMemberUIDs

Set<com.tangosol.util.UID> getClusterMemberUIDs()

Obtains the member UIDs for the CoherenceCluster in which the CoherenceClusterMember is operating.

Returns:

a Set of UID, one for each CoherenceClusterMember

getRoleName

String getRoleName()

Obtains the role name for the local member.

Returns:

the role name

getSiteName

String getSiteName()

Obtains the site name for the local member.

Returns:

the site name

getClusterName

String getClusterName()

Obtains the cluster name for the local member.

Returns:

the site name

getCache

com.tangosol.net.NamedCache getCache(String cacheName)

Obtains a proxy of the specified NamedCache available in the CoherenceClusterMember.

WARNING: Some methods on the returned NamedCache proxy are not available for remote execution and are thus not supported. Attempts to use such methods will thrown UnsupportedOperationException.

The unsupported methods are: getCacheService, addMapListener, removeMapListener, entrySet, values, addIndex and removeIndex.

Additionally note that method invocations taking unserializable parameters or returning unserializable values will throw NotSerializableExceptions.

Parameters:

cacheName - the name of the NamedCache

Returns:

a proxy to the NamedCache

getCache

<K,V> com.tangosol.net.NamedCache<K,V> getCache(String cacheName,
                                                Class<K> keyClass,
                                                Class<V> valueClass)

Obtains a proxy of a strongly-typed NamedCache available in the CoherenceClusterMember.

WARNING: Some methods on the returned NamedCache proxy are not available for remote execution and are thus not supported. Attempts to use such methods will thrown UnsupportedOperationException.

The unsupported methods are: getCacheService, addMapListener, removeMapListener, entrySet, values, addIndex and removeIndex.

Additionally note that method invocations taking unserializable parameters or returning unserializable values will throw NotSerializableExceptions.

Type Parameters:

K - the type of the key class

V - the type of the value class

Parameters:

cacheName - the name of the NamedCache

keyClass - the type of the keys for the NamedCache

valueClass - the type of the values for the NamedCache

Returns:

a proxy to the NamedCache

isServiceRunning

boolean isServiceRunning(String serviceName)

Determines if a specified service is being run by the CoherenceClusterMember.

Parameters:

serviceName - the name of the service

Returns:

true if the service is running, false otherwise

isStorageEnabled

com.oracle.bedrock.util.Trilean isStorageEnabled(String serviceName)

Determines if a specified service is storage enabled.

Parameters:

serviceName - the name of the service

Returns:

a Trilean indicating if the service is storage enabled Trilean.TRUE, disabled Trilean.FALSE or unknown / undefined / not applicable Trilean.UNKNOWN

getServiceStatus

com.oracle.bedrock.runtime.coherence.ServiceStatus getServiceStatus(String serviceName)

Determines the status of a service being run by the CoherenceClusterMember.

Parameters:

serviceName - the name of the service

Returns:

the ServiceStatus