weblogic.management.configuration
Interface ClusterMBean

All Superinterfaces:

ConfigurationMBean, TargetMBean

public interface ClusterMBean
extends TargetMBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.

getServers

ServerMBean[] getServers()

The servers which have declared membership in this cluster.

Returns:

The servers value

getClusterAddress

String getClusterAddress()

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.

Returns:

The clusterAddress value

See Also:

NetworkChannelMBean.getClusterAddress()

setClusterAddress

void setClusterAddress(String address)
                       throws InvalidAttributeValueException

Sets the cluster's address.

Parameters:

address - The new clusterAddress value

Throws:

InvalidAttributeValueException

IllegalArgumentException - if the address is not either a well-formed IP address or hostname.

See Also:

ClusterMBean.getMulticastAddress()

getMulticastAddress

String getMulticastAddress()

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.

Returns:

The multicastAddress value

See Also:

ServerMBean.getInterfaceAddress(), ClusterMBean.getMulticastPort()

Default Value:

"239.192.0.0"

setMulticastAddress

void setMulticastAddress(String address)
                         throws InvalidAttributeValueException

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

Parameters:

address - The new multicastAddress value

Throws:

InvalidAttributeValueException

IllegalArgumentException - if the argument is not a well-formed IP address.

See Also:

ServerMBean.getInterfaceAddress(), ClusterMBean.setMulticastPort(int)

setMulticastBufferSize

void setMulticastBufferSize(int bufSize)

Defines the multicast socket send/receive buffer size.

Parameters:

bufSize - The new multicastBufferSize value

Minimum Value:

64

getMulticastBufferSize

int getMulticastBufferSize()

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

Returns the multicast socket send/receive buffer size.

Returns:

The multicastBufferSize value

Default Value:

64

getMulticastPort

int getMulticastPort()

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.

Returns:

The multicastPort value

Since:

7.0.0.0

See Also:

ClusterMBean.setMulticastPort(int), ClusterMBean.getMulticastAddress()

Default Value:

7001

Maximum Value:

65535

Minimum Value:

1

setMulticastPort

void setMulticastPort(int port)
                      throws InvalidAttributeValueException

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

Parameters:

port - The new multicastPort value

Throws:

InvalidAttributeValueException

See Also:

ClusterMBean.getMulticastPort(), ClusterMBean.setMulticastAddress(java.lang.String)

Maximum Value:

65535

Minimum Value:

1

getMulticastTTL

int getMulticastTTL()

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.

Returns:

The multicastTTL value

Default Value:

1

Maximum Value:

255

Minimum Value:

1

setMulticastTTL

void setMulticastTTL(int ttl)
                     throws InvalidAttributeValueException

Sets the time-to-live value for the cluster's multicast address.

Parameters:

ttl - The new multicastTTL value

Throws:

InvalidAttributeValueException

Maximum Value:

255

Minimum Value:

0

getMulticastSendDelay

int getMulticastSendDelay()

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.

Returns:

The multicastSendDelay value

Default Value:

3

Maximum Value:

250

Minimum Value:

0

setMulticastSendDelay

void setMulticastSendDelay(int delay)
                           throws InvalidAttributeValueException

Sets the number of milliseconds to delay sending message fragments over multicast.

Parameters:

delay - The new multicastSendDelay value

Throws:

InvalidAttributeValueException

Maximum Value:

100

Minimum Value:

0

getDefaultLoadAlgorithm

String getDefaultLoadAlgorithm()

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.

Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service.

Returns:

The defaultLoadAlgorithm value

Default Value:

"round-robin"

Valid Values:

"round-robin","weight-based","random","round-robin-affinity","weight-based-affinity","random-affinity"

setDefaultLoadAlgorithm

void setDefaultLoadAlgorithm(String value)
                             throws InvalidAttributeValueException

Sets the default load balancing algorithm.

Parameters:

value - The new defaultLoadAlgorithm value

Throws:

InvalidAttributeValueException

IllegalArgumentException - if the value is not a valid algorithm.

getClusterMessagingMode

String getClusterMessagingMode()

Specifies the messaging type used in the cluster.

Multicast messaging, the default, is provided for backwards compatibility.

Unicast message is recommended for new clusters.

Returns:

The cluster messaging mode value

Default Value:

"multicast"

Valid Values:

"multicast","unicast"

setClusterMessagingMode

void setClusterMessagingMode(String value)
                             throws InvalidAttributeValueException

Throws:

InvalidAttributeValueException

Default Value:

"multicast"

Valid Values:

"multicast","unicast"

getClusterBroadcastChannel

String getClusterBroadcastChannel()

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.

Returns:

The cluster messaging mode value

setClusterBroadcastChannel

void setClusterBroadcastChannel(String value)
                                throws InvalidAttributeValueException

Throws:

InvalidAttributeValueException

getServiceAgeThresholdSeconds

int getServiceAgeThresholdSeconds()

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.

Returns:

The serviceAgeThresholdSeconds value

Default Value:

180

setServiceAgeThresholdSeconds

void setServiceAgeThresholdSeconds(int seconds)
                                   throws InvalidAttributeValueException,
                                          DistributedManagementException

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

Parameters:

seconds - The new serviceAgeThresholdSeconds value

Throws:

InvalidAttributeValueException

DistributedManagementException

Maximum Value:

65534

Minimum Value:

0

setClientCertProxyEnabled

void setClientCertProxyEnabled(boolean ccp)

A value of true causes proxy-server plugins to pass identity certificates from clients to all web applications that are deployed on all server instances in the cluster.

A proxy-server plugin encodes each identify certification in the WL-Proxy-Client-Cert header and passes the header to WebLogic Server instances. Each WebLogic Server instance takes the certificate information from the header, trusting that it came from a secure source, and uses that information to authenticate the user.

If you specify true, use a ConnectionFilter to ensure that each WebLogic Server instance accepts connections only from the machine on which the proxy-server plugin is running. Specifying true without using a connection filter creates a potential security vulnerability because the WL-Proxy-Client-Cert header can be spoofed.

A value of true overrides the value that each server instance within the cluster specifies with ServerMBean.setClientCertProxyEnabled(boolean).

By default (or if you specify false):

• Each server instance can determine whether its applications trust certificates sent from the proxy server plugin.

• If a server instance does not set a value for its ClientCertProxyEnabled attribute (or if it specifies false), the weblogic.xml deployment descriptor for each web application determines whether the web application trusts certificates sent from the proxy server plugin.

• By default (or if the deployment descriptor specifies false), users cannot log in to the web application from a proxy server plugin.

Parameters:

ccp - The new clientCertProxyEnabled value

See Also:

WebAppContainerMBean.setClientCertProxyEnabled(boolean), ServerMBean.setClientCertProxyEnabled(boolean)

Default Value:

false

isClientCertProxyEnabled

boolean isClientCertProxyEnabled()

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

Returns:

The clientCertProxyEnabled value

See Also:

WebAppContainerMBean.isClientCertProxyEnabled(), ServerMBean.isClientCertProxyEnabled()

setWeblogicPluginEnabled

void setWeblogicPluginEnabled(boolean wpe)

WLS HttpRequest.getRemoteAddr() used to rely on X-Forwarded-For for its returned value. This is a security hole due to HTTP header can be easily mocked and we end up with returning wrong value. This is improved by introducing a proprietary header WL-Proxy-Client-IP from our plugins and this header will only be used if WLS is configured to use our plugins. This is duplicated both in ClusterMBean and ServerMBean so the attribute WeblogicPluginEnabled can be used cluster-wide. ClusterMBean overrides ServerMBean

Parameters:

wpe - The new weblogicPluginEnabled value

See Also:

WebAppContainerMBean.setWeblogicPluginEnabled(boolean), ServerMBean.setWeblogicPluginEnabled(boolean)

Default Value:

false

isWeblogicPluginEnabled

boolean isWeblogicPluginEnabled()

Specifies whether the proprietary WL-Proxy-Client-IP header should be used. (This needed only when WebLogic plugins are configured.)

Gets the weblogicPluginEnabled attribute of the ClusterMBean object

Returns:

The weblogicPluginEnabled value

See Also:

WebAppContainerMBean.isWeblogicPluginEnabled(), ServerMBean.isWeblogicPluginEnabled()

getMigratableTargets

MigratableTargetMBean[] getMigratableTargets()

Returns all the MigratableTargets for this cluster

Returns:

The migratableTargets value

getMemberWarmupTimeoutSeconds

int getMemberWarmupTimeoutSeconds()

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

Returns:

The memberWarmupTimeoutSeconds value

Default Value:

30

setMemberWarmupTimeoutSeconds

void setMemberWarmupTimeoutSeconds(int seconds)

Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster.

Parameters:

seconds - The new memberWarmupTimeoutSeconds value

See Also:

ClusterMBean.getMemberWarmupTimeoutSeconds()

Minimum Value:

0

setHttpTraceSupportEnabled

void setHttpTraceSupportEnabled(boolean tse)

