Package weblogic.management.configuration

Interface CoherenceClusterSystemResourceMBean

All Superinterfaces:

BasicDeploymentMBean, ConfigurationExtensionMBean, ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, SystemResourceMBean, TargetInfoMBean, WebLogicMBean

public interface CoherenceClusterSystemResourceMBean
extends SystemResourceMBean

This bean defines a system-level Coherence cluster resource. It links to a separate descriptor that specifies the definition.

Access limited to the following security roles:

Deployer

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
CoherenceCacheConfigMBean	createCoherenceCacheConfig(java.lang.String name)	Factory to create CoherenceCacheConfigMBean instances.
void	destroyCoherenceCacheConfig(CoherenceCacheConfigMBean cacheConfig)	destroys CoherenceCacheConfigMBean
CoherenceCacheConfigMBean[]	getCoherenceCacheConfigs()	An array of CacheConfigBeans, each of which represents a cache configuration.
WeblogicCoherenceBean	getCoherenceClusterResource()	The Coherence cluster resource descriptor.
java.lang.String	getCustomClusterConfigurationFileName()	The external custom Coherence cluster configuration file.
long	getCustomConfigFileLastUpdatedTime()	The time when the custom configuration file used by the cluster was last updated
java.lang.String	getDescriptorFileName()	The name of the file that contains the module configuration.
int	getFederationRemoteClusterListenPort()	The Coherence Cluster Listen Port of the remote participant.
java.lang.String	getFederationRemoteClusterName()	The Coherence Cluster Name of the remote participant cluster.
java.lang.String[]	getFederationRemoteParticipantHosts()	The list of remote participant hosts, who will be added as participants in the federation topology.
java.lang.String	getFederationTopology()	The federation topology.
java.lang.String	getName()	The user-specified name of this MBean instance.
java.lang.String	getPersistenceActiveDirectory()	The active directory for the default persistence environment.
java.lang.String	getPersistenceDefaultMode()	The default persistence mode.
java.lang.String	getPersistenceSnapshotDirectory()	The snapshot directory for the default persistence environment.
java.lang.String	getPersistenceTrashDirectory()	The trash directory for the default persistence environment.
java.lang.String	getReportGroupFile()	Get the report group file representing the superset of runtime metrics to be collected for this cluster.
TargetMBean[]	getTargets()	You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed.
void	importCustomClusterConfigurationFile(java.lang.String file)	Allows you to specify a custom Coherence cluster configuration file.
boolean	isUsingCustomClusterConfigurationFile()	Specifies whether you are using a custom external Coherence cluster configuration file.
CoherenceCacheConfigMBean	lookupCoherenceCacheConfig(java.lang.String name)	Returns a CoherenceCacheConfigMBean with the specified name.
void	setReportGroupFile(java.lang.String sReportFile)	Set the report group file representing the superset of runtime metrics to be collected for this cluster.
void	setUsingCustomClusterConfigurationFile(boolean useCustomFile)	Allows you to enable or disable use of a custom cluster configuration file.

Methods inherited from interface weblogic.management.configuration.BasicDeploymentMBean

createSubDeployment, destroySubDeployment, getDeploymentOrder, getDeploymentPrincipalName, getSubDeployments, lookupSubDeployment, setDeploymentOrder, setDeploymentPrincipalName, setSourcePath

Methods inherited from interface weblogic.management.configuration.ConfigurationExtensionMBean

setDescriptorFileName

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.configuration.SystemResourceMBean

getResource, getSourcePath, setName

Methods inherited from interface weblogic.management.configuration.TargetInfoMBean

addTarget, getCompatibilityName, removeTarget, setCompatibilityName, setModuleType, setTargets

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Method Detail

getName

java.lang.String getName()

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:

Name=user-specified-name

Specified by:

getName in interface ConfigurationMBean

Specified by:

getName in interface TargetInfoMBean

Specified by:

getName in interface WebLogicMBean

getDescriptorFileName

java.lang.String getDescriptorFileName()

The name of the file that contains the module configuration. By default the file resides in the DOMAIN_DIR/config/coherence/bean_name directory.

The module file derives its name from the bean name using the following pattern:

<beanName>.xml

Note that this is a read-only property that can only be set when the bean is created.

Specified by:

getDescriptorFileName in interface ConfigurationExtensionMBean

Returns:

