CoherenceClusterSystemResourceMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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

       
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.CoherenceClusterSystemResourceMBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:
Access Points Inherited from SystemResourceMBean Because this MBean extends or implements SystemResourceMBean, you can also access this MBean by retrieving SystemResourceMBeans. The following attributes contain SystemResourceMBeans and its subtypes:

    Related MBeans

    This section describes attributes that provide access to other MBeans.

    CoherenceCacheConfigs

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

               
    Factory MethodscreateCoherenceCacheConfig (java.lang.String name)

    destroyCoherenceCacheConfig (CoherenceCacheConfigMBean cacheConfig)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupCoherenceCacheConfig(String name)

    Returns a javax.management.ObjectName for the instance of CoherenceCacheConfigMBean named name.

    Privileges Read only
    TypeCoherenceCacheConfigMBean[]
    Relationship type: Containment.

    CoherenceClusterResource

    The Coherence cluster resource descriptor.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeWeblogicCoherenceBean
    Relationship type: Containment.

    Resource

    Return the Descriptor for the system resource. This should be overridden by the derived system resources.

           
    Privileges Read only
    TypeDescriptorBean
    Relationship type: Reference.

    SubDeployments

    Targeting for subcomponents that differs from targeting for the component.

               
    Factory MethodscreateSubDeployment (java.lang.String name)

    destroySubDeployment (SubDeploymentMBean subDeployment)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupSubDeployment(String name)

    Returns a javax.management.ObjectName for the instance of SubDeploymentMBean named name.

    Privileges Read only
    TypeSubDeploymentMBean[]
    Relationship type: Containment.

    Targets

    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.

           
    Privileges Read/Write
    TypeTargetMBean[]
    Relationship type: Reference.

    Attributes

    This section describes the following attributes:

    CachingDisabled

    Private property that disables caching in proxies.

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read only
    Typeboolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    ClusterHosts

    The list of hostnames of the managed servers belonging to this Coherence cluster.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typeclass java.lang.String[]
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    CompatibilityName

    This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

    Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

           
    Privileges Read/Write
    Typejava.lang.String

    CustomClusterConfigurationFileName

    The external custom Coherence cluster configuration file.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    CustomConfigFileLastUpdatedTime

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

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typelong
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    DeploymentOrder

    An integer value that indicates when this unit is deployed, relative to other deployable units on a server, during startup.

    Units with lower values are deployed before those with higher values.

           
    Privileges Read/Write
    Typeint
    Default Value100

    DeploymentPrincipalName

    A string value that indicates the principal that should be used when deploying the file or archive during startup and shutdown. This principal will be used to set the current subject when calling out into application code for interfaces such as ApplicationLifecycleListener. If no principal name is specified, then the anonymous principal will be used.

           
    Privileges Read/Write
    Typejava.lang.String

    DescriptorFileName

    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.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    DynamicallyCreated

    Return whether the MBean was created dynamically or is persisted to config.xml

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read only
    Typeboolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    FederationRemoteClusterListenPort

    The Coherence Cluster Listen Port of the remote participant.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typeint
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    FederationRemoteClusterName

    The Coherence Cluster Name of the remote participant cluster.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    FederationRemoteParticipantHosts

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

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typeclass java.lang.String[]
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    FederationTopology

    The federation topology.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Id

    Return the unique id of this MBean instance

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read only
    Typelong
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    MBeanInfo

    Returns the MBean info for this MBean.

    This attribute is not dynamic and requires a server restart to take effect.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    ModuleType

    The values match those defined by jsr88. This attribute may move to another MBean.

           
    Privileges Read/Write
    Typejava.lang.String

    Name

    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

           
    Privileges Read/Write
    Typejava.lang.String

    Notes

    Optional information that you can include to describe this configuration.

    WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

    Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

    This attribute is not dynamic and requires a server restart to take effect.

               
    Privileges Read/Write
    Security rolesWrite access is granted only to the following roles:
    • Deployer
    • Operator
    Typejava.lang.String

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    This attribute is not dynamic and requires a server restart to take effect.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Parent

    Return the immediate parent for this MBean

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read/Write
    Type

    PersistenceActiveDirectory

    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.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    PersistenceDefaultMode

    The default persistence mode.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    PersistenceSnapshotDirectory

    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.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    PersistenceTrashDirectory

    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.

           
    Available Since Release 12.2.1.1.0
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Registered

    Returns false if the MBean represented by this object has been unregistered.

    This attribute is not dynamic and requires a server restart to take effect.

    Deprecated.

           
    Privileges Read only
    Typeboolean
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    ReportGroupFile

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

           
    Privileges Read/Write
    Typejava.lang.String
    Default Valueem/metadata/reports/coherence/report-group.xml

    SourcePath

           
    Privileges Read/Write
    Typejava.lang.String

    Tags

    Return all tags on this Configuration MBean

    This attribute is dynamic and takes effect immediately.

           
    Available Since Release 12.2.1.0.0
    Privileges Read/Write
    Typeclass java.lang.String[]

    Type

    Returns the type of the MBean.

    This attribute is not dynamic and requires a server restart to take effect.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    UsingCustomClusterConfigurationFile

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

           
    Privileges Read/Write
    Typeboolean

    Operations

    This section describes the following operations:

    addTag

    Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.

       
    Operation Name"addTag"
    ParametersObject [] {  tag }

    where:

    • tag is an object of type java.lang.String that specifies:

      tag to be added to the MBean
    SignatureString [] { "java.lang.String" }
    Returns boolean
    Exceptions
    • java.lang.IllegalArgumentException
      IllegalArgumentException if the tag contains illegal punctuation

    addTarget

    You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

       
    Operation Name"addTarget"
    ParametersObject [] {  target }

    where:

    • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

      The feature to be added to the Target attribute
    SignatureString [] { "weblogic.management.configuration.TargetMBean" }
    Returns void
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.DistributedManagementException

    freezeCurrentValue

    If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

    Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

    Note: To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

    Deprecated. 9.0.0.0

       
    Operation Name"freezeCurrentValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName
    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException
    • javax.management.MBeanException

    getInheritedProperties

    Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.

       
    Operation Name"getInheritedProperties"
    ParametersObject [] {  propertyNames }

    where:

    • propertyNames is an object of type [Ljava.lang.String; that specifies:

      properties to check
    SignatureString [] { "[Ljava.lang.String;" }
    Returns class

    importCustomClusterConfigurationFile

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

       
    Operation Name"importCustomClusterConfigurationFile"
    ParametersObject [] {  file }

    where:

    • file is an object of type java.lang.String that specifies:

      Absolute path to the custom Coherence cluster configuration file
    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • weblogic.management.ManagementException

    isInherited

    Check if the value of a property is inherited from template mbean or not.

       
    Operation Name"isInherited"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      the name of the property
    SignatureString [] { "java.lang.String" }
    Returns boolean

    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check
    SignatureString [] { "java.lang.String" }
    Returns boolean

    removeTag

    Remove a tag from this Configuration MBean

       
    Operation Name"removeTag"
    ParametersObject [] {  tag }

    where:

    • tag is an object of type java.lang.String that specifies:

      tag to be removed from the MBean
    SignatureString [] { "java.lang.String" }
    Returns boolean
    Exceptions
    • java.lang.IllegalArgumentException
      IllegalArgumentException if the tag contains illegal punctuation

    removeTarget

    Removes the value of the Target attribute.

    For more information, see:

       
    Operation Name"removeTarget"
    ParametersObject [] {  target }

    where:

    • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

      The target to remove
    SignatureString [] { "weblogic.management.configuration.TargetMBean" }
    Returns void
    Exceptions
    • javax.management.InvalidAttributeValueException
    • weblogic.management.DistributedManagementException

    restoreDefaultValue

    If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

    Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

    Deprecated. 9.0.0.0

       
    Operation Name"restoreDefaultValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName
    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • javax.management.AttributeNotFoundException

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore
    SignatureString [] { "java.lang.String" }
    Returns void