WebLogic Server 8.1 API Reference

weblogic.management.configuration
Interface ClusterMBean

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.

Author:

Copyright © 2002 BEA Systems, Inc. All Rights Reserved.

Fields inherited from class weblogic.management.configuration.TargetMBean

CACHING_STUB_SVUID

Fields inherited from class weblogic.management.configuration.ConfigurationMBean

CACHING_STUB_SVUID

Method Summary

java.lang.String	getClusterAddress() Defines the address to be used by clients to connect to this cluster.
java.lang.String	getDefaultLoadAlgorithm() Defines the algorithm to be used for load-balancing between replicated services if none is specified for a particular service.
java.lang.String	getMulticastAddress() Defines the multicast address used by cluster members to communicate with each other.
int	getMulticastBufferSize() Returns the multicast socket send/receive buffer size.
int	getMulticastPort() Defines the multicast port used by cluster members to communicate with each other.
int	getMulticastSendDelay() Defines the number of milliseconds to delay sending message fragments over multicast in order to avoid OS-level buffer overflow.
int	getMulticastTTL() Defines the number of network hops that a cluster multicast message is allowed to travel.
ServerMBean[]	getServers() The servers which have declared membership in this cluster.
boolean	isClientCertProxyEnabled() Gets the clientCertProxyEnabled attribute of the ClusterMBean object
boolean	isWeblogicPluginEnabled() Gets the weblogicPluginEnabled attribute of the ClusterMBean object
java.util.HashMap	kill() Used to force a Shutdown of all the servers belonging to the Cluster.
void	setClientCertProxyEnabled(boolean ccp) Defines if the HttpClusterServlet proxies the client certificate in a special header.
void	setClusterAddress(java.lang.String address) Sets the cluster's address.
void	setDefaultLoadAlgorithm(java.lang.String value) Sets the default load balancing algorithm.
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	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	setWeblogicPluginEnabled(boolean wpe) WLS HttpRequest.getRemoteAddr() used to rely on X-Forwarded-For for its returned value.
java.util.HashMap	start() Used to start all the servers belonging to the Cluster.

Methods inherited from interface weblogic.management.configuration.TargetMBean

setDeployments

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getNotes, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

getServers

public ServerMBean[] getServers()

The servers which have declared membership in this cluster.

Returns:

The servers value

getClusterAddress

public java.lang.String getClusterAddress()

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.

A configurable MBean attribute

Returns:

The clusterAddress value

See Also:

NetworkChannelMBean.getClusterAddress()

setClusterAddress

public void setClusterAddress(java.lang.String address)
                       throws javax.management.InvalidAttributeValueException

Sets the cluster's address.

Parameters:

address - The new clusterAddress value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

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

See Also:

getMulticastAddress()

getMulticastAddress

public java.lang.String getMulticastAddress()

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

A configurable MBean attribute

Default Value: "237.0.0.1"

Old Property: weblogic.cluster.multicastAddress

Returns:

The multicastAddress value

See Also:

ServerMBean.getInterfaceAddress(), getMulticastPort()

setMulticastAddress

public void setMulticastAddress(java.lang.String address)
                         throws javax.management.InvalidAttributeValueException

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

Parameters:

address - The new multicastAddress value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

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

See Also:

ServerMBean.getInterfaceAddress(), setMulticastPort(int)

setMulticastBufferSize

public void setMulticastBufferSize(int bufSize)

Defines the multicast socket send/receive buffer size.

A configurable MBean attribute

Legal Minimum Value: 64

Parameters:

bufSize - The new multicastBufferSize value

getMulticastBufferSize

public int getMulticastBufferSize()

Returns the multicast socket send/receive buffer size.

A configurable MBean attribute

Default Value: 64

Returns:

The multicastBufferSize value

getMulticastPort

public int getMulticastPort()

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

A configurable MBean attribute

Default Value: 7001

Legal Minimum Value: 1

Legal Maximum Value: 65535

Returns:

The multicastPort value

See Also:

setMulticastPort(int), getMulticastAddress()

setMulticastPort

public void setMulticastPort(int port)
                      throws javax.management.InvalidAttributeValueException

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

Legal Minimum Value: 1

Legal Maximum Value: 65535

Parameters:

port - The new multicastPort value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

See Also:

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

getMulticastTTL

public int getMulticastTTL()

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

A configurable MBean attribute

Default Value: 1

Old Property: weblogic.cluster.multicastTTL

Legal Minimum Value: 1

Legal Maximum Value: 255

Returns:

The multicastTTL value

setMulticastTTL

public void setMulticastTTL(int ttl)
                     throws javax.management.InvalidAttributeValueException

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

Legal Minimum Value: 1

Legal Maximum Value: 255

Parameters:

ttl - The new multicastTTL value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getMulticastSendDelay

public int getMulticastSendDelay()

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

A configurable MBean attribute

Default Value: 3

Legal Minimum Value: 0

Legal Maximum Value: 250

Returns:

The multicastSendDelay value

setMulticastSendDelay

public void setMulticastSendDelay(int delay)
                           throws javax.management.InvalidAttributeValueException

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

Legal Minimum Value: 0

Legal Maximum Value: 100

Parameters:

delay - The new multicastSendDelay value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

getDefaultLoadAlgorithm

public java.lang.String getDefaultLoadAlgorithm()

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

A configurable MBean attribute

Default Value: "round-robin"

Old Property: weblogic.cluster.defaultLoadAlgorithm

Legal Values: "round-robin","weight-based","random","round-robin-affinity","weighted-affinity","random-affinity"

Returns:

The defaultLoadAlgorithm value

setDefaultLoadAlgorithm

public void setDefaultLoadAlgorithm(java.lang.String value)
                             throws javax.management.InvalidAttributeValueException

Sets the default load balancing algorithm.

Parameters:

value - The new defaultLoadAlgorithm value

Throws:

javax.management.InvalidAttributeValueException - Description of the Exception

java.lang.IllegalArgumentException - if the value is not a valid algorithm.

start

public java.util.HashMap start()

Used to start all the servers belonging to the Cluster. HashMap contains references to TaskRuntimeMBeans corresponding to each server in the Cluster, keyed using the server name.

Returns:

Description of the Return Value

kill

public java.util.HashMap kill()

Used to force a Shutdown of all the servers belonging to the Cluster.

Returns:

Description of the Return Value

setClientCertProxyEnabled

public void setClientCertProxyEnabled(boolean ccp)

Defines if the HttpClusterServlet proxies the client certificate in a special header.

It's strongly suggested to use in conjunction with ConnectionFilters to make certain the WebLogic proxy machine is the only connection.

Default Value: false

Parameters:

ccp - The new clientCertProxyEnabled value

isClientCertProxyEnabled

public boolean isClientCertProxyEnabled()

Gets the clientCertProxyEnabled attribute of the ClusterMBean object

Returns:

The clientCertProxyEnabled value

setWeblogicPluginEnabled

public 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

Default Value: false

Parameters:

wpe - The new weblogicPluginEnabled value

isWeblogicPluginEnabled

public boolean isWeblogicPluginEnabled()

Gets the weblogicPluginEnabled attribute of the ClusterMBean object

Returns:

The weblogicPluginEnabled value