weblogic.management.configuration
Interface JMXMBean

All Superinterfaces:

ConfigurationMBean

public interface JMXMBean
extends ConfigurationMBean

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

Since:

9.0.0.0

isRuntimeMBeanServerEnabled

boolean isRuntimeMBeanServerEnabled()

Specifies whether each server instance in the domain initializes its Runtime MBean Server, which provides access to a server's run-time 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.

Default Value:

true

setRuntimeMBeanServerEnabled

void setRuntimeMBeanServerEnabled(boolean enabled)

Sets the value of the RuntimeMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

JMXMBean.isRuntimeMBeanServerEnabled()

isDomainMBeanServerEnabled

boolean isDomainMBeanServerEnabled()

Specifies whether the Administration Server initializes the Domain MBean Server, which provides federated access to all run-time 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.

Default Value:

true

setDomainMBeanServerEnabled

void setDomainMBeanServerEnabled(boolean enabled)

Sets the value of the DomainMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

JMXMBean.isDomainMBeanServerEnabled()

isEditMBeanServerEnabled

boolean isEditMBeanServerEnabled()

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.

Default Value:

true

setEditMBeanServerEnabled

void setEditMBeanServerEnabled(boolean enabled)

Sets the value of the EditMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

JMXMBean.isEditMBeanServerEnabled()

isCompatibilityMBeanServerEnabled

boolean isCompatibilityMBeanServerEnabled()

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.

Default Value:

true

setCompatibilityMBeanServerEnabled

void setCompatibilityMBeanServerEnabled(boolean enabled)

Sets the value of the CompatibilityMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

JMXMBean.isCompatibilityMBeanServerEnabled()

isManagementEJBEnabled

boolean isManagementEJBEnabled()

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.

Default Value:

true

setManagementEJBEnabled

void setManagementEJBEnabled(boolean enabled)

Enables the Management EJB the entire domain.

Parameters:

enabled - true to enable the service, false otherwise.

isPlatformMBeanServerEnabled

boolean isPlatformMBeanServerEnabled()

Specifies whether each server instance initializes the JDK's platform MBean server. Enabling it, along with isPlatformMBeanServerUsed, causes WebLogic Server to use the platform MBean server 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 MXBeans 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 MXBeans.

Default Value:

false

setPlatformMBeanServerEnabled

void setPlatformMBeanServerEnabled(boolean enabled)

Sets the value of the PlatformMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the platform MBeanServer, false otherwise.

See Also:

JMXMBean.isPlatformMBeanServerEnabled()

getInvocationTimeoutSeconds

int getInvocationTimeoutSeconds()

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.

Returns:

invocation timeout in seconds.

Since:

10.0.0.0

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setInvocationTimeoutSeconds

void setInvocationTimeoutSeconds(int timeout)
                                 throws InvalidAttributeValueException

Sets the value of the timeout for JMX server to server invocations.

Parameters:

timeout - Invocation timeout in seconds.

Throws:

InvalidAttributeValueException

See Also:

JMXMBean.getInvocationTimeoutSeconds()

isPlatformMBeanServerUsed

boolean isPlatformMBeanServerUsed()

Specifies whether WebLogic Server will use the platform MBean server for its Runtime MBean Server. Previously, WebLogic Server used the platform MBean server by default if it was enabled. This attribute provides a separation between enabling the platform MBean server and using it for WebLogic Server MBeans.

The default value for this attribute is based on the DomainVersion attribute of the DomainMBean. If the domain version is prior to 10.3.3.0, then the default value of this attribute is false and the platform MBean server is not used. If the domain version is 10.3.3.0 or higher, then the default value of this attribute is true and the platform MBean server is used.

In this case, the server's Runtime MBean Server uses the MBeanServer returned by java.lang.management.ManagementFactory.getPlatformMBeanServer() method as its MBean Server. This makes it possible to access the WebLogic Server MBeans and the JVM platform MXBeans 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.

setPlatformMBeanServerUsed

void setPlatformMBeanServerUsed(boolean enabled)

Sets the value of the PlatformMBeanServerUsed attribute. To be used along with the PlatformMBeanServerEnabled attribute. If set to true, WebLogic Server registers its Runtime MBeans with the Platform MBean Server.

Parameters:

enabled - true to enable the platform MBeanServer, false otherwise.

See Also:

JMXMBean.isPlatformMBeanServerUsed()