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:
: A Notification is provided to system administrators as an informational update of the trigger being breached.
: Throttle (typically slow-down) the rate at which the resource is consumed.
: Fail one or more resource consumption requests, usually until usage is below the desired limit.
: 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:
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.
Atmost one shutdown recourse action may be specified for a resource type.
Atmost one slow recourse action may be specified for a resource type.
Atmost one fail recourse action may be specified for a resource type.
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 | ||
Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:weblogic.management.configuration.RCMResourceMBean
|
||
Factory Methods | No factory methods. Instances of this MBean are created automatically. | ||
Subtypes |
The following MBeans extend or implement this MBean type: |
This section describes attributes that provide access to other MBeans.
|
Gets the list of configured trigger based policies for the current resource type.
Factory Methods | createTrigger
(java.lang.String name)
Factory methods do not return objects. |
Lookup Operation | lookupTrigger(String name)
Returns a |
Privileges | Read only |
Type | TriggerMBean[] |
Relationship type: | Containment. |
This section describes the following attributes:
Private property that disables caching in proxies.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return whether the MBean was created dynamically or is persisted to config.xml
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the unique id of this MBean instance
Privileges | Read only |
Type | long |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the MBean info for this MBean.
Deprecated.
Privileges | Read only |
Type | javax.management.MBeanInfo |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
Privileges | Read/Write |
Type | java.lang.String |
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml
) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<
. Carriage returns/line feeds are
preserved.
Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Privileges | Read/Write |
Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
Privileges | Read only |
Type | weblogic.management.WebLogicObjectName |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return all tags on this Configuration MBean
Available Since | Release 12.2.1.0 |
Privileges | Read/Write |
Type | class java.lang.String[] |
Returns the type of the MBean.
Privileges | Read only |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.
Operation Name | "addTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.
Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.
Note: To insure that you are freezing the default value, invoke
the restoreDefaultValue
operation before you invoke
this.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.
Deprecated.
Operation Name | "freezeCurrentValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
Operation Name | "getInheritedProperties" |
Parameters | Object [] { propertyNames }
where:
|
Signature | String [] {
"[Ljava.lang.String;" } |
Returns |
class |
Check if the value of a property is inherited from template mbean or not.
Operation Name | "isInherited" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name | "isSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Looks up a trigger configuration from the list of triggers configured in this resource type.
Operation Name | "lookupTrigger" |
Parameters | Object [] { name }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns | TriggerMBean |
Remove a tag from this Configuration MBean
Operation Name | "removeTag" |
Parameters | Object [] { tag }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.
Default values are subject to change if you update to a newer
release of WebLogic Server. To prevent the value from changing if
you update to a newer release, invoke the
freezeCurrentValue
operation.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.
Deprecated.
Operation Name | "restoreDefaultValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Restore the given property to its default value.
Operation Name | "unSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|