CoherenceServerMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This class represents a Coherence stand-alone server.

   
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.CoherenceServerMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Related MBeans

This section describes attributes that provide access to other MBeans.


CoherenceClusterSystemResource

The system-level Coherence cluster resource associated with this server.

       
Privileges Read/Write
TypeCoherenceClusterSystemResourceMBean
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

CoherenceServerStart

Returns the CoherenceServerStartMBean that can be used to start up this server remotely.

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

Machine

The WebLogic Server host computer (machine) on which this server is meant to run.

If you want to use a Node Manager to start this server, you must assign the server to a machine and you must configure the machine for the Node Manager.

You cannot change this value if a server instance is already running.

       
Privileges Read/Write
TypeMachineMBean
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


Attributes

This section describes the following attributes:


AutoRestart

Specifies whether the Node Manager can automatically restart this server if it crashes or otherwise goes down unexpectedly.

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typeboolean
Default Valuetrue

CachingDisabled

Private property that disables caching in proxies.

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

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

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

Name

An alphanumeric name for this server instance. (Spaces are not valid.)

The name must be unique for all configuration objects in the domain. Within a domain, each server, machine, cluster, JDBC connection pool, virtual host, and any other resource type must be named uniquely and must not use the same name as the domain.

The server name is not used as part of the URL for applications that are deployed on the server. It is for your identification purposes only. The server name displays in the Administration Console, and if you use WebLogic Server command-line utilities or APIs, you use this name to identify the server.

After you have created a server, you cannot change its name. Instead, clone the server and provide a new name for the clone.

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typejava.lang.String

NMSocketCreateTimeoutInMillis

Returns the timeout value to be used by NodeManagerRuntime when creating a socket connection to the agent. Default set high as SSH agent may require a high connection establishment time.

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typeint
Default Value180000
Minimum value0

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever 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.

       
Privileges Read/Write
Typejava.lang.String

ObjectName

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

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

       
Privileges Read/Write
Type

Registered

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

Deprecated.

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

RestartDelaySeconds

The number of seconds the Node Manager should wait before restarting this server.

After killing a server process, the system might need several seconds to release the TCP port(s) the server was using. If Node Manager attempts to restart the Managed Server while its ports are still active, the startup attempt fails.

If AutoMigration is enabled and RestartDelaySeconds is 0, the RestartDelaySeconds is automatically set to the lease time. This prevents the server from failing to restart after migration when the previous lease is still valid.

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typeint
Default Value0
Minimum value0
Maximum value2147483647

RestartIntervalSeconds

The number of seconds during which this server can be restarted, up to the number of times specified in RestartMax.

For more information, see:

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typeint
Default Value3600
Minimum value300
Maximum value2147483647

RestartMax

The number of times that the Node Manager can restart this server within the interval specified in RestartIntervalSeconds.

       
Available Since Release 10.3.4.0
Privileges Read/Write
Typeint
Default Value2
Minimum value0
Maximum value2147483647

Type

Returns the type of the MBean.

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

UnicastListenAddress

The IP address for the cluster unicast listener.

This attribute may be used to override the value of the referenced Coherence cluster.

For more information, see:

       
Privileges Read/Write
Typejava.lang.String

UnicastListenPort

The port for the cluster unicast listener.

For more information, see:

       
Privileges Read/Write
Typeint
Minimum value1
Maximum value65535

UnicastPortAutoAdjust

Specifies whether the unicast port will be automatically incremented if the port cannot be bound because it is already in use.

       
Privileges Read/Write
Typeboolean
Default Valuetrue


Operations

This section describes the following operations:


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

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

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