ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, TargetMBean, WebLogicMBeanpublic 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.
| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.String |
CREATION_POLICY_ALWAYS |
|
static java.lang.String |
CREATION_POLICY_DISABLED |
DEFAULT_EMPTY_BYTE_ARRAY| Modifier and Type | Method | Description |
|---|---|---|
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.
|
java.lang.String |
getAutoMigrationTableCreationDDLFile() |
The absolute file path of a custom DDL file for creating the automatic migration database table.
|
java.lang.String |
getAutoMigrationTableCreationPolicy() |
Control automatic leasing table creation behavior.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getClusterBroadcastChannel() |
Specifies the channel used to handle communications within a cluster.
|
java.lang.String |
getClusterMessagingMode() |
Specifies the messaging type used in the cluster.
|
java.lang.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.
|
int |
getDatabaseLeasingBasisConnectionRetryCount() |
The maximum number of times Database Leasing will try to obtain a valid
connection from the Data Source.
|
long |
getDatabaseLeasingBasisConnectionRetryDelay() |
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.
|
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.
|
java.lang.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.
|
java.lang.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.
|
java.lang.String |
getJobSchedulerTableName() |
The table name to use for storing timers active with the
job scheduler
|
JTAClusterMBean |
getJTACluster() |
JTA associated with this WLS cluster.
|
int |
getMaxSecondarySelectionAttempts() |
This is the max number of attempts at choosing a suitable secondary server
for replication.If it is set to 0,secondary server selection for replication
will be tried on all servers in the 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
|
java.lang.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().
|
java.lang.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.
|
java.lang.String |
getName() |
The user-specified name of this MBean instance.
|
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.
|
int |
getRebalanceDelayPeriods() |
Gets the number of the Rebalance periods to wait to rebalance
cluster targeted JMS instances in an idle system (typically 10 seconds per period).
|
java.lang.String |
getRemoteClusterAddress() |
Set the foreign cluster.
|
java.lang.String |
getReplicationChannel() |
The channel name to be used for replication traffic.
|
int |
getReplicationTimeoutMillis() |
Interval in milliseconds at which Migratable Servers and
Cluster Masters prove their liveness via the database.
|
ServerMBean[] |
getServers() |
The servers which have declared membership in this cluster.
|
int |
getServiceActivationRequestResponseTimeout() |
The maximum time, in milliseconds seconds, for services to wait for response
from cluster members.
|
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.
|
int |
getSessionStateQueryRequestTimeout() |
The maximum time, in seconds, for session state query request to wait for response
from cluster members.
|
int |
getSingletonServiceRequestTimeout() |
The maximum time, in milliseconds, for service activation requests will wait for response
from cluster members.
|
java.lang.String |
getSiteName() |
The name of the site this cluster is associated with.
|
boolean |
getTxnAffinityEnabled() |
If enabled, a server's transaction requests go to servers in the cluster
that are already participating in the global transaction.
|
java.lang.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 |
isConcurrentSingletonActivationEnabled() |
Specifies whether to allow the concurrent activation, deactivation, or restart of two or
more singleton services.
|
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 |
isSessionStateQueryProtocolEnabled() |
Indicates if session state query protocol is enabled.
|
boolean |
isWeblogicPluginEnabled() |
Specifies if this cluster will receive requests from a proxy plug-in
or
HttpClusterServlet. |
void |
setAdditionalAutoMigrationAttempts(int tries) |
Sets the AdditionalAutoMigrationAttempts value.
|
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 |
setAutoMigrationTableCreationDDLFile(java.lang.String filePath) |
Sets the absolute file path of a custom DDL file
for creating the automatic migration database table.
|
void |
setAutoMigrationTableCreationPolicy(java.lang.String policy) |
Specifies automatic leasing table creation behavior.
|
void |
setAutoMigrationTableName(java.lang.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(java.lang.String address) |
Sets the cluster's address.
|
void |
setClusterBroadcastChannel(java.lang.String value) |
Configure the cluster messaging mode value
|
void |
setClusterMessagingMode(java.lang.String value) |
|
void |
setClusterType(java.lang.String type) |
Sets the value of the ClusterType attribute.
|
void |
setCoherenceClusterSystemResource(CoherenceClusterSystemResourceMBean coherenceClusterSystemResource) |
Associates the WLS cluster to a Coherence Cluster
|
void |
setConcurrentSingletonActivationEnabled(boolean enabled) |
Specifies whether to allow the concurrent activation, deactivation, or restart of two or
more singleton services.
|
void |
setDatabaseLeasingBasisConnectionRetryCount(int count) |
|
void |
setDatabaseLeasingBasisConnectionRetryDelay(long millis) |
|
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(java.lang.String value) |
Sets the default load balancing algorithm.
|
void |
setFencingGracePeriodMillis(int gracePeriod) |
Sets the value of the FencingGracePeriodMillis attribute.
|
void |
setFrontendHost(java.lang.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(java.lang.String tableName) |
The data source that servers in the cluster use to persist cluster wide
timers.
|
void |
setMaxSecondarySelectionAttempts(int maxSecondarySelectionAttempts) |
Sets the max number of attempts at choosing a suitable secondary server
for replication.If it is set to 0,secondary server selection for replication
will be tried on all servers in the cluster.
|
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(java.lang.String type) |
|
void |
setMillisToSleepBetweenAutoMigrationAttempts(long millis) |
Sets the getMillisToSleepBetweenAutoMigrationAttempts value.
|
void |
setMulticastAddress(java.lang.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 |
setRebalanceDelayPeriods(int rebalanceDelayPeriods) |
Sets the value of the RebalanceDelayPeriods attribute.
|
void |
setRemoteClusterAddress(java.lang.String clusterAddress) |
Sets the RemoteClusterAddress attribute.
|
void |
setReplicationChannel(java.lang.String replicationChannel) |
|
void |
setReplicationTimeoutEnabled(boolean replicationTimeout) |
Enable or disable replication timeout.
|
void |
setReplicationTimeoutMillis(int replicationTimeout) |
Sets the value of the ReplicationTimeoutMillis attribute.
|
void |
setSecureReplicationEnabled(boolean value) |
|
void |
setServiceActivationRequestResponseTimeout(int timeout) |
The maximum time, in milliseconds seconds, for services to wait for response
from cluster members.
|
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 |
setSessionStateQueryProtocolEnabled(boolean enable) |
Enables session state query protocol.
|
void |
setSessionStateQueryRequestTimeout(int timeout) |
The maxmimum number of seconds a Session State Query Request will wait
for a response from the cluster.
|
void |
setSingletonServiceRequestTimeout(int timeout) |
The maximum time, in milliseconds, for service activation requests will wait for response
from cluster members.
|
void |
setSiteName(java.lang.String siteName) |
Sets the value of the SiteName attribute.
|
void |
setTxnAffinityEnabled(boolean txAffinity) |
|
void |
setWANSessionPersistenceTableName(java.lang.String name) |
|
void |
setWeblogicPluginEnabled(boolean wpe) |
WLS HttpRequest.getRemoteAddr() used to rely on X-Forwarded-For
for its returned value.
|
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSetaddPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListenergetAttribute, getAttributes, invoke, setAttribute, setAttributespostDeregister, postRegister, preDeregister, preRegisteraddNotificationListener, getNotificationInfo, removeNotificationListenergetMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParentstatic final java.lang.String CREATION_POLICY_DISABLED
static final java.lang.String CREATION_POLICY_ALWAYS
java.lang.String getName()
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
getName in interface ConfigurationMBeangetName in interface WebLogicMBeanServerMBean[] getServers()
The servers which have declared membership in this cluster.
java.lang.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(java.lang.String address)
throws javax.management.InvalidAttributeValueException
Sets the cluster's address.
address - The new clusterAddress valuejavax.management.InvalidAttributeValueExceptionjava.lang.IllegalArgumentException - if the address is not either a well-formed IP address or hostname.getMulticastAddress()java.lang.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(),
getMulticastPort()void setMulticastAddress(java.lang.String address)
throws javax.management.InvalidAttributeValueException
Sets the multicast address used by cluster members to communicate with each other.
address - The new multicastAddress valuejavax.management.InvalidAttributeValueExceptionjava.lang.IllegalArgumentException - if the argument is not a well-formed IP address.ServerTemplateMBean.getInterfaceAddress(),
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.
setMulticastPort(int),
getMulticastAddress()void setMulticastPort(int port)
throws javax.management.InvalidAttributeValueException
The multicast port used by cluster members to communicate with each other.
port - The new multicastPort valuejavax.management.InvalidAttributeValueExceptiongetMulticastPort(),
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 javax.management.InvalidAttributeValueException
Sets the time-to-live value for the cluster's multicast address.
ttl - The new multicastTTL valuejavax.management.InvalidAttributeValueExceptionint 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 javax.management.InvalidAttributeValueException
Sets the number of milliseconds to delay sending message fragments over multicast.
delay - The new multicastSendDelay valuejavax.management.InvalidAttributeValueExceptionjava.lang.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(java.lang.String value)
throws javax.management.InvalidAttributeValueException
Sets the default load balancing algorithm.
value - The new defaultLoadAlgorithm valuejavax.management.InvalidAttributeValueExceptionjava.lang.IllegalArgumentException - if the value is not a valid algorithm.java.lang.String getClusterMessagingMode()
Specifies the messaging type used in the cluster.
Multicast messaging is provided for backwards compatibility.
void setClusterMessagingMode(java.lang.String value)
throws javax.management.InvalidAttributeValueException
javax.management.InvalidAttributeValueExceptionjava.lang.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(java.lang.String value)
throws javax.management.InvalidAttributeValueException
javax.management.InvalidAttributeValueExceptionint 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 javax.management.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 valuejavax.management.InvalidAttributeValueExceptionDistributedManagementExceptionvoid 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 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.
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 valuegetMemberWarmupTimeoutSeconds()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
WebAppContainerMBean.setHttpTraceSupportEnabled(boolean),
ServerTemplateMBean.setHttpTraceSupportEnabled(boolean)boolean isHttpTraceSupportEnabled()
Returns the value of HttpTraceSupportEnabled.
WebAppContainerMBean.isHttpTraceSupportEnabled(),
ServerTemplateMBean.isHttpTraceSupportEnabled()java.lang.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(java.lang.String hostName)
throws javax.management.InvalidAttributeValueException
Sets the FrontendHost attribute of the WebServerMBean object
hostName - The new FrontendHost valuejavax.management.InvalidAttributeValueExceptionint 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 javax.management.InvalidAttributeValueException
Sets the FrontendHTTPPort attribute.
httpPort - The new FrontendHTTPPort valuejavax.management.InvalidAttributeValueExceptiongetFrontendHTTPPort()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 javax.management.InvalidAttributeValueException
Sets the FrontendHTTPSPort attribute.
httpsPort - The new FrontendHTTPSPort valuejavax.management.InvalidAttributeValueExceptiongetFrontendHTTPSPort()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.
getIdlePeriodsUntilTimeout()void setRemoteClusterAddress(java.lang.String clusterAddress)
Sets the RemoteClusterAddress attribute.
clusterAddress - Set the foreign cluster address for WAN/MAN HTTP session failover.getRemoteClusterAddress()java.lang.String getRemoteClusterAddress()
Set the foreign cluster. Cluster infrastructure uses this address to connect to foreign cluster for HTTP Session WAN/MAN failover.
void setWANSessionPersistenceTableName(java.lang.String name)
java.lang.String getWANSessionPersistenceTableName()
Return the name of the table to be used for WAN session persistence.
java.lang.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.
getRemoteClusterAddress()void setReplicationChannel(java.lang.String replicationChannel)
replicationChannel - channel name for session replication.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 - getInterClusterCommLinkHealthCheckInterval()void setDataSourceForSessionPersistence(JDBCSystemResourceMBean mbean)
Sets the DataSourceForSessionPersistence attribute.
mbean - 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
java.lang.String getJobSchedulerTableName()
The table name to use for storing timers active with the job scheduler
void setJobSchedulerTableName(java.lang.String tableName)
The data source that servers in the cluster use to persist cluster wide timers.
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 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 shutdowngetPersistSessionsOnShutdown()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 secondsgetAsyncSessionQueueTimeout()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 secondsgetSessionFlushInterval()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 - 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.
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.)
This setting applies only if the MigrationBasis attribute
is set to database.
getMigrationBasis(),
getAutoMigrationTableCreationDDLFile(),
getAutoMigrationTableCreationPolicy(),
getAutoMigrationTableName()void setDataSourceForAutomaticMigration(JDBCSystemResourceMBean dataSource)
Sets the DataSourceForAutomaticMigration attribute.
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.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.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.
getFencingGracePeriodMillis()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.
getClusterAddress()void setNumberOfServersInClusterAddress(int numberOfServersInClusterAddress)
Sets the NumberOfServersInClusterAddress attribute
getNumberOfServersInClusterAddress()void setClusterType(java.lang.String type)
Sets the value of the ClusterType attribute.
java.lang.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()
Enables multicast data to be encrypted. Only the multicast data is encrypted. Multicast header information is not encrypted.
void setAutoMigrationTableName(java.lang.String name)
java.lang.String getAutoMigrationTableName()
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.
getMigrationBasis(),
getAutoMigrationTableCreationDDLFile(),
getAutoMigrationTableCreationPolicy(),
getDataSourceForAutomaticMigration()java.lang.String getAutoMigrationTableCreationPolicy()
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.
getMigrationBasis(),
getAutoMigrationTableName(),
getAutoMigrationTableCreationDDLFile(),
getDataSourceForAutomaticMigration()void setAutoMigrationTableCreationPolicy(java.lang.String policy)
java.lang.String getAutoMigrationTableCreationDDLFile()
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.
getMigrationBasis(),
getAutoMigrationTableName(),
getAutoMigrationTableCreationPolicy(),
getDataSourceForAutomaticMigration()void setAutoMigrationTableCreationDDLFile(java.lang.String filePath)
Sets the absolute file path of a custom DDL file for creating the automatic migration database table.
filePath - file name and relative path for creating the tablegetAutoMigrationTableCreationDDLFile()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.
void setAdditionalAutoMigrationAttempts(int tries)
Sets the AdditionalAutoMigrationAttempts value.
If it is set to -1, migrations will go on forever until the server starts.
tries - number of additional times to loop through all the machinesgetAdditionalAutoMigrationAttempts()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.
getAdditionalAutoMigrationAttempts()void setMillisToSleepBetweenAutoMigrationAttempts(long millis)
Sets the getMillisToSleepBetweenAutoMigrationAttempts value.
millis - number of milliseconds to waitgetMillisToSleepBetweenAutoMigrationAttempts()void setReplicationTimeoutEnabled(boolean replicationTimeout)
Enable or disable replication timeout.
java.lang.String getMigrationBasis()
Controls the mechanism used for server and service migration.
DataSourceForAutomaticMigration
attribute. Optionally also configure AutoMigrationTableName (default is "ACTIVE"),
AutoMigrationTableCreationPolicy, and AutoMigrationTableCreationDDLFile.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.
getAutoMigrationTableName(),
getAutoMigrationTableCreationDDLFile(),
getAutoMigrationTableCreationPolicy(),
getDataSourceForAutomaticMigration()void setMigrationBasis(java.lang.String type)
type - of basis used for migrationboolean isReplicationTimeoutEnabled()
Indicates if timeout should be applied to session replication calls.
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.
DatabaseLessLeasingBasisMBean getDatabaseLessLeasingBasis()
Get attributes associated with database less leasing basis used for server migration and singleton services.
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.
The default value for this attribute is true if all cluster members have SSL enabled, and either secure mode is enabled or no plaintext replication channel is available. Otherwise, the default is false.
void setSecureReplicationEnabled(boolean value)
void setMessageOrderingEnabled(boolean value)
void setOneWayRmiForReplicationEnabled(boolean enable)
Enables one-way RMI for replication.
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.
ServerTemplateMBean.getReplicationPorts()boolean isSessionLazyDeserializationEnabled()
Enables increased efficiency with session replication. Enabling this attribute should be used only when configuring a WebLogic domain for Oracle Exalogic.
boolean isMemberDeathDetectorEnabled()
CoherenceClusterSystemResourceMBean getCoherenceClusterSystemResource()
void setCoherenceClusterSystemResource(CoherenceClusterSystemResourceMBean coherenceClusterSystemResource)
coherenceClusterSystemResource - CoherenceTierMBean getCoherenceTier()
JTAClusterMBean getJTACluster()
DynamicServersMBean getDynamicServers()
boolean getTxnAffinityEnabled()
void setTxnAffinityEnabled(boolean txAffinity)
int getDatabaseLeasingBasisConnectionRetryCount()
void setDatabaseLeasingBasisConnectionRetryCount(int count)
count - long getDatabaseLeasingBasisConnectionRetryDelay()
void setDatabaseLeasingBasisConnectionRetryDelay(long millis)
void setSessionStateQueryProtocolEnabled(boolean enable)
boolean isSessionStateQueryProtocolEnabled()
int getSessionStateQueryRequestTimeout()
void setSessionStateQueryRequestTimeout(int timeout)
getSessionStateQueryRequestTimeout()int getServiceActivationRequestResponseTimeout()
int getSingletonServiceRequestTimeout()
A value of 0 means that the request will wait
indefinitely to complete.
void setServiceActivationRequestResponseTimeout(int timeout)
getServiceActivationRequestResponseTimeout()void setSingletonServiceRequestTimeout(int timeout)
A value of 0 means that the request will wait
indefinitely to complete.
getSingletonServiceRequestTimeout()boolean isConcurrentSingletonActivationEnabled()
void setConcurrentSingletonActivationEnabled(boolean enabled)
isConcurrentSingletonActivationEnabled()java.lang.String getSiteName()
The name of the site this cluster is associated with.
void setSiteName(java.lang.String siteName)
Sets the value of the SiteName attribute.
siteName - The new recoveryCluster valuegetSiteName()int getReplicationTimeoutMillis()
Interval in milliseconds at which Migratable Servers and Cluster Masters prove their liveness via the database.
void setReplicationTimeoutMillis(int replicationTimeout)
Sets the value of the ReplicationTimeoutMillis attribute.
replicationTimeout - in milli seconds.getReplicationTimeoutMillis()int getMaxSecondarySelectionAttempts()
This is the max number of attempts at choosing a suitable secondary server for replication.If it is set to 0,secondary server selection for replication will be tried on all servers in the cluster.
void setMaxSecondarySelectionAttempts(int maxSecondarySelectionAttempts)
Sets the max number of attempts at choosing a suitable secondary server for replication.If it is set to 0,secondary server selection for replication will be tried on all servers in the cluster.
maxSecondarySelectionAttempts - maximum number of replication attemptsgetMaxSecondarySelectionAttempts()int getRebalanceDelayPeriods()
true,
and its Migration Policy is set to On-Failure or Always.DynamicDeploymentMBean.getRebalanceEnabled()void setRebalanceDelayPeriods(int rebalanceDelayPeriods)
the - number of delay periodsgetRebalanceDelayPeriods()