|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ClusterMBean
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.
Field Summary |
---|
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
---|---|
int |
getAdditionalAutoMigrationAttempts()
A migratable server could fail to come up on every possible configured machine. |
int |
getAsyncSessionQueueTimeout()
Interval in seconds until the producer thread will wait for the AsyncSessionQueue to become unblocked. |
String |
getAutoMigrationTableName()
Return the name of the table to be used for server migration. |
MachineMBean[] |
getCandidateMachinesForMigratableServers()
The set of machines (and order of preference) on which Node Manager will restart failed servers. |
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. |
String |
getClusterBroadcastChannel()
Specifies the channel used to handle communications within a cluster. |
String |
getClusterMessagingMode()
Specifies the messaging type used in the cluster. |
String |
getClusterType()
Optimizes cross-cluster replication for the type of network that servers in the clusters use for administrative communication. |
CoherenceClusterSystemResourceMBean |
getCoherenceClusterSystemResource()
Coherence Cluster associated with this cluster. |
CoherenceTierMBean |
getCoherenceTier()
Coherence Tier associated with this WLS cluster. |
DatabaseLessLeasingBasisMBean |
getDatabaseLessLeasingBasis()
Get attributes associated with database less leasing basis used for server migration and singleton services. |
JDBCSystemResourceMBean |
getDataSourceForAutomaticMigration()
The data source used by servers in the cluster during migration. |
JDBCSystemResourceMBean |
getDataSourceForJobScheduler()
Data source required to support persistence of jobs scheduled with the job scheduler |
JDBCSystemResourceMBean |
getDataSourceForSessionPersistence()
To support HTTP Session failover across data centers, a datasource is required to dump session state on disk. |
String |
getDefaultLoadAlgorithm()
Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service. |
DynamicServersMBean |
getDynamicServers()
DynamicServers associated with this WLS cluster. |
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. |
String |
getFrontendHost()
The name of the host to which all redirected URLs will be sent. |
int |
getFrontendHTTPPort()
The name of the HTTP port to which all redirected URLs will be sent. |
int |
getFrontendHTTPSPort()
The name of the secure HTTP port to which all redirected URLs will be sent. |
int |
getGreedySessionFlushInterval()
Interval in seconds until HTTP Sessions are periodically flushed to secondary server. |
int |
getHealthCheckIntervalMillis()
Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database. |
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. |
int |
getIdlePeriodsUntilTimeout()
Maximum number of periods that a cluster member will wait before timing out a member of a cluster. |
int |
getInterClusterCommLinkHealthCheckInterval()
If the cluster link between two clusters goes down, a trigger will run periodically to see if the link is restored. |
String |
getJobSchedulerTableName()
The table name to use for storing timers active with the job scheduler |
JTAClusterMBean |
getJTACluster()
JTA associated with this WLS cluster. |
int |
getMemberWarmupTimeoutSeconds()
Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. |
MigratableTargetMBean[] |
getMigratableTargets()
Returns all the MigratableTargets for this cluster |
String |
getMigrationBasis()
Controls the mechanism used for server and service migration. |
long |
getMillisToSleepBetweenAutoMigrationAttempts()
Controls how long of a pause there should be between the migration attempts described in getAdditionalAutoMigrationAttempts(). |
String |
getMulticastAddress()
The multicast address used by cluster members to communicate with each other. |
int |
getMulticastBufferSize()
The multicast socket send/receive buffer size (at least 64 kilobytes). |
boolean |
getMulticastDataEncryption()
Enables multicast data to be encrypted. |
int |
getMulticastPort()
The multicast port (between 1 and 65535) used by cluster members to communicate with each other. |
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. |
int |
getMulticastTTL()
The number of network hops (between 1 and 255) that a cluster multicast message is allowed to travel. |
int |
getNumberOfServersInClusterAddress()
Number of servers to be listed from this cluster when generating a cluster address automatically. |
OverloadProtectionMBean |
getOverloadProtection()
Get attributes related to server overload protection. |
boolean |
getPersistSessionsOnShutdown()
When shutting down servers, sessions are not updated. |
String |
getRemoteClusterAddress()
Set the foreign cluster. |
String |
getReplicationChannel()
The channel name to be used for replication traffic. |
ServerMBean[] |
getServers()
The servers which have declared membership in this cluster. |
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. |
int |
getSessionFlushInterval()
Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk. |
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. |
String |
getWANSessionPersistenceTableName()
Return the name of the table to be used for WAN session persistence. |
boolean |
isClientCertProxyEnabled()
Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not. |
boolean |
isHttpTraceSupportEnabled()
Returns the value of HttpTraceSupportEnabled. |
boolean |
isMemberDeathDetectorEnabled()
Enables faster Automatic Service Migration times with Database Leasing Basis. |
boolean |
isOneWayRmiForReplicationEnabled()
Indicates if one-way RMI is being used for replication. |
boolean |
isReplicationTimeoutEnabled()
Indicates if timeout should be applied to session replication calls. |
boolean |
isSecureReplicationEnabled()
Servers in a cluster replicate session data. |
boolean |
isSessionLazyDeserializationEnabled()
Enables increased efficiency with session replication. |
boolean |
isWeblogicPluginEnabled()
Specifies whether the proprietary WL-Proxy-Client-IP header should be used. |
void |
setAdditionalAutoMigrationAttempts(int tries)
Sets the AdditionalAutoMigrationAttempts value If it is set to -1, migrations will go on forever until the server starts. |
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. |
void |
setAutoMigrationTableName(String name)
|
void |
setCandidateMachinesForMigratableServers(MachineMBean[] machines)
set getCandidateMachinesForMigratableServers |
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. |
void |
setClusterAddress(String address)
Sets the cluster's address. |
void |
setClusterBroadcastChannel(String value)
Configure the cluster messaging mode value |
void |
setClusterMessagingMode(String value)
|
void |
setClusterType(String type)
Sets the value of the ClusterType attribute. |
void |
setCoherenceClusterSystemResource(CoherenceClusterSystemResourceMBean coherenceClusterSystemResource)
Associates the WLS cluster to a Coherence Cluster |
void |
setDataSourceForAutomaticMigration(JDBCSystemResourceMBean dataSource)
Sets the DataSourceForAutomaticMigration attribute. |
void |
setDataSourceForJobScheduler(JDBCSystemResourceMBean mbean)
Data source required to support persistence of jobs scheduled with the job scheduler |
void |
setDataSourceForSessionPersistence(JDBCSystemResourceMBean mbean)
Sets the DataSourceForSessionPersistence attribute. |
void |
setDefaultLoadAlgorithm(String value)
Sets the default load balancing algorithm. |
void |
setFencingGracePeriodMillis(int gracePeriod)
Sets the value of the FencingGracePeriodMillis attribute. |
void |
setFrontendHost(String hostName)
Sets the FrontendHost attribute of the WebServerMBean object |
void |
setFrontendHTTPPort(int httpPort)
Sets the FrontendHTTPPort attribute. |
void |
setFrontendHTTPSPort(int httpsPort)
Sets the FrontendHTTPSPort attribute. |
void |
setHealthCheckIntervalMillis(int healthCheckInterval)
Sets the value of the HealthCheckIntervalMillis attribute. |
void |
setHealthCheckPeriodsUntilFencing(int healthCheckPeriodsUntilTimeout)
Sets the value of the HealthCheckPeriodsUntilFencing attribute. |
void |
setHttpTraceSupportEnabled(boolean tse)
Attackers may abuse HTTP TRACE functionality to gain access to information in HTTP headers such as cookies and authentication data. |
void |
setIdlePeriodsUntilTimeout(int timeout)
Sets the IdlePeriodsUntilTimeout attribute. |
void |
setInterClusterCommLinkHealthCheckInterval(int interval)
Sets the InterClusterCommLinkHealthCheckInterval attribute. |
void |
setJobSchedulerTableName(String tableName)
The data source that servers in the cluster use to persist cluster wide timers. |
void |
setMemberWarmupTimeoutSeconds(int seconds)
Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster. |
void |
setMessageOrderingEnabled(boolean value)
|
void |
setMigrationBasis(String type)
|
void |
setMillisToSleepBetweenAutoMigrationAttempts(long millis)
Sets the getMillisToSleepBetweenAutoMigrationAttempts value |
void |
setMulticastAddress(String address)
Sets the multicast address used by cluster members to communicate with each other. |
void |
setMulticastBufferSize(int bufSize)
Defines the multicast socket send/receive buffer size. |
void |
setMulticastDataEncryption(boolean value)
|
void |
setMulticastPort(int port)
The multicast port used by cluster members to communicate with each other. |
void |
setMulticastSendDelay(int delay)
Sets the number of milliseconds to delay sending message fragments over multicast. |
void |
setMulticastTTL(int ttl)
Sets the time-to-live value for the cluster's multicast address. |
void |
setNumberOfServersInClusterAddress(int numberOfServersInClusterAddress)
Sets the NumberOfServersInClusterAddress attribute |
void |
setOneWayRmiForReplicationEnabled(boolean enable)
Enables one-way RMI for replication. |
void |
setPersistSessionsOnShutdown(boolean persist)
Sets the PersistSessionsOnShutdown attribute. |
void |
setRemoteClusterAddress(String clusterAddress)
Sets the RemoteClusterAddress attribute. |
void |
setReplicationChannel(String replicationChannel)
|
void |
setReplicationTimeoutEnabled(boolean replicationTimeout)
Enable or disable replication timeout. |
void |
setSecureReplicationEnabled(boolean value)
|
void |
setServiceAgeThresholdSeconds(int seconds)
Defines the number of seconds by which the age of two conflicting services must differ before one is considered older than the other. |
void |
setSessionFlushInterval(int sessionFlushInterval)
Sets the SessionFlushInterval attribute. |
void |
setSessionFlushThreshold(int sessionFlushThreshold)
Sets the SessionFlushThreshold attribute. |
void |
setWANSessionPersistenceTableName(String name)
|
void |
setWeblogicPluginEnabled(boolean wpe)
WLS HttpRequest.getRemoteAddr() used to rely on X-Forwarded-For for its returned value. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
---|
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, 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 |
---|
ServerMBean[] getServers()
The servers which have declared membership in this cluster.
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.
NetworkChannelMBean.getClusterAddress()
void setClusterAddress(String address) throws InvalidAttributeValueException
Sets the cluster's address.
address
- The new clusterAddress value
InvalidAttributeValueException
IllegalArgumentException
- if the address is not either a well-formed IP address or hostname.ClusterMBean.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.
ServerTemplateMBean.getInterfaceAddress()
,
ClusterMBean.getMulticastPort()
void setMulticastAddress(String address) throws InvalidAttributeValueException
Sets the multicast address used by cluster members to communicate with each other.
address
- The new multicastAddress value
InvalidAttributeValueException
IllegalArgumentException
- if the argument is not a well-formed IP address.ServerTemplateMBean.getInterfaceAddress()
,
ClusterMBean.setMulticastPort(int)
void setMulticastBufferSize(int bufSize)
Defines the multicast socket send/receive buffer size.
bufSize
- The new multicastBufferSize valueint getMulticastBufferSize()
The multicast socket send/receive buffer size (at least 64 kilobytes).
Returns the multicast socket send/receive buffer size.
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.
ClusterMBean.setMulticastPort(int)
,
ClusterMBean.getMulticastAddress()
void setMulticastPort(int port) throws InvalidAttributeValueException
The multicast port used by cluster members to communicate with each other.
port
- The new multicastPort value
InvalidAttributeValueException
ClusterMBean.getMulticastPort()
,
ClusterMBean.setMulticastAddress(java.lang.String)
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.
void setMulticastTTL(int ttl) throws InvalidAttributeValueException
Sets the time-to-live value for the cluster's multicast address.
ttl
- The new multicastTTL value
InvalidAttributeValueException
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.
void setMulticastSendDelay(int delay) throws InvalidAttributeValueException
Sets the number of milliseconds to delay sending message fragments over multicast.
delay
- The new multicastSendDelay value
InvalidAttributeValueException
String getDefaultLoadAlgorithm()
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.
void setDefaultLoadAlgorithm(String value) throws InvalidAttributeValueException
Sets the default load balancing algorithm.
value
- The new defaultLoadAlgorithm value
InvalidAttributeValueException
IllegalArgumentException
- if the value is not a valid algorithm.String getClusterMessagingMode()
Specifies the messaging type used in the cluster.
Multicast messaging is provided for backwards compatibility.
Unicast, the default, is recommended for new clusters.
void setClusterMessagingMode(String value) throws InvalidAttributeValueException
InvalidAttributeValueException
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.
void setClusterBroadcastChannel(String value) throws InvalidAttributeValueException
InvalidAttributeValueException
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.
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.
seconds
- The new serviceAgeThresholdSeconds value
InvalidAttributeValueException
DistributedManagementException
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 ServerTemplateMBean.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.
ccp
- The new clientCertProxyEnabled valueWebAppContainerMBean.setClientCertProxyEnabled(boolean)
,
ServerTemplateMBean.setClientCertProxyEnabled(boolean)
boolean isClientCertProxyEnabled()
Specifies whether to honor the WL-Proxy-Client-Cert header coming with the request or not.
WebAppContainerMBean.isClientCertProxyEnabled()
,
ServerTemplateMBean.isClientCertProxyEnabled()
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
wpe
- The new weblogicPluginEnabled valueWebAppContainerMBean.setWeblogicPluginEnabled(boolean)
,
ServerTemplateMBean.setWeblogicPluginEnabled(boolean)
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
WebAppContainerMBean.isWeblogicPluginEnabled()
,
ServerTemplateMBean.isWeblogicPluginEnabled()
MigratableTargetMBean[] getMigratableTargets()
Returns all the MigratableTargets for this cluster
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
void setMemberWarmupTimeoutSeconds(int seconds)
Maximum number of seconds that a cluster member will wait to discover and synchronize with other servers in the cluster.
seconds
- The new memberWarmupTimeoutSeconds valueClusterMBean.getMemberWarmupTimeoutSeconds()
void setHttpTraceSupportEnabled(boolean tse)
WebAppContainerMBean.setHttpTraceSupportEnabled(boolean)
,
ServerTemplateMBean.setHttpTraceSupportEnabled(boolean)
boolean isHttpTraceSupportEnabled()
Returns the value of HttpTraceSupportEnabled.
WebAppContainerMBean.isHttpTraceSupportEnabled()
,
ServerTemplateMBean.isHttpTraceSupportEnabled()
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.
WebServerMBean.getFrontendHost()
void setFrontendHost(String hostName) throws InvalidAttributeValueException
Sets the FrontendHost attribute of the WebServerMBean object
hostName
- The new FrontendHost value
InvalidAttributeValueException
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.
WebServerMBean.getFrontendHTTPPort()
void setFrontendHTTPPort(int httpPort) throws InvalidAttributeValueException
Sets the FrontendHTTPPort attribute.
httpPort
- The new FrontendHTTPPort value
InvalidAttributeValueException
ClusterMBean.getFrontendHTTPPort()
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.
WebServerMBean.getFrontendHTTPSPort()
void setFrontendHTTPSPort(int httpsPort) throws InvalidAttributeValueException
Sets the FrontendHTTPSPort attribute.
httpsPort
- The new FrontendHTTPSPort value
InvalidAttributeValueException
ClusterMBean.getFrontendHTTPSPort()
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.
void setIdlePeriodsUntilTimeout(int timeout)
Sets the IdlePeriodsUntilTimeout attribute.
ClusterMBean.getIdlePeriodsUntilTimeout()
void setRemoteClusterAddress(String clusterAddress)
Sets the RemoteClusterAddress attribute.
clusterAddress
- Set the foreign cluster address for WAN/MAN HTTP session failover.ClusterMBean.getRemoteClusterAddress()
String getRemoteClusterAddress()
Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.
void setWANSessionPersistenceTableName(String name)
String getWANSessionPersistenceTableName()
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.
ClusterMBean.getRemoteClusterAddress()
void setReplicationChannel(String replicationChannel)
replicationChannel
- channel name for session replication.ClusterMBean.getReplicationChannel()
int getInterClusterCommLinkHealthCheckInterval()
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.
void setInterClusterCommLinkHealthCheckInterval(int interval)
Sets the InterClusterCommLinkHealthCheckInterval attribute.
interval
- ClusterMBean.getInterClusterCommLinkHealthCheckInterval()
void setDataSourceForSessionPersistence(JDBCSystemResourceMBean mbean)
Sets the DataSourceForSessionPersistence attribute.
mbean
- ClusterMBean.getDataSourceForSessionPersistence()
JDBCSystemResourceMBean getDataSourceForSessionPersistence()
To support HTTP Session failover across data centers, a datasource is required to dump session state on disk.
void setDataSourceForJobScheduler(JDBCSystemResourceMBean mbean)
Data source required to support persistence of jobs scheduled with the job scheduler
JDBCSystemResourceMBean getDataSourceForJobScheduler()
Data source required to support persistence of jobs scheduled with the job scheduler
String getJobSchedulerTableName()
The table name to use for storing timers active with the job scheduler
void setJobSchedulerTableName(String tableName)
The data source that servers in the cluster use to persist cluster wide timers.
ClusterMBean.getJobSchedulerTableName()
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 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.
void setPersistSessionsOnShutdown(boolean persist)
Sets the PersistSessionsOnShutdown attribute.
persist
- whether or not to persist sessions on shutdownClusterMBean.getPersistSessionsOnShutdown()
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.
asyncSessionQueueTimeout
- in secondsClusterMBean.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.
int getGreedySessionFlushInterval()
Interval in seconds until HTTP Sessions are periodically flushed to secondary server.
void setSessionFlushInterval(int sessionFlushInterval)
Sets the SessionFlushInterval attribute.
sessionFlushInterval
- in secondsClusterMBean.getSessionFlushInterval()
int getSessionFlushInterval()
Interval in seconds until HTTP Sessions are periodically flushed to the backup cluster to dump session state on disk.
void setSessionFlushThreshold(int sessionFlushThreshold)
Sets the SessionFlushThreshold attribute.
sessionFlushThreshold
- ClusterMBean.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.
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.
ServerTemplateMBean.getCandidateMachines()
void setCandidateMachinesForMigratableServers(MachineMBean[] machines)
set getCandidateMachinesForMigratableServers
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.)
void setDataSourceForAutomaticMigration(JDBCSystemResourceMBean dataSource)
Sets the DataSourceForAutomaticMigration attribute.
ClusterMBean.getDataSourceForAutomaticMigration()
int getHealthCheckIntervalMillis()
Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.
void setHealthCheckIntervalMillis(int healthCheckInterval)
Sets the value of the HealthCheckIntervalMillis attribute.
healthCheckInterval
- in milli seconds.ClusterMBean.getHealthCheckIntervalMillis()
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.
void setHealthCheckPeriodsUntilFencing(int healthCheckPeriodsUntilTimeout)
Sets the value of the HealthCheckPeriodsUntilFencing attribute.
healthCheckPeriodsUntilTimeout
- health check periods until time out.ClusterMBean.getHealthCheckPeriodsUntilFencing()
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.
void setFencingGracePeriodMillis(int gracePeriod)
Sets the value of the FencingGracePeriodMillis attribute.
ClusterMBean.getFencingGracePeriodMillis()
int getNumberOfServersInClusterAddress()
ClusterMBean.getClusterAddress()
void setNumberOfServersInClusterAddress(int numberOfServersInClusterAddress)
Sets the NumberOfServersInClusterAddress attribute
ClusterMBean.getNumberOfServersInClusterAddress()
void setClusterType(String type)
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.
void setMulticastDataEncryption(boolean value)
boolean getMulticastDataEncryption()
void setAutoMigrationTableName(String name)
String getAutoMigrationTableName()
int getAdditionalAutoMigrationAttempts()
void setAdditionalAutoMigrationAttempts(int tries)
tries
- number of additional times to loop through all the machinesClusterMBean.getAdditionalAutoMigrationAttempts()
long getMillisToSleepBetweenAutoMigrationAttempts()
ClusterMBean.getAdditionalAutoMigrationAttempts()
void setMillisToSleepBetweenAutoMigrationAttempts(long millis)
millis
- number of milliseconds to waitClusterMBean.getMillisToSleepBetweenAutoMigrationAttempts()
void setReplicationTimeoutEnabled(boolean replicationTimeout)
String getMigrationBasis()
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.
void setMigrationBasis(String type)
type
- of basis used for migrationboolean isReplicationTimeoutEnabled()
OverloadProtectionMBean getOverloadProtection()
DatabaseLessLeasingBasisMBean getDatabaseLessLeasingBasis()
boolean isSecureReplicationEnabled()
void setSecureReplicationEnabled(boolean value)
void setMessageOrderingEnabled(boolean value)
void setOneWayRmiForReplicationEnabled(boolean enable)
boolean isOneWayRmiForReplicationEnabled()
ServerTemplateMBean.getReplicationPorts()
boolean isSessionLazyDeserializationEnabled()
boolean isMemberDeathDetectorEnabled()
CoherenceClusterSystemResourceMBean getCoherenceClusterSystemResource()
void setCoherenceClusterSystemResource(CoherenceClusterSystemResourceMBean coherenceClusterSystemResource)
coherenceClusterSystemResource
- CoherenceTierMBean getCoherenceTier()
JTAClusterMBean getJTACluster()
DynamicServersMBean getDynamicServers()
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |