Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface OverloadProtectionMBean

All Superinterfaces:

ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean

public interface OverloadProtectionMBean

extends ConfigurationMBean

This Mbean has attributes concerning server overload protection.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

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

Field Summary

static String	ADMIN_STATE Enable automatic suspend of the server on failed state.
static String	FORCE_SHUTDOWN Enable automatic forceshutdown of the server on failed state.
static String	NO_ACTION
static String	SYSTEM_EXIT Exit the server process when the kernel encounters a panic condition like an unhandled OOME.

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

ServerFailureTriggerMBean	createServerFailureTrigger() Configure a trigger that marks the server as failed when the condition is met.
void	destroyServerFailureTrigger()
String	getFailureAction() Enable automatic forceshutdown of the server on failed state.
int	getFreeMemoryPercentHighThreshold() Percentage free memory after which the server overload condition is cleared.
int	getFreeMemoryPercentLowThreshold() Percentage free memory below which the server is considered overloaded.
String	getPanicAction() Exit the server process when the kernel encounters a panic condition like an unhandled OOME.
ServerFailureTriggerMBean	getServerFailureTrigger() Configure a trigger that marks the server as failed when the condition is met.
int	getSharedCapacityForWorkManagers() Total number of requests that can be present in the server.
void	setFailureAction(String action) Enable automatic forceshutdown of the server on failed state.
void	setFreeMemoryPercentHighThreshold(int percent) Percentage free memory after which the server overload condition is cleared.
void	setFreeMemoryPercentLowThreshold(int percent) Percentage free memory below which the server is considered overloaded.
void	setPanicAction(String action) Exit the server process when the kernel encounters a panic condition like an unhandled OOME.
void	setSharedCapacityForWorkManagers(int capacity) Total number of requests that can be present in the server.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getName, getNotes, 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

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Field Detail

ADMIN_STATE

public static final String ADMIN_STATE

Enable automatic suspend of the server on failed state. The server goes into admin state after the suspend operation. The server self-health monitoring detects fatal failures and mark the server as failed. The suspend operation is applied only when the server as an admin channel and is in the running state before the failure. Otherwise it will remain in the failed state till an administrator issues a shutdown command.

See Also:

Constant Field Values

FORCE_SHUTDOWN

public static final String FORCE_SHUTDOWN

Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.

See Also:

Constant Field Values

NO_ACTION

public static final String NO_ACTION

See Also:

Constant Field Values

SYSTEM_EXIT

public static final String SYSTEM_EXIT

Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.

See Also:

Constant Field Values

Method Detail

createServerFailureTrigger

public ServerFailureTriggerMBean createServerFailureTrigger()

Configure a trigger that marks the server as failed when the condition is met. A failed server in turn can be configured to shutdown or go into admin state.

Since:

9.0.0.0

destroyServerFailureTrigger

public void destroyServerFailureTrigger()

Since:

9.0.0.0

getFailureAction

public String getFailureAction()

Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.

A dynamic MBean attribute.

getFreeMemoryPercentHighThreshold

public int getFreeMemoryPercentHighThreshold()

Percentage free memory after which the server overload condition is cleared. WorkManagers stop performing overloadActions and start regular execution once the overload condition is cleared.

Minimum value:

0

Maximum value:

99

getFreeMemoryPercentLowThreshold

public int getFreeMemoryPercentLowThreshold()

Percentage free memory below which the server is considered overloaded. WorkManagers perform overloadAction once the server is marked as overloaded.

Minimum value:

0

Maximum value:

99

getPanicAction

public String getPanicAction()

Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.

getServerFailureTrigger

public ServerFailureTriggerMBean getServerFailureTrigger()

Configure a trigger that marks the server as failed when the condition is met. A failed server in turn can be configured to shutdown or go into admin state.

Since:

9.0.0.0

getSharedCapacityForWorkManagers

public int getSharedCapacityForWorkManagers()

Total number of requests that can be present in the server. This includes requests that are enqueued and those under execution.

The server performs a differentiated denial of service on reaching the shared capacity. A request with higher priority will be accepted in place of a lower priority request already in the queue. The lower priority request is kept waiting in the queue till all high priority requests are executed. Further enqueues of the low priority requests are rejected right away.

Minimum value:

1

Maximum value:

1073741824

setFailureAction

public void setFailureAction(String action)

Enable automatic forceshutdown of the server on failed state. The server self-health monitoring detects fatal failures and mark the server as failed. The server can be restarted using NodeManager or a HA agent.

Default value:

OverloadProtectionMBean.NO_ACTION

A dynamic MBean attribute.

setFreeMemoryPercentHighThreshold

public void setFreeMemoryPercentHighThreshold(int percent)

Percentage free memory after which the server overload condition is cleared. WorkManagers stop performing overloadActions and start regular execution once the overload condition is cleared.

Default value:

0

Minimum value:

0

Maximum value:

99

setFreeMemoryPercentLowThreshold

public void setFreeMemoryPercentLowThreshold(int percent)

Percentage free memory below which the server is considered overloaded. WorkManagers perform overloadAction once the server is marked as overloaded.

Default value:

0

Minimum value:

0

Maximum value:

99

setPanicAction

public void setPanicAction(String action)

Exit the server process when the kernel encounters a panic condition like an unhandled OOME. An unhandled OOME could lead to inconsistent state and a server restart is advisable if backed by node manager or a HA agent.

Default value:

OverloadProtectionMBean.NO_ACTION

setSharedCapacityForWorkManagers

public void setSharedCapacityForWorkManagers(int capacity)

Total number of requests that can be present in the server. This includes requests that are enqueued and those under execution.

The server performs a differentiated denial of service on reaching the shared capacity. A request with higher priority will be accepted in place of a lower priority request already in the queue. The lower priority request is kept waiting in the queue till all high priority requests are executed. Further enqueues of the low priority requests are rejected right away.

Default value:

65536

Minimum value:

1

Maximum value:

1073741824