Skip navigation links

weblogic.management.configuration
Interface CoherenceClusterSystemResourceMBean

All Superinterfaces:

BasicDeploymentMBean, ConfigurationExtensionMBean, ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, 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.

getName

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

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

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(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(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 -

Since:

12.1.2.0

lookupCoherenceCacheConfig

CoherenceCacheConfigMBean lookupCoherenceCacheConfig(String name)

Returns a CoherenceCacheConfigMBean with the specified name.

Parameters:

name -

Returns:

CoherenceCacheConfig object

getReportGroupFile

String getReportGroupFile()

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

Returns:

report group file location

setReportGroupFile

void setReportGroupFile(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

Skip navigation links