name of descriptor file

getCustomClusterConfigurationFileName

java.lang.String getCustomClusterConfigurationFileName()

The external custom Coherence cluster configuration file.

Returns:

Returns the external cluster configuration file referred by CoherenceClusterSystemResourceMBean.

isUsingCustomClusterConfigurationFile

boolean isUsingCustomClusterConfigurationFile()

Specifies whether you are using a custom external Coherence cluster configuration file.

Returns:

true if the CoherenceClusterSystemResourceMBean refers to an external tangosol-coherence-override.xml file.

importCustomClusterConfigurationFile

void importCustomClusterConfigurationFile(java.lang.String file)
                                   throws ManagementException

Allows you to specify a custom Coherence cluster configuration file. The file must be present locally on the Administration Server.

Parameters:

file - Absolute path to the custom Coherence cluster configuration file

Throws:

ManagementException

getCoherenceClusterResource

WeblogicCoherenceBean getCoherenceClusterResource()

The Coherence cluster resource descriptor.

Returns:

Root bean of CoherenceCluster descriptor

setUsingCustomClusterConfigurationFile

void setUsingCustomClusterConfigurationFile(boolean useCustomFile)
                                     throws ManagementException

Allows you to enable or disable use of a custom cluster configuration file.

Parameters:

useCustomFile -

Throws:

ManagementException - thrown if one attempts to

getCoherenceCacheConfigs

CoherenceCacheConfigMBean[] getCoherenceCacheConfigs()

An array of CacheConfigBeans, each of which represents a cache configuration.

Returns:

an array of CoherenceCacheConfig objects

createCoherenceCacheConfig

CoherenceCacheConfigMBean createCoherenceCacheConfig(java.lang.String name)

Factory to create CoherenceCacheConfigMBean instances.

This method is here to force the binding code to generate correctly.

Parameters:

name -

Returns:

CoherenceCacheConfig object

destroyCoherenceCacheConfig

void destroyCoherenceCacheConfig(CoherenceCacheConfigMBean cacheConfig)

destroys CoherenceCacheConfigMBean

Parameters:

cacheConfig -

lookupCoherenceCacheConfig

CoherenceCacheConfigMBean lookupCoherenceCacheConfig(java.lang.String name)

Returns a CoherenceCacheConfigMBean with the specified name.

Parameters:

name -

Returns:

CoherenceCacheConfig object

getReportGroupFile

java.lang.String getReportGroupFile()

Get the report group file representing the superset of runtime metrics to be collected for this cluster.

Returns:

report group file location

Default Value:

"em/metadata/reports/coherence/report-group.xml"

setReportGroupFile

void setReportGroupFile(java.lang.String sReportFile)

Set the report group file representing the superset of runtime metrics to be collected for this cluster.

Parameters:

sReportFile - the report group file to use

getTargets

TargetMBean[] getTargets()

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Specified by:

getTargets in interface TargetInfoMBean

Returns:

The targets value

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

getCustomConfigFileLastUpdatedTime

long getCustomConfigFileLastUpdatedTime()

The time when the custom configuration file used by the cluster was last updated

getPersistenceDefaultMode

java.lang.String getPersistenceDefaultMode()

The default persistence mode.

getPersistenceActiveDirectory

java.lang.String getPersistenceActiveDirectory()

The active directory for the default persistence environment. If no value is specified, the directory which will be used is the coherence/active sub-directory under Domain Home directory.

getPersistenceSnapshotDirectory

java.lang.String getPersistenceSnapshotDirectory()

The snapshot directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/snapshots sub-directory under Domain Home directory.

getPersistenceTrashDirectory

java.lang.String getPersistenceTrashDirectory()

The trash directory for the default persistence environment. If no value is specified, the directory which will be used is coherence/trash sub-directory under Domain Home directory.

getFederationTopology

java.lang.String getFederationTopology()

The federation topology.

getFederationRemoteParticipantHosts

java.lang.String[] getFederationRemoteParticipantHosts()

The list of remote participant hosts, who will be added as participants in the federation topology.

getFederationRemoteClusterName

java.lang.String getFederationRemoteClusterName()

The Coherence Cluster Name of the remote participant cluster.

getFederationRemoteClusterListenPort

int getFederationRemoteClusterListenPort()

The Coherence Cluster Listen Port of the remote participant.