Oracle Fusion Middleware
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02

weblogic.management.configuration
Interface OverloadProtectionMBean

All Superinterfaces:
ConfigurationMBean

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


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
 

Field Detail

NO_ACTION

static final String NO_ACTION
See Also:
Constant Field Values

SYSTEM_EXIT

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

FORCE_SHUTDOWN

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

ADMIN_STATE

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
Method Detail

setSharedCapacityForWorkManagers

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
Maximum Value:
1073741824
Minimum Value:
1

getSharedCapacityForWorkManagers

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.

Maximum Value:
1073741824
Minimum Value:
1

setPanicAction

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
Valid Values:
OverloadProtectionMBean.NO_ACTION, OverloadProtectionMBean.SYSTEM_EXIT

getPanicAction

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.

Valid Values:
OverloadProtectionMBean.NO_ACTION, OverloadProtectionMBean.SYSTEM_EXIT

setFailureAction

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
Valid Values:
OverloadProtectionMBean.NO_ACTION, OverloadProtectionMBean.FORCE_SHUTDOWN, OverloadProtectionMBean.ADMIN_STATE

getFailureAction

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.

Valid Values:
OverloadProtectionMBean.NO_ACTION, OverloadProtectionMBean.FORCE_SHUTDOWN, OverloadProtectionMBean.ADMIN_STATE

setFreeMemoryPercentHighThreshold

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
Maximum Value:
99
Minimum Value:
0

getFreeMemoryPercentHighThreshold

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.

Maximum Value:
99
Minimum Value:
0

setFreeMemoryPercentLowThreshold

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
Maximum Value:
99
Minimum Value:
0

getFreeMemoryPercentLowThreshold

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

Maximum Value:
99
Minimum Value:
0

getServerFailureTrigger

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

createServerFailureTrigger

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

void destroyServerFailureTrigger()
Since:
9.0.0.0

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111/wls.htm
Copyright 1996, 2009, 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
Oracle WebLogic Server 10.3.1 MBean API Reference
11g Release 1 (10.3.1)

Part Number E13945-02