Attackers may abuse HTTP TRACE functionality to gain access to information in HTTP headers such as cookies and authentication data. In the presence of other cross-domain vulnerabilities in web browsers, sensitive header information could be read from any domains that support the HTTP TRACE method. This attribute is for disabling HTTP TRACE support. It is duplicated both in ClusterMBean and ServerMBean so the attribute HttpTraceSupportEnabled can be used cluster-wide. ClusterMBean overrides ServerMBean

See Also:

WebAppContainerMBean.setHttpTraceSupportEnabled(boolean), ServerMBean.setHttpTraceSupportEnabled(boolean)

Default Value:

false

isHttpTraceSupportEnabled

boolean isHttpTraceSupportEnabled()

Returns the value of HttpTraceSupportEnabled.

Returns:

HttpTraceSupportEnabled value

See Also:

WebAppContainerMBean.isHttpTraceSupportEnabled(), ServerMBean.isHttpTraceSupportEnabled()

getFrontendHost

String getFrontendHost()

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.

Returns:

The FrontendHost value

See Also:

WebServerMBean.getFrontendHost()

Default Value:

null

setFrontendHost

void setFrontendHost(String hostName)
                     throws InvalidAttributeValueException

Sets the FrontendHost attribute of the WebServerMBean object

Parameters:

hostName - The new FrontendHost value

Throws:

InvalidAttributeValueException

getFrontendHTTPPort

int getFrontendHTTPPort()

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.

Returns:

The FrontendHTTPPort value

See Also:

WebServerMBean.getFrontendHTTPPort()

Default Value:

0

setFrontendHTTPPort

void setFrontendHTTPPort(int httpPort)
                         throws InvalidAttributeValueException

Sets the FrontendHTTPPort attribute.

Parameters:

httpPort - The new FrontendHTTPPort value

Throws:

InvalidAttributeValueException

See Also:

ClusterMBean.getFrontendHTTPPort()

getFrontendHTTPSPort

int getFrontendHTTPSPort()

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.

Returns:

The FrontendHTTPSPort value

See Also:

WebServerMBean.getFrontendHTTPSPort()

Default Value:

0

setFrontendHTTPSPort

void setFrontendHTTPSPort(int httpsPort)
                          throws InvalidAttributeValueException

Sets the FrontendHTTPSPort attribute.

Parameters:

httpsPort - The new FrontendHTTPSPort value

Throws:

InvalidAttributeValueException

See Also:

ClusterMBean.getFrontendHTTPSPort()

getIdlePeriodsUntilTimeout

int getIdlePeriodsUntilTimeout()

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.

Returns:

The idlePeriodsUntilTimeout

Default Value:

3

setIdlePeriodsUntilTimeout

void setIdlePeriodsUntilTimeout(int timeout)

Sets the IdlePeriodsUntilTimeout attribute.

See Also:

ClusterMBean.getIdlePeriodsUntilTimeout()

Minimum Value:

3

setRemoteClusterAddress

void setRemoteClusterAddress(String clusterAddress)

Sets the RemoteClusterAddress attribute.

Parameters:

clusterAddress - Set the foreign cluster address for WAN/MAN HTTP session failover.

See Also:

ClusterMBean.getRemoteClusterAddress()

getRemoteClusterAddress

String getRemoteClusterAddress()

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

Returns:

Foreign cluster Address.

setWANSessionPersistenceTableName

void setWANSessionPersistenceTableName(String name)

getWANSessionPersistenceTableName

String getWANSessionPersistenceTableName()

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

Returns:

Default Value:

"WLS_WAN_PERSISTENCE_TABLE"

getReplicationChannel

String getReplicationChannel()

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.

Returns:

Channel name to be used for replication.

See Also:

ClusterMBean.getRemoteClusterAddress()

Default Value:

"ReplicationChannel"

setReplicationChannel

void setReplicationChannel(String replicationChannel)

Parameters:

replicationChannel - channel name for session replication.

See Also:

ClusterMBean.getReplicationChannel()

getInterClusterCommLinkHealthCheckInterval

int getInterClusterCommLinkHealthCheckInterval()

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

Returns:

Inter cluster communication link health check interval

Default Value:

30000

setInterClusterCommLinkHealthCheckInterval

void setInterClusterCommLinkHealthCheckInterval(int interval)

Sets the InterClusterCommLinkHealthCheckInterval attribute.

Parameters:

interval -

See Also:

ClusterMBean.getInterClusterCommLinkHealthCheckInterval()

setDataSourceForSessionPersistence

void setDataSourceForSessionPersistence(JDBCSystemResourceMBean mbean)

Sets the DataSourceForSessionPersistence attribute.

Parameters:

mbean -

See Also:

