JMXMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Controls which JMX agents are initialized in the current WebLogic Server domain. Each JMX agent supports specific functions such as monitoring runtime statistics or modifying the domain's configuration.

       
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.JMXMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


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.

CompatibilityMBeanServerEnabled

Enables JMX clients to use the deprecated MBeanHome interface.

Prior to 9.0, WebLogic Server supported a typed API layer over its JMX layer. Your JMX application classes could import type-safe interfaces for WebLogic Server MBeans, retrieve a reference to the MBeans through the weblogic.management.MBeanHome interface, and invoke the MBean methods directly.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

DomainMBeanServerEnabled

Specifies whether the Administration Server initializes the Domain MBean Server, which provides federated access to all runtime MBeans and read-only configuration MBeans in the domain. Through it, JMX clients can access all MBeans in a domain through a single connection.

The Administration Console and the WebLogic Scripting Tool use this MBean server for many (but not all) of their read operations.

This MBean server exists only on the Administration Server. The Administration Server initializes it the first time a JMX client requests a connection to it. If you set this attribute to false, the Administration Server will not start this MBean server and JMX clients cannot connect to it.

While this MBean server is instantiated lazily (only when requested), once it is instantiated it does use some memory and network traffic. Disabling this MBean server can conserve a minimal amount of resources, but the trade off is that JMX clients must maintain separate connections for each WebLogic Server's Runtime MBean Server.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

EditMBeanServerEnabled

Specifies whether the Administration Server initializes the Edit MBean Server, which contains the hierarchy of MBeans used to make modifications to the domain's configuration. All JMX clients, including utilities such as the Administration Console and the WebLogic Scripting Tool, use the Edit MBean Server to modify a domain's configuration.

This MBean server exists only on the Administration Server. By default, when the Administration Server starts, it starts the Edit MBean Server. If you set the EditMBeanServerEnabled attribute to false, the Administration Server will not start this MBean server. If you disable this MBean server, JMX clients cannot modify the domain's configuration. You can, however, modify the domain configuration through the offline editing feature of WebLogic Scripting Tool.

Note:

Disabling the Edit MBean Server is not sufficient to prevent changes to a domain configuration. Because the WebLogic Server deployment service does not use JMX, the Administration Console and WLST can deploy or undeploy applications even if you have disabled the Edit MBean Server.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

InvocationTimeoutSeconds

The number of seconds that internal WebLogic Server processes wait to connect to an MBean server, invoke an MBean server method, and return the results of the invocation. If the MBean server method does not complete (return) within the timeout period, WebLogic Server abandons its invocation attempt.

Some internal management processes within WebLogic Server require a server instance to connect to MBean servers in other WebLogic Server instances and invoke an MBean server method. The timeout period prevents the internal process from locking up if an MBean server cannot successfully return a method invocation.

A value of 0 (zero) prevents the method invocation from timing out. With such a value, the internal process will wait indefinitely until the MBean server's method returns.

       
Available Since Release 10.0.0.0
Privileges Read/Write
Typeint
Default Value0
Minimum value0
Maximum value2147483647

ManagementEJBEnabled

Enables access to the Management EJB (MEJB), which is part of the J2EE Management APIs (JSR-77).

The Management API specification provides a standardized management data model for common resources on J2EE Web application servers.

The MEJB provides access to J2EE Managed Objects (JMOs), which describe the common J2EE resources. If you set this attribute to false, WebLogic Server does not register the MEJB in the JNDI tree, and effectively disables the J2EE Management APIs for the domain.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

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 Sever 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
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

PlatformMBeanServerEnabled

Causes each WebLogic Server instance to initialize the JDK's platform MBean server. Using it along with isPlatformMBeanServerUsed will cause WLS to use it as its Runtime MBean Server

As of JDK 1.5, JVMs provide a platform MBean server that local processes can instantiate. There can be only one instance of the platform MBean server for each JVM. When a process instantiates this MBean server, the JVM creates several platform MBeans that provide monitoring data for the JVM itself.

If you set this attribute to true, each WebLogic Server instance invokes the method java.lang.management.ManagementFactory.getPlatformMBeanServer() and thus causes the initialization of the JVM's MBeans.

       
Privileges Read/Write
Typeboolean

PlatformMBeanServerUsed

This attributes determines whether or not WebLogic Server will use the PlatformMBeanServer, if enabled, for its Runtime MBeanServer. Prior to this, WLS, by default, used the PlatformMBeanServer if it was enabled. This attribute provides seperation between enabling Platform MBS & using it for WLS MBeans.

In this case, the server's Runtime MBean Server uses the MBeanServer returned by java.lang.management.ManagementFactory.getPlatformMBeanServer() method as its MBeanServer. This makes it possible to access the WebLogic Server MBeans and the JVM platform MBeans from a single MBean server. In addition, if you enable the Runtime MBean Server to be the platform MBean server, local processes in the JVM can directly access this MBean server through the MBeanServer interface that java.lang.management.ManagementFactory.getPlatformMBeanServer() returns. With this local access, there are no WebLogic Server security checks to make sure that only authorized users can access WebLogic Server MBeans. Any application that is running in the JVM can access any of the WebLogic Server MBeans in the Runtime MBean Server/JDK Platform MBean Server. Do not use this configuration if you cannot control or cannot trust the applications that are running within a JVM.

       
Privileges Read/Write
Typeboolean

Registered

Returns false if the 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.

RuntimeMBeanServerEnabled

Specifies whether each server instance in the domain initializes its Runtime MBean Server, which provides access to a server's runtime MBeans and read-only configuration MBeans.

The Administration Console and the WebLogic Scripting Tool use this MBean server for some (but not all) of their read operations.

If RuntimeMBeanServerEnabled is true, each server starts its Runtime MBean Server during the server's startup cycle. If this attribute is false, no server instance in the domain will start its Runtime MBean Server.

       
Privileges Read/Write
Typeboolean
Default Valuetrue

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:


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

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

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