Package weblogic.management.configuration

Interface JMXMBean

All Superinterfaces:

ConfigurationMBean, DescriptorBean, javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, SettableBean, WebLogicMBean

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.

Field Summary

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

Modifier and Type	Method	Description
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.
boolean	isCompatibilityMBeanServerEnabled()	Enables JMX clients to use the deprecated MBeanHome interface.
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.
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.
boolean	isManagedServerNotificationsEnabled()	Specifies whether the WebLogic Server Domain Runtime MBean Server will support notifications from the federated Runtime MBean Servers on the managed and administration servers.
boolean	isManagementAppletCreateEnabled()	Specifies whether the WebLogic Server MBean Servers will support creation of management applet (MLet) MBeans.
boolean	isManagementEJBEnabled()	Enables access to the Management EJB (MEJB), which is part of the Java EE Management APIs (JSR-77).
boolean	isPlatformMBeanServerEnabled()	Specifies whether each server instance initializes the JDK's platform MBean server.
boolean	isPlatformMBeanServerUsed()	Specifies whether WebLogic Server will use the platform MBean server for its Runtime MBean Server.
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.
void	setCompatibilityMBeanServerEnabled(boolean enabled)	Sets the value of the CompatibilityMBeanServerEnabled attribute.
void	setDomainMBeanServerEnabled(boolean enabled)	Sets the value of the DomainMBeanServerEnabled attribute.
void	setEditMBeanServerEnabled(boolean enabled)	Sets the value of the EditMBeanServerEnabled attribute.
void	setInvocationTimeoutSeconds(int timeout)	Sets the value of the timeout for JMX server to server invocations.
void	setManagedServerNotificationsEnabled(boolean enabled)	Sets the value of the ManagedServerNotificationsEnabled attribute.
void	setManagementAppletCreateEnabled(boolean enabled)	Sets the value of the ManagementAppletCreateEnabled attribute.
void	setManagementEJBEnabled(boolean enabled)	Enables the Management EJB the entire domain.
void	setPlatformMBeanServerEnabled(boolean enabled)	Sets the value of the PlatformMBeanServerEnabled attribute.
void	setPlatformMBeanServerUsed(boolean enabled)	Sets the value of the PlatformMBeanServerUsed attribute.
void	setRuntimeMBeanServerEnabled(boolean enabled)	Sets the value of the RuntimeMBeanServerEnabled attribute.

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

Methods inherited from interface weblogic.descriptor.DescriptorBean

addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preDeregister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

Method Detail

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setRuntimeMBeanServerEnabled

void setRuntimeMBeanServerEnabled(boolean enabled)

Sets the value of the RuntimeMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

isRuntimeMBeanServerEnabled()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setDomainMBeanServerEnabled

void setDomainMBeanServerEnabled(boolean enabled)

Sets the value of the DomainMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

isDomainMBeanServerEnabled()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setEditMBeanServerEnabled

void setEditMBeanServerEnabled(boolean enabled)

Sets the value of the EditMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

isEditMBeanServerEnabled()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setCompatibilityMBeanServerEnabled

void setCompatibilityMBeanServerEnabled(boolean enabled)

Sets the value of the CompatibilityMBeanServerEnabled attribute.

Parameters:

enabled - true to enable the service, false otherwise.

See Also:

isCompatibilityMBeanServerEnabled()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

isManagementEJBEnabled

boolean isManagementEJBEnabled()

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

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

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

Default Value:

true

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setManagementEJBEnabled

void setManagementEJBEnabled(boolean enabled)

Enables the Management EJB the entire domain.

Parameters:

enabled - true to enable the service, false otherwise.

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

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

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

setPlatformMBeanServerEnabled

void setPlatformMBeanServerEnabled(boolean enabled)

Sets the value of the PlatformMBeanServerEnabled attribute.

Parameters:

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

See Also:

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.

Default Value:

0

Maximum Value:

java.lang.Integer.MAX_VALUE

Minimum Value:

0

setInvocationTimeoutSeconds

void setInvocationTimeoutSeconds(int timeout)
                          throws javax.management.InvalidAttributeValueException

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

Parameters:

timeout - Invocation timeout in seconds.

Throws:

javax.management.InvalidAttributeValueException

See Also:

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.

Changes to this property take effect after you redeploy the module or restart the server. If the resource is in a partition, restart the partition.

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:

isPlatformMBeanServerUsed()

isManagedServerNotificationsEnabled

boolean isManagedServerNotificationsEnabled()

Specifies whether the WebLogic Server Domain Runtime MBean Server will support notifications from the federated Runtime MBean Servers on the managed and administration servers.

Supporting notifications requires a significant amount of memory resources. A list of ObjectNames is maintained for each MBean from the Runtime MBean Servers. If notifications are not required for this domain, then disabling them will save on CPU and memory resources. This is particularly critical if there are large numbers of runtime MBeans and/or large numbers of servers.

Default Value:

false

setManagedServerNotificationsEnabled

void setManagedServerNotificationsEnabled(boolean enabled)

Sets the value of the ManagedServerNotificationsEnabled attribute. If set to false, WebLogic Server Domain Runtime MBean Server will not support notifications for the federated Runtime MBean Servers from each managed and administration server.

Parameters:

enabled - true to enable notifications support, true otherwise.

See Also:

isManagedServerNotificationsEnabled()

isManagementAppletCreateEnabled

boolean isManagementAppletCreateEnabled()

Specifies whether the WebLogic Server MBean Servers will support creation of management applet (MLet) MBeans.

MLet MBeans allow a user to upload the MBean implementation from a remote server and should only be enabled if the environment and security manager restrict access to trusted JMX clients.

Default Value:

false

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setManagementAppletCreateEnabled

void setManagementAppletCreateEnabled(boolean enabled)

Sets the value of the ManagementAppletCreateEnabled attribute. If set to false, WebLogic Server will prevent JMX clients from creating a MLet MBean.

Parameters:

enabled - true to enable MLet support, false otherwise.

See Also:

isManagementAppletCreateEnabled()