ClusterMBean.getDataSourceForSessionPersistence()

getDataSourceForSessionPersistence

JDBCSystemResourceMBean getDataSourceForSessionPersistence()

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

Returns:

DataSource for session persistence.

setDataSourceForJobScheduler

void setDataSourceForJobScheduler(JDBCSystemResourceMBean mbean)

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

getDataSourceForJobScheduler

JDBCSystemResourceMBean getDataSourceForJobScheduler()

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

Returns:

DataSource for job scheduler.

getJobSchedulerTableName

String getJobSchedulerTableName()

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

Returns:

The database table name to use for persisting job scheduler timers

Default Value:

"weblogic_timers"

setJobSchedulerTableName

void setJobSchedulerTableName(String tableName)

The data source that servers in the cluster use to persist cluster wide timers.

See Also:

ClusterMBean.getJobSchedulerTableName()

Default Value:

"weblogic_timers"

getPersistSessionsOnShutdown

boolean getPersistSessionsOnShutdown()

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

Returns:

whether or not session persistence on shutdown is enabled

setPersistSessionsOnShutdown

void setPersistSessionsOnShutdown(boolean persist)

Sets the PersistSessionsOnShutdown attribute.

Parameters:

persist - whether or not to persist sessions on shutdown

See Also:

ClusterMBean.getPersistSessionsOnShutdown()

setAsyncSessionQueueTimeout

void setAsyncSessionQueueTimeout(int asyncSessionQueueTimeout)

When the request producer wants to add a session to the AsyncReplication queue, the queue will block the addition if it is full. The procuder will wait for the specified time, before marking the session as dirty.

Parameters:

asyncSessionQueueTimeout - in seconds

See Also:

ClusterMBean.getAsyncSessionQueueTimeout()

Changes take effect after you redeploy the module or restart the server.

getAsyncSessionQueueTimeout

int getAsyncSessionQueueTimeout()

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.

Returns:

async-session-queue-timeout in seconds

Default Value:

30

getGreedySessionFlushInterval

int getGreedySessionFlushInterval()

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

Returns:

greedy-session-flush-interval in seconds

Default Value:

10

setSessionFlushInterval

void setSessionFlushInterval(int sessionFlushInterval)

Sets the SessionFlushInterval attribute.

Parameters:

sessionFlushInterval - in seconds

See Also:

ClusterMBean.getSessionFlushInterval()

Changes take effect after you redeploy the module or restart the server.

getSessionFlushInterval

int getSessionFlushInterval()

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

Returns:

session-flush-interval in seconds.

Default Value:

180

setSessionFlushThreshold

void setSessionFlushThreshold(int sessionFlushThreshold)

Sets the SessionFlushThreshold attribute.

Parameters:

sessionFlushThreshold -

See Also:

ClusterMBean.getSessionFlushThreshold()

Changes take effect after you redeploy the module or restart the server.

getSessionFlushThreshold

int getSessionFlushThreshold()

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.

Returns:

session-flush-threshold

Default Value:

100

getCandidateMachinesForMigratableServers

MachineMBean[] getCandidateMachinesForMigratableServers()

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.

See Also:

ServerMBean#getCandidateMachinesForMigratableServers

setCandidateMachinesForMigratableServers

void setCandidateMachinesForMigratableServers(MachineMBean[] machines)

set getCandidateMachinesForMigratableServers

getDataSourceForAutomaticMigration

JDBCSystemResourceMBean getDataSourceForAutomaticMigration()

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

Returns:

JDBC connection pool to be used by the HABasis module.

setDataSourceForAutomaticMigration

void setDataSourceForAutomaticMigration(JDBCSystemResourceMBean dataSource)

Sets the DataSourceForAutomaticMigration attribute.

See Also:

ClusterMBean.getDataSourceForAutomaticMigration()

getHealthCheckIntervalMillis

int getHealthCheckIntervalMillis()

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

Returns:

health-check-interval in milli seconds.

Default Value:

10000

setHealthCheckIntervalMillis

void setHealthCheckIntervalMillis(int healthCheckInterval)

Sets the value of the HealthCheckIntervalMillis attribute.

Parameters:

healthCheckInterval - in milli seconds.

See Also:

ClusterMBean.getHealthCheckIntervalMillis()

getHealthCheckPeriodsUntilFencing

int getHealthCheckPeriodsUntilFencing()

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.

Returns:

fencing-period

Default Value:

3

Minimum Value:

2

setHealthCheckPeriodsUntilFencing

void setHealthCheckPeriodsUntilFencing(int healthCheckPeriodsUntilTimeout)

Sets the value of the HealthCheckPeriodsUntilFencing attribute.

Parameters:

healthCheckPeriodsUntilTimeout: - health check periods until time out.

See Also:

ClusterMBean.getHealthCheckPeriodsUntilFencing()

getFencingGracePeriodMillis

int getFencingGracePeriodMillis()

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.

Returns:

fencing-grace-period in milli seconds.

Default Value:

30000

setFencingGracePeriodMillis

void setFencingGracePeriodMillis(int gracePeriod)

Sets the value of the FencingGracePeriodMillis attribute.

See Also:

ClusterMBean.getFencingGracePeriodMillis()

getNumberOfServersInClusterAddress

int getNumberOfServersInClusterAddress()

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.

Returns:

number of server to be listed in this cluster

See Also:

ClusterMBean.getClusterAddress()

Default Value:

3

Minimum Value:

1

setNumberOfServersInClusterAddress

void setNumberOfServersInClusterAddress(int numberOfServersInClusterAddress)

Sets the NumberOfServersInClusterAddress attribute

See Also:

getNumberOfServersInClusterAddress

setClusterType

void setClusterType(String type)

Sets the value of the ClusterType attribute.

Default Value:

"none"

Valid Values:

"none","wan", "man"

getClusterType

String getClusterType()

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.

Default Value:

"none"

Valid Values:

"none","wan", "man"

setMulticastDataEncryption

void setMulticastDataEncryption(boolean value)

getMulticastDataEncryption

boolean getMulticastDataEncryption()

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

Returns:

true if encryption is enabled, false otherwise

Default Value:

false

setAutoMigrationTableName

void setAutoMigrationTableName(String name)

getAutoMigrationTableName

String getAutoMigrationTableName()

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

Returns:

Default Value:

"ACTIVE"

getAdditionalAutoMigrationAttempts

int getAdditionalAutoMigrationAttempts()

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.

Default Value:

3

setAdditionalAutoMigrationAttempts

void setAdditionalAutoMigrationAttempts(int tries)

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

Parameters:

tries - number of additional times to loop through all the machines

See Also:

ClusterMBean.getAdditionalAutoMigrationAttempts()

getMillisToSleepBetweenAutoMigrationAttempts

long getMillisToSleepBetweenAutoMigrationAttempts()

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.

See Also:

ClusterMBean.getAdditionalAutoMigrationAttempts()

Default Value:

180000

setMillisToSleepBetweenAutoMigrationAttempts

void setMillisToSleepBetweenAutoMigrationAttempts(long millis)

Sets the getMillisToSleepBetweenAutoMigrationAttempts value

Parameters:

millis - number of milliseconds to wait

See Also:

ClusterMBean.getMillisToSleepBetweenAutoMigrationAttempts()

setReplicationTimeoutEnabled

void setReplicationTimeoutEnabled(boolean replicationTimeout)

Enable or disable replication timeout.

Default Value:

true

getMigrationBasis

String getMigrationBasis()

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

Default Value:

"database"

Valid Values:

"database", "consensus"

setMigrationBasis

void setMigrationBasis(String type)

Parameters:

type - of basis used for migration

isReplicationTimeoutEnabled

boolean isReplicationTimeoutEnabled()

Indicates if timeout should be applied to session replication calls.

Default Value:

true

getOverloadProtection

OverloadProtectionMBean getOverloadProtection()

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

getDatabaseLessLeasingBasis

DatabaseLessLeasingBasisMBean getDatabaseLessLeasingBasis()

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

isSecureReplicationEnabled

boolean isSecureReplicationEnabled()

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.

Returns:

true if secure replication is enabled, false otherwise

Since:

7.0.8.0

Default Value:

false

setSecureReplicationEnabled

void setSecureReplicationEnabled(boolean value)

Since:

7.0.8.0

setMessageOrderingEnabled

void setMessageOrderingEnabled(boolean value)

Since:

10.3.3.0

setOneWayRmiForReplicationEnabled

void setOneWayRmiForReplicationEnabled(boolean enable)

Enables one-way RMI for replication.

Since:

10.3.4.0

isOneWayRmiForReplicationEnabled

boolean isOneWayRmiForReplicationEnabled()

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

Since:

10.3.4.0

See Also:

ServerMBean.getReplicationPorts()

Default Value:

false

isSessionLazyDeserializationEnabled

boolean isSessionLazyDeserializationEnabled()

Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic. For more information, see “Enabling Exalogic-Specific Enhancements in Oracle WebLogic Server 11g Release 1 (10.3.4)” in the Oracle Exalogic Deployment Guide.

Since:

10.3.4.0