GzipCompressionMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean is used to specify domain-wide default values for GZIP compression support. In general, these properties can be overridden for a specific Web application (in the weblogic.xml file).

       
Since12.2.1.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.GzipCompressionMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:


    Attributes

    This section describes the following attributes:


    CachingDisabled

    Private property that disables caching in proxies.

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

    DynamicallyCreated

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

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

    GzipCompressionContentType

    Returns the type of content to be included in compression.

    For more information, see:

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Default Value text/html text/xml text/plain

    GzipCompressionEnabled

    This global property determines whether or not the container should provide GZIP compression.

           
    Privileges Read/Write
    Typeboolean

    GzipCompressionMinContentLength

    Returns the minimum content length to trigger GZIP compression. This allows you to bypass small-sized resources where compression does not yield a great return and uses unnecessary CPU.

    For more information, see:

           
    Privileges Read/Write
    Typelong
    Default Value2048

    Id

    Return the unique id of this MBean instance

           
    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.

    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

           
    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.

               
    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.

    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

           
    Privileges Read/Write
    Type

    Registered

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

    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

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

    Type

    Returns the type of the MBean.

           
    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

    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

    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