Skip navigation links

weblogic.management.configuration
Interface RCMResourceMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

All Known Subinterfaces:

CpuUtilizationMBean, FileOpenMBean, HeapRetainedMBean

public interface RCMResourceMBean

extends ConfigurationMBean

This mbean is used to create Trigger (Usage limit) based policies for a resource type.

Trigger (Usage limit) based policies allows a system administrator to establish usage limits, and define recourse actions that must be executed when those usage limits are breached.

A trigger is a static upper-limit of usage of a resource. When the consumption of that resource crosses the specified limit, the specified recourse action is performed. This policy type is best suited for environments where the resource usage by Domain Partitions are predictable.

As an example, a system administrator may limit the "Bayland" Partition to not use more than 100 open files, by setting a Trigger for 100 units of the "File Open" resource type in the resource-manager for the "Bayland" Partition.

Recourse Actions

The following recourse actions may be configured when a resource's trigger value is breached:

• notify: A Notification is provided to system administrators as an informational update of the trigger being breached.
• slow: Throttle (typically slow-down) the rate at which the resource is consumed.
• fail: Fail one or more resource consumption requests, usually until usage is below the desired limit.
• shutdown: Attempts to stop resource consumption by initiating the shutdown sequence of the Domain Partition while allowing cleanup.

The following requirements are validated during trigger creation:

1. The set of recourse actions listed above are not valid for all resource types. The resource type MBean's class document lists the subset of valid recourse actions that may be specified for that resource type. The specified recouse action for a resource type must be within that valid subset of recourse actions.
2. Atmost one shutdown recourse action may be specified for a resource type.
3. Atmost one slow recourse action may be specified for a resource type.
4. Atmost one fail recourse action may be specified for a resource type.
5. A slow recourse action cannot be specified for a resource type if a fair share policy is also defined for that resource type.

Trigger creation is failed if any of these requirements fail.

Since:

12.2.1.0

getTriggers

TriggerMBean[] getTriggers()

Gets the list of configured trigger based policies for the current resource type.

Returns:

TriggerMBean[] An array of TriggerMBean representing the configured trigger policies in this resource type.

lookupTrigger

TriggerMBean lookupTrigger(String name)

Looks up a trigger configuration from the list of triggers configured in this resource type.

Parameters:

name - Name of the trigger configuration to lookup.

Returns:

A TriggerMBean representing the trigger policy in this resource type whose name is the name parameter.

createTrigger

TriggerMBean createTrigger(String name,
                           long value,
                           String action)

This is the factory method for trigger configurations for this resource type.

The new TriggerMBean that is created will have the resource type MBean as its parent and must be destroyed with the RCMResourceMBean.destroyTrigger(TriggerMBean) method.

Parameters:

name - Name of the trigger configuration

value - The upper-limit of usage of the resource, beyond which the specified action must be taken.

action - The recourse action to be taken when the usage of resoure crosses the value specified in the value parameter. See the class documentation of RCMResourceMBean for a set of allowed recourse actions types. Refer the Resource type MBean to obtain the subset of valid recourse action types for the Resource type.

Returns:

A TriggerMBean representing the new trigger.

destroyTrigger

void destroyTrigger(TriggerMBean triggerMBean)

Destroys and removes a trigger configuration corresponding to the {code triggerMBean} parameter, which is a child of this resource type MBean.

Parameters:

triggerMBean - The TriggerMBean to be removed from this resource type MBean.

Skip navigation links