ClusterMBean

Overview

This bean represents a cluster in the domain. Servers join a cluster by calling ServerMBean.setCluster with the logical name of the cluster. A configuration may define zero or more clusters. They may be looked up by logical name.

The name of a cluster denotes its logical cluster name.

Related MBeans

This section describes attributes that provide access to other MBeans.

CandidateMachinesForMigratableServers

The set of machines (and order of preference) on which Node Manager will restart failed servers. (Requires you to enable each server for automatic migration.)

Each server can specify a subset of these cluster-wide candidates, which limits the machines on which the server can be restarted. Servers can also specify their own order of preference.

For more information, see:

• ServerMBean#getCandidateMachines

CoherenceClusterSystemResource

Coherence Cluster associated with this cluster.

CoherenceTier

Coherence Tier associated with this WLS cluster.

DatabaseLessLeasingBasis

Get attributes associated with database less leasing basis used for server migration and singleton services.

DataSourceForAutomaticMigration

The data source used by servers in the cluster during migration. (You must configure each Migratable Server within the cluster to use this data source.)

This setting applies only if the MigrationBasis attribute is set to database.

For more information, see:

• getMigrationBasis
• getAutoMigrationTableCreationDDLFile
• getAutoMigrationTableCreationPolicy
• getAutoMigrationTableName

DataSourceForJobScheduler

Data source required to support persistence of jobs scheduled with the job scheduler

DataSourceForSessionPersistence

To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.

DynamicServers

DynamicServers associated with this WLS cluster.

JTACluster

JTA associated with this WLS cluster.

MigratableTargets

Returns all the MigratableTargets for this cluster

OverloadProtection

Get attributes related to server overload protection. The default values for all cluster members are set here. Individual servers can override them as needed.

Servers

The servers which have declared membership in this cluster.

Attributes

This section describes the following attributes:

AdditionalAutoMigrationAttempts

A migratable server could fail to come up on every possible configured machine. This attribute controls how many further attempts, after the first one, should be tried.

Note that each attempt specified here indicates another full circuit of migrations amongst all the configured machines. So for a 3-server cluster, and the default value of 3, a total of 9 migrations will be attempted.

If it is set to -1, migrations will go on forever until the server starts.

AsyncSessionQueueTimeout

Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked. Should be similar to the RequestTimeOut as that will determine the longest that the queue should remain full.

AutoMigrationTableCreationDDLFile

The absolute file path of a custom DDL file for creating the automatic migration database table.

This setting applies only if the MigrationBasis attribute is set to database, the AutoMigrationTableCreationPolicy attribute is set to Always, and the table name specified by the AutoMigrationTableName attribute does not already exist in the database.

If the above conditions apply, and this setting is set to the default, then the system will try to find a default DDL file for the creating the leasing database table in WL_HOME/server/db/DB_TYPE/leasing.ddl.

Note that the system ignores (skips) any DROP commands in the DDL file, and substitutes the value configured in the AutoMigrationTableName attribute for all occurrences of the word ACTIVE in the file.

For more information, see:

• getMigrationBasis
• getAutoMigrationTableName
• getAutoMigrationTableCreationPolicy
• getDataSourceForAutomaticMigration

AutoMigrationTableCreationPolicy

Control automatic leasing table creation behavior.

This setting applies only if the MigrationBasis attribute is set to database.

• Disabled

  Disables automatic leasing table creation. The behavior is same as manual table creation. Any singletons dependent on cluster leasing will fail to start unless the table defined by the AutoMigrationTableName already exists in the database.

• Always

  Force automatic leasing table creation if the table is not found. The default table name is "ACTIVE" and can be customized using the AutoMigrationTableName attribute. The SQL used to create the table when it is not found can be customized using the AutoMigrationTableCreationDDLFile attribute.

For more information, see:

• getMigrationBasis
• getAutoMigrationTableName
• getAutoMigrationTableCreationDDLFile
• getDataSourceForAutomaticMigration

AutoMigrationTableName

Return the name of the table to be used for server migration.

This setting applies only if the MigrationBasis attribute is set to database.

If the AutoMigrationTableCreationPolicy is set to Always, then the table name format must be specified in the form [[[mycatalog.]myschema.]mytablename; for example myschema.mytablename. Each period symbol format is significant, where schema generally corresponds to username in many databases.

When no table name is specified, the table name is simply ACTIVE and the database implicitly determines the schema according to the JDBC data source user.

For more information, see:

• getMigrationBasis
• getAutoMigrationTableCreationDDLFile
• getAutoMigrationTableCreationPolicy
• getDataSourceForAutomaticMigration

CachingDisabled

Private property that disables caching in proxies.

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

ClientCertProxyEnabled

Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.

For more information, see:

• WebAppContainerMBean#isClientCertProxyEnabled()
• ServerMBean#isClientCertProxyEnabled()

ClusterAddress

The address that forms a portion of the URL a client uses to connect to this cluster, and that is used for generating EJB handles and entity EJB failover addresses. (This address may be either a DNS host name that maps to multiple IP addresses or a comma-separated list of single address host names or IP addresses.)

Defines the address to be used by clients to connect to this cluster. This address may be either a DNS host name that maps to multiple IP addresses or a comma separated list of single address host names or IP addresses. If network channels are configured, it is possible to set the cluster address on a per channel basis.

For more information, see:

• NetworkChannelMBean#getClusterAddress

ClusterBroadcastChannel

Specifies the channel used to handle communications within a cluster. If no channel is specified the default channel is used.

ClusterBroadcastChannel is only are supported if the unicast messaging type is used.

ClusterMessagingMode

Specifies the messaging type used in the cluster.

Multicast messaging is provided for backwards compatibility.

ClusterType

Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication.

To enhance the reliability of HTTP sessions, you can configure servers in one cluster to replicate the session data to servers in a different cluster. In such an environment, configure the clusters to be one of the following types:

• man

  If the clustered servers can send their data through a metro area network (man) in which latency is negligible. With this ClusterType value, servers replicate session state synchronously and in memory only. For example, when serverA in cluster1 starts an HTTP session, its backup server, serverB in cluster2, immediately replicates this session in memory to Server B.

• wan

  If the clusters are far apart or send their data through a wide area network (wan) that experiences significant network latency. With this ClusterType value, a server replicates session state synchronously to the backup server in the same cluster and asynchronously to a server in the remote cluster. For example, when serverA in cluster1 starts an HTTP session, it sends the data to serverB in cluster1 and then asynchronously sends data to serverX in cluster 2. ServerX will persist the session state in the database.

  If you persist session data in a replicating database, and if you prefer to use the database to replicate the data instead of WebLogic Server, choose a cluster type of wan and leave the remote cluster address undefined. WebLogic Server saves the session data to the local database and assumes that the database replicates data as needed.

ConcurrentSingletonActivationEnabled

Specifies whether to allow the concurrent activation, deactivation, or restart of two or more singleton services.

DatabaseLeasingBasisConnectionRetryCount

The maximum number of times Database Leasing will try to obtain a valid connection from the Data Source.

DatabaseLeasingBasisConnectionRetryDelay

The length of time, in milliseconds,Database Leasing will wait before attempting to obtain a new connection from the Data Source when a connection has failed.

DefaultLoadAlgorithm

Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service. The round-robin algorithm cycles through a list of WebLogic Server instances in order. Weight-based load balancing improves on the round-robin algorithm by taking into account a pre-assigned weight for each server. In random load balancing, requests are routed to servers at random.

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.

FencingGracePeriodMillis

During automatic migration, if the Cluster Master determines a server to be dead, it waits for this period of time (in milliseconds) before the Cluster Master migrates the service to another server in the cluster.

FrontendHost

The name of the host to which all redirected URLs will be sent.

Sets the HTTP FrontendHost for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct HOST information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

For more information, see:

• WebServerMBean#getFrontendHost

FrontendHTTPPort

The name of the HTTP port to which all redirected URLs will be sent.

Sets the FrontendHTTPPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

For more information, see:

• WebServerMBean#getFrontendHTTPPort

FrontendHTTPSPort

The name of the secure HTTP port to which all redirected URLs will be sent.

Sets the FrontendHTTPSPort for the default webserver (not virtual hosts) for all the servers in the cluster. Provides a method to ensure that the webapp will always have the correct PORT information, even when the request is coming through a firewall or a proxy. If this parameter is configured, the HOST header will be ignored and the information in this parameter will be used in its place, when constructing the absolute urls for redirects.

For more information, see:

• WebServerMBean#getFrontendHTTPSPort

GreedySessionFlushInterval

Interval in seconds until HTTP Sessions are periodically flushed to secondary server.

HealthCheckIntervalMillis

Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.

HealthCheckPeriodsUntilFencing

Maximum number of periods that a cluster member will wait before timing out a Cluster Master and also the maximum number of periods the Cluster Master will wait before timing out a Migratable Server.

HttpTraceSupportEnabled

Returns the value of HttpTraceSupportEnabled.

For more information, see:

• WebAppContainerMBean#isHttpTraceSupportEnabled
• ServerMBean#isHttpTraceSupportEnabled

Id

Return the unique id of this MBean instance

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

IdlePeriodsUntilTimeout

Maximum number of periods that a cluster member will wait before timing out a member of a cluster.

Maximum number of periods that a cluster member will wait before timing out a member of a cluster.

InterClusterCommLinkHealthCheckInterval

If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored. The duration is specified in milliseconds.

JobSchedulerTableName

The table name to use for storing timers active with the job scheduler

MBeanInfo

Returns the MBean info for this MBean.

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

Deprecated.

MemberDeathDetectorEnabled

Enables faster Automatic Service Migration times with Database Leasing Basis.

MemberWarmupTimeoutSeconds

Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. Normally, the member will be able to sync in 30 seconds. If the value of this attribute is higher, that does not necessarily mean that it will take longer for the member to warmup. Instead it defines an upper bound on the time that a server will wait to sync with the servers that it has discovered. If the value is set 0, servers will not attempt to discover other running server in the cluster during server initialization

MessageOrderingEnabled

Forces unicast messages to be processed in order. There are scenarios where JMS may update JNDI very frequently. It will result in a lot of messages over unicast. Due to the close proximity of messages the probability of out of order handling of messages increases which would trigger frequent state dumps. Frequent JNDI tree refresh may result in NameNotFoundException. Use this property to prevent out of order handling of messages.

MigrationBasis

Controls the mechanism used for server and service migration.

• Database

  -- Requires the availability of a high-availability database, such as Oracle RAC, to store leasing information. Requires also configuring the DataSourceForAutomaticMigration attribute. Optionally also configure AutoMigrationTableName (default is "ACTIVE"), AutoMigrationTableCreationPolicy, and AutoMigrationTableCreationDDLFile.

• Consensus

  -- Stores the leasing information in-memory within a cluster member. This option requires Node Manager to be configured and running.

Note: Within a WebLogic Server installation, you can only use one type of leasing. Although it is possible to implement multiple features that use leasing within your environment, each must use the same kind of leasing.

For more information, see:

• getAutoMigrationTableName
• getAutoMigrationTableCreationDDLFile
• getAutoMigrationTableCreationPolicy
• getDataSourceForAutomaticMigration

MillisToSleepBetweenAutoMigrationAttempts

Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts(). Note that this delay only happens when the server has failed to come up on every machine.

For more information, see:

• getAdditionalAutoMigrationAttempts

MulticastAddress

The multicast address used by cluster members to communicate with each other.

The valid range is from from 224.0.0.0 to 239.255.255.255. The default value used by WebLogic Server is 239.192.0.0. You should avoid using multicast addresses in the range x.0.0.1

This address should be unique to this cluster and should not be shared by other applications.

For more information, see:

• ServerMBean#getInterfaceAddress
• getMulticastPort

MulticastBufferSize

The multicast socket send/receive buffer size (at least 64 kilobytes).

Returns the multicast socket send/receive buffer size.

MulticastDataEncryption

Enables multicast data to be encrypted. Only the multicast data is encrypted. Multicast header information is not encrypted.

MulticastPort

The multicast port (between 1 and 65535) used by cluster members to communicate with each other.

Defines the multicast port used by cluster members to communicate with each other.

For more information, see:

• setMulticastPort
• getMulticastAddress

MulticastSendDelay

The amount of time (between 0 and 250 milliseconds) to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.

Defines the number of milliseconds to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.

MulticastTTL

The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel.

Defines the number of network hops that a cluster multicast message is allowed to travel. 1 restricts the cluster to one subnet.

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

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

NumberOfServersInClusterAddress

Number of servers to be listed from this cluster when generating a cluster address automatically. This setting has no effect if Cluster Address is explicitly set.

For more information, see:

• getClusterAddress

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.

OneWayRmiForReplicationEnabled

Indicates if one-way RMI is being used for replication. One-way RMI also requires configuring replication ports on each server in the cluster.

For more information, see:

• ServerMBean#getReplicationPorts()

Parent

Return the immediate parent for this MBean

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

PersistSessionsOnShutdown

When shutting down servers, sessions are not updated. If the primary and secondary servers of a session are shut down with no session updates, the session will be lost. Turning on PersistSessionsOnShutdown will save any active sessions to the database specified in ClusterMBean#getDataSourceForSessionPersistence() when a server is shutdown. The sessions will not be written at any other time. (For example, they are not saved via this mechanism if there is a server crash.)

This attribute is applicable both to session persistence on server shutdown or session persistence across a WAN.

Rolling upgrade can potentially have a bad interaction with traditional in-memory session replication. As managed servers are shutdown and upgraded, in-memory servlet sessions will be lost if both primary and secondary are rebooted before a new request arrives for the session.

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.

RemoteClusterAddress

Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.

ReplicationChannel

The channel name to be used for replication traffic. Cluster infrastructure uses this channel to send updates for HTTP sessions and stateful session beans. If none is set then the default channel will be used.

In order for this feature to work, the named channel must exist on all members of the cluster and must be configured to use the same protocol. It is valid for the selected channel to be configured to use a secure protocol.

For more information, see:

• getRemoteClusterAddress

ReplicationTimeoutEnabled

Indicates if timeout should be applied to session replication calls.

SecureReplicationEnabled

Servers in a cluster replicate session data. If a replication channel is defined then the session data will be sent using the replication channel protocol and secured replication settings will be ignored. If no replication channel is defined and secured replication is enabled then session data for in-memory replication will be sent over SSL using the default secured channel. However, this added security for replication traffic comes with a significant cluster performance degradation. It should only be enabled if security is of greater concern than performance degradation.

ServiceActivationRequestResponseTimeout

The maximum time, in milliseconds seconds, for services to wait for response from cluster members.

ServiceAgeThresholdSeconds

The number of seconds (between 0 and 65534) by which the age of two conflicting services must differ before one is considered older than the other.

Defines the number of seconds by which the age of two conflicting services must differ before one is considered older than the other.

SessionFlushInterval

Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.

SessionFlushThreshold

When number of sessions to be flushed reaches this threshold limit, sessions will be flushed to the backup cluster before the flush interval. This helps the server to flush sessions faster under load.

SessionLazyDeserializationEnabled

Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic.

SessionStateQueryProtocolEnabled

Indicates if session state query protocol is enabled. The Session State Query protocol will query the local cluster for the location of a session state instance if a request arrives at a server that is neither the primary or secondary server.

SessionStateQueryRequestTimeout

The maximum time, in seconds, for session state query request to wait for response from cluster members.

SingletonServiceRequestTimeout

The maximum time, in milliseconds, for service activation requests will wait for response from cluster members.

A value of 0 means that the request will wait indefinitely to complete.

SiteName

The name of the site this cluster is associated with.

Tags

Return all tags on this Configuration MBean

This attribute is dynamic and takes effect immediately.

TxnAffinityEnabled

If enabled, a server's transaction requests go to servers in the cluster that are already participating in the global transaction.

Type

Returns the type of the MBean.

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

UnicastReadTimeout

The specified read timeout, in milliseconds, on a unicast connection. A timeout of zero is interpreted as an infinite timeout, that is blocking read forever.

WANSessionPersistenceTableName

Return the name of the table to be used for WAN session persistence.

WeblogicPluginEnabled

Specifies if this cluster will receive requests from a proxy plug-in or HttpClusterServlet.

Set this attribute to true if the cluster will receive requests from a proxy plug-in or HttpClusterServlet. A call to getRemoteAddr will return the address of the browser client from the proprietary WL-Proxy-Client-IP header instead of the Web server.

Set this attribute to false to disable the weblogic-plugin-enabled parameter, weblogic-plugin-enabled=false, in the config.xmlfile.

Note: If you are using Oracle HTTP Server, the WebLogic Proxy Plug-In, or Oracle Traffic Director to distribute client requests to a Managed Server or a cluster, Oracle recommends setting this attribute to true.

For more information, see:

• WebAppContainerMBean#isWeblogicPluginEnabled()
• ServerMBean#isWeblogicPluginEnabled()

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.

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

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.

isInherited

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

isSet

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

removeTag

Remove a tag from this Configuration MBean

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

unSet

Restore the given property to its default value.