com.oracle.bedrock.runtime.coherence

Class AbstractCoherenceClusterMember

java.lang.Object

com.oracle.bedrock.extensible.AbstractExtensible

com.oracle.bedrock.runtime.AbstractApplication<P>

com.oracle.bedrock.runtime.java.AbstractJavaApplication<JavaApplicationProcess>

com.oracle.bedrock.runtime.coherence.AbstractCoherenceClusterMember

All Implemented Interfaces:

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

Direct Known Subclasses:

CoherenceCacheServer

public abstract class AbstractCoherenceClusterMember
extends AbstractJavaApplication<JavaApplicationProcess>
implements CoherenceClusterMember

An abstract implementation of a CoherenceClusterMember.

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/interfaces inherited from interface com.oracle.bedrock.runtime.coherence.CoherenceClusterMember

CoherenceClusterMember.MetaClass

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

RemoteChannel.AcknowledgeWhen, RemoteChannel.Inject

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME_CLUSTER The MBean name of the Coherence Cluster MBean.

Fields inherited from class com.oracle.bedrock.runtime.AbstractApplication

console, displayName, optionsByType, platform, process

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

Constructor Summary

Constructors

Constructor and Description
AbstractCoherenceClusterMember(Platform platform, JavaApplicationProcess process, com.oracle.bedrock.OptionsByType optionsByType) Constructs an AbstractCoherenceClusterMember.

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.
MBeanInfo	getClusterMBeanInfo() Obtains the Coherence Cluster MBeanInfo for the AbstractCoherenceClusterMember.
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.
MBeanInfo	getServiceMBeanInfo(String serviceName, int nodeId) Obtains the Coherence Service MBeanInfo for the AbstractCoherenceClusterMember.
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 class com.oracle.bedrock.runtime.java.AbstractJavaApplication

addListener, getProxyFor, getSystemProperties, getSystemProperty, raise, removeListener, submit, submit

Methods inherited from class com.oracle.bedrock.runtime.AbstractApplication

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

Methods inherited from class com.oracle.bedrock.extensible.AbstractExtensible

add, add, get, getInstancesOf, has, remove, removeAllFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Detail

MBEAN_NAME_CLUSTER

public static final String MBEAN_NAME_CLUSTER

The MBean name of the Coherence Cluster MBean.

See Also:

Constant Field Values

Constructor Detail

AbstractCoherenceClusterMember

public AbstractCoherenceClusterMember(Platform platform,
                                      JavaApplicationProcess process,
                                      com.oracle.bedrock.OptionsByType optionsByType)

Constructs an AbstractCoherenceClusterMember.

Parameters:

platform - the Platform on which the Application was launched

process - the underlying ApplicationProcess representing the Application

optionsByType - the OptionsByType used to launch the Application

Method Detail

getClusterMBeanInfo

public MBeanInfo getClusterMBeanInfo()

Obtains the Coherence Cluster MBeanInfo for the AbstractCoherenceClusterMember.

If the JMX infrastructure in the JavaApplication is not yet available, it will block at wait for the default application timeout until it becomes available.

Returns:

a MBeanInfo

Throws:

PermanentlyUnavailableException - when the resource is not available

UnsupportedOperationException - when JMX is not enabled for the JavaApplication

getClusterSize

public int getClusterSize()

Description copied from interface: CoherenceClusterMember

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

Specified by:

getClusterSize in interface CoherenceClusterMember

Returns:

the number of members in the cluster

getLocalMemberId

public int getLocalMemberId()

Description copied from interface: CoherenceClusterMember

Obtains the local member id for the CoherenceClusterMember.

Specified by:

getLocalMemberId in interface CoherenceClusterMember

Returns:

the local member id

getLocalMemberUID

public com.tangosol.util.UID getLocalMemberUID()

Description copied from interface: CoherenceClusterMember

Obtains the local member UID for the CoherenceClusterMember.

Specified by:

getLocalMemberUID in interface CoherenceClusterMember

Returns:

the local member UID

getClusterMemberUIDs

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

Description copied from interface: CoherenceClusterMember

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

Specified by:

getClusterMemberUIDs in interface CoherenceClusterMember

Returns:

a Set of UID, one for each CoherenceClusterMember

getServiceMBeanInfo

public MBeanInfo getServiceMBeanInfo(String serviceName,
                                     int nodeId)

Obtains the Coherence Service MBeanInfo for the AbstractCoherenceClusterMember.

If the JMX infrastructure in the JavaApplication is not yet available, it will block at wait for the default application timeout until it becomes available.

Parameters:

serviceName - the name of the service

nodeId - the nodeId on which the service is defined

Returns:

a MBeanInfo

Throws:

PermanentlyUnavailableException - when the resource is not available

UnsupportedOperationException - when JMX is not enabled for the JavaApplication

getRoleName

public String getRoleName()

Description copied from interface: CoherenceClusterMember

Obtains the role name for the local member.

Specified by:

getRoleName in interface CoherenceClusterMember

Returns:

the role name

getSiteName

public String getSiteName()

Description copied from interface: CoherenceClusterMember

Obtains the site name for the local member.

Specified by:

getSiteName in interface CoherenceClusterMember

Returns:

the site name

getClusterName

public String getClusterName()

Description copied from interface: CoherenceClusterMember

Obtains the cluster name for the local member.

Specified by:

getClusterName in interface CoherenceClusterMember

Returns:

the site name

getCache

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

Description copied from interface: CoherenceClusterMember

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.

Specified by:

getCache in interface CoherenceClusterMember

Parameters:

cacheName - the name of the NamedCache

Returns:

a proxy to the NamedCache

getCache

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

Description copied from interface: CoherenceClusterMember

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.

Specified by:

getCache in interface CoherenceClusterMember

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

public boolean isServiceRunning(String serviceName)

Description copied from interface: CoherenceClusterMember

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

Specified by:

isServiceRunning in interface CoherenceClusterMember

Parameters:

serviceName - the name of the service

Returns:

true if the service is running, false otherwise

isStorageEnabled

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

Description copied from interface: CoherenceClusterMember

Determines if a specified service is storage enabled.

Specified by:

isStorageEnabled in interface CoherenceClusterMember

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

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

Description copied from interface: CoherenceClusterMember

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

Specified by:

getServiceStatus in interface CoherenceClusterMember

Parameters:

serviceName - the name of the service

Returns:

the ServiceStatus