Package weblogic.management.configuration

Interface RCMResourceFairShareMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

All Known Subinterfaces:

CpuUtilizationMBean, HeapRetainedMBean

public interface RCMResourceFairShareMBean
extends ConfigurationMBean

The RCMResourceFairShareMBean is used to configure the Fair Share policy for a resource type.

A Fair share policy is typically used to ensure that a fixed-size shared resource is shared effectively (yet fairly) by competing consumers. A Fair share policy may also be employed by a system administrator when a clear understanding of the exact usage of a resource by a Partition cannot be accurately determined in advance, and the system administrator would like efficient utilization of resources while ensuring fair allocation of shared resources to co-resident Partitions.

A RCM fair-share policy provides the following assurance to the system administrator (in line with work manager's definition of fair-share): When there is "contention" for a resource, and there is "uniform load" across multiple Partitions "over a period of time", the share of the resource allocated to these Partitions is "roughly" in ratio of their configured fair shares.

A system administrator allocates a 'share' to a Partition by specifying an integer value to let the fair share policy know the share of resources that must be allocated to the Partition during contention over time. The sum of all Partition shares need not equal 100.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
FairShareConstraintMBean	createFairShareConstraint(java.lang.String name)	This is the factory method for fair share policy configurations for this resource type.
FairShareConstraintMBean	createFairShareConstraint(java.lang.String name, int value)	This is the factory method for fair share policy configurations for this resource type.
void	destroyFairShareConstraint(FairShareConstraintMBean fairShareConstraintMBean)	Destroys and removes a fair share policy configuration corresponding to the {code fairshareConstraintMBean} parameter, which is a child of this resource type MBean.
FairShareConstraintMBean	getFairShareConstraint()	Gets the Fair Share policy configured for this resource type.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

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.management.WebLogicMBean

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

Method Detail

getFairShareConstraint

FairShareConstraintMBean getFairShareConstraint()

Gets the Fair Share policy configured for this resource type.

Returns:

FairShareConstraintMBean A FairShareConstraintMBean representing the fair share policy configured for this resource type.

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createFairShareConstraint

FairShareConstraintMBean createFairShareConstraint(java.lang.String name)

This is the factory method for fair share policy configurations for this resource type.

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

Parameters:

name - Name of the fair share policy configuration

Returns:

A FairShareConstraintMBean representing the new fair share policy configuration.

createFairShareConstraint

FairShareConstraintMBean createFairShareConstraint(java.lang.String name,
                                                   int value)

This is the factory method for fair share policy configurations for this resource type.

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

Parameters:

name - Name of the fair share policy configuration

value - The share of resources that must be allocated to the Partition during contention over time

Returns:

A FairShareConstraintMBean representing the new fair share policy configuration.

destroyFairShareConstraint

void destroyFairShareConstraint(FairShareConstraintMBean fairShareConstraintMBean)

Destroys and removes a fair share policy configuration corresponding to the {code fairshareConstraintMBean} parameter, which is a child of this resource type MBean.

Parameters:

fairShareConstraintMBean - The FairShareConstraintMBean to be removed from this resource type MBean.