CapacityMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

CapacityMBean defines the maximum number of requests that can be enqueued by all the work managers that share it.

The server starts rejecting requests once the capacity threshold is reached. Note that the capacity includes all requests, queued or executing, from the constrained work set. This constraint is independent of the global queue threshold specified by OverloadProtectionMBean#getSharedCapacityForWorkManagers() .

Requests are rejected by performing overload actions. RMI work is rejected by sending back a recoverable exception to the clients. Servlet requests are rejected by sending back a 503 response.

       
Since9.0.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.CapacityMBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:
    Access Points Inherited from DeploymentMBean Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:


      Related MBeans

      This section describes attributes that provide access to other MBeans.


        Targets

        You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

               
        Privileges Read/Write
        TypeTargetMBean[]
        Relationship type: Reference.


        Attributes

        This section describes the following attributes:


        CachingDisabled

        Private property that disables caching in proxies.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Count

        Total number of requests that can be enqueued.

               
        Available Since Release 9.0.0.0
        Privileges Read/Write
        Typeint
        Default Value-1

        DeploymentOrder

        A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

        For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

        Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

               
        Privileges Read/Write
        Typeint
        Default Value1000
        Minimum value0
        Maximum value2147483647

        DynamicallyCreated

        Return whether the MBean was created dynamically or is persisted to config.xml

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Id

        Return the unique id of this MBean instance

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typelong
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        MBeanInfo

        Returns the MBean info for this MBean.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typejavax.management.MBeanInfo
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Name

        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

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read/Write
        Typejava.lang.String

        Notes

        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 &lt;. 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.

        This attribute is not dynamic and requires a server restart to take effect.

                   
        Privileges Read/Write
        Security rolesWrite access is granted only to the following roles:
        • Deployer
        • Operator
        Typejava.lang.String

        ObjectName

        Returns the ObjectName under which this MBean is registered in the MBean server.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeweblogic.management.WebLogicObjectName
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Parent

        Return the immediate parent for this MBean

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read/Write
        Type

        Registered

        Returns false if the MBean represented by this object has been unregistered.

        This attribute is not dynamic and requires a server restart to take effect.

        Deprecated.

               
        Privileges Read only
        Typeboolean
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

        Tags

        Return all tags on this Configuration MBean

        This attribute is dynamic and takes effect immediately.

               
        Available Since Release 12.2.1.0.0
        Privileges Read/Write
        Typeclass java.lang.String[]

        Type

        Returns the type of the MBean.

        This attribute is not dynamic and requires a server restart to take effect.

               
        Privileges Read only
        Typejava.lang.String
        Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


        Operations

        This section describes the following operations:


        addTag

        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"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be added to the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        addTarget

        You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

           
        Operation Name"addTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          The feature to be added to the Target attribute

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        freezeCurrentValue

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

           
        Operation Name"freezeCurrentValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException
        • javax.management.MBeanException

        getInheritedProperties

        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"
        ParametersObject [] {  propertyNames }

        where:

        • propertyNames is an object of type [Ljava.lang.String; that specifies:

          properties to check

        SignatureString [] { "[Ljava.lang.String;" }
        Returns class

        isInherited

        Check if the value of a property is inherited from template mbean or not.

           
        Operation Name"isInherited"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          the name of the property

        SignatureString [] { "java.lang.String" }
        Returns boolean

        isSet

        Returns true if the specified attribute has been set explicitly in this MBean instance.

           
        Operation Name"isSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to check

        SignatureString [] { "java.lang.String" }
        Returns boolean

        removeTag

        Remove a tag from this Configuration MBean

           
        Operation Name"removeTag"
        ParametersObject [] {  tag }

        where:

        • tag is an object of type java.lang.String that specifies:

          tag to be removed from the MBean

        SignatureString [] { "java.lang.String" }
        Returns boolean
        Exceptions
        • java.lang.IllegalArgumentException
          IllegalArgumentException if the tag contains illegal punctuation

        removeTarget

        Removes the value of the addTarget attribute.

        For more information, see:

           
        Operation Name"removeTarget"
        ParametersObject [] {  target }

        where:

        • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

          target

        SignatureString [] { "weblogic.management.configuration.TargetMBean" }
        Returns boolean
        Exceptions
        • javax.management.InvalidAttributeValueException
        • weblogic.management.DistributedManagementException

        restoreDefaultValue

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

           
        Operation Name"restoreDefaultValue"
        ParametersObject [] {  attributeName }

        where:

        • attributeName is an object of type java.lang.String that specifies:

          attributeName

        SignatureString [] { "java.lang.String" }
        Returns void
        Exceptions
        • javax.management.AttributeNotFoundException

        unSet

        Restore the given property to its default value.

           
        Operation Name"unSet"
        ParametersObject [] {  propertyName }

        where:

        • propertyName is an object of type java.lang.String that specifies:

          property to restore

        SignatureString [] { "java.lang.String" }
        Returns void