CoherenceClusterSystemResourceMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface CoherenceClusterSystemResourceMBean

All Superinterfaces:: BasicDeploymentMBean, ConfigurationExtensionMBean, ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, SystemResourceMBean, TargetInfoMBean, WebLogicMBean

public interface CoherenceClusterSystemResourceMBean
extends SystemResourceMBean
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
`CoherenceCacheConfigMBean`	`createCoherenceCacheConfig(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.
`String`	`getCustomClusterConfigurationFileName()` The external custom Coherence cluster configuration file.
`String`	`getDescriptorFileName()` The name of the file that contains the module configuration.
`String`	`getReportGroupFile()` Get the report group file representing the superset of runtime metrics to be collected for this cluster.
`void`	`importCustomClusterConfigurationFile(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(String name)` Returns a CoherenceCacheConfigMBean with the specified name.
`void`	`setReportGroupFile(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.SystemResourceMBean
`getResource, getSourcePath, setName`

Methods inherited from interface weblogic.management.configuration.BasicDeploymentMBean
`createSubDeployment, destroySubDeployment, getDeploymentOrder, getDeploymentPrincipalName, getSubDeployments, lookupSubDeployment, setDeploymentOrder, setDeploymentPrincipalName, setSourcePath`

Methods inherited from interface weblogic.management.configuration.TargetInfoMBean
`addTarget, getCompatibilityName, getName, getTargets, removeTarget, setCompatibilityName, setModuleType, setTargets`

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.management.WebLogicMBean
`getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent`

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.descriptor.DescriptorBean
`addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener`

Method Detail

getDescriptorFileName

String getDescriptorFileName()

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

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

.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 a 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

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
Default Value:: "em/coherence/report-group.xml"

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