List of provided MBeans

Liberty profile provides a list of MBeans and corresponding management interfaces we can leverage to manipulate and monitor the server.

For each MBean or MXBean in the list:

• The name is the javax.management.ObjectName value that uniquely identifies the MBean or MXBean.

  When there are multiple instances of an MBean or MXBean, the ObjectName value can contain a wildcard (*).

• The Management interface entries specify the name of the Java interface used to construct a proxy object for the MBean or MXBean.

WebSphere:feature=channelfw,type=endpoint,name=*

• Management interface: com.ibm.websphere.endpoint.EndPointInfoMBean

• Comments: One instance is available for each endpoint in the system, where * is a unique endpoint name.

WebSphere:feature=restConnector,type=FileService,name=FileService

• Management interface: com.ibm.websphere.filetransfer.FileServiceMXBean

• Comments: This MXBean enables us to perform various file-related operations on the host where Liberty resides.

  We can find its class and API documentation in the following locations:

  liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_1.0.0.jar
  liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector-javadoc.zip

  The exposed operations include the ability to query certain metadata (last modified date, size, and so on) for a given file or directory and also to query all child files (and corresponding metadata) for a given directory. Support for archive creation and expansion is also provided, which can be useful to compress Liberty log files or to extract an application before deploying it.

  This MXBean contains two attributes: the read list and the write list. They represent the lists of locations that users can read or write to when using the FileService or FileTransfer capabilities provided by Liberty. Through the MXBean, these attributes can only be read, but they can be configured or customized through the following elements in server.xml:

  <remoteFileAccess>
     <readDir>${server.output.dir}/logs</readDir>
     <readDir>${server.output.dir}/apps</readDir>
     <writeDir>${server.output.dir}/dropins</writeDir>
  </remoteFileAccess>

  If the readDir element is not specified, the default is the combination of: ${wlp.install.dir}, ${wlp.user.dir}, and ${server.output.dir}. If a writeDir element is not specified, the default is the empty set.

  The restConnector-1.0 feature must be included in server.xml in order for this MXBean to be loaded and to honour its configuration elements

  Using Liberty-defined variables is allowed with all the server-side parameters that take a string representing a file path. Such variables are defined on the liberty_home/README.TXT file.

WebSphere:feature=restConnector,type=FileTransfer,name=FileTransfer

• Management interface: com.ibm.websphere.filetransfer.FileTransferMBean

• Comments: This MBean allows you to perform various file-transfer operations on the host where Liberty resides.

  We can find its class and API documentation in the following locations:

  liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_1.0.0.jar
  liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector-javadoc.zip

  This MBean is registered on the PlatformMBeanServer from the same JVM that its corresponding Liberty process is running, but it can be accessed only using the IBM JMX REST Connector. The connection can be local or remote, but the REST Connector must be used.

  The exposed operations include the ability to download, upload, and delete a file. Each read and write request on the server is bound to the configurable read and write lists accessed through the FileServiceMXBean. The FileTransferMBean can also be fully accessed and operated from the built-in Java JConsole, provided that the JConsole is connected through the IBM JMX REST Connector.

  Use Liberty-defined variables is allowed with all the server-side parameters that take a string representing a file path. Such variables are defined on the liberty_home/README.TXT file.

WebSphere:name=com.ibm.websphere.runtime.update.RuntimeUpdateNotificationMBean

• Management interface: com.ibm.websphere.runtime.update.RuntimeUpdateNotificationMBean

• Comments: The RuntimeUpdateNotificationMBean provides notifications for server runtime updates. The user data object attached to the notification is a java.util.Map. The notification type for runtime update notifications emitted by this MBean is com.ibm.websphere.runtime.update.notification.

WebSphere:name=com.ibm.ws.jmx.mbeans.generatePluginConfig

• Management interface: com.ibm.websphere.webcontainer.GeneratePluginConfigMBean

• Comments: See Configure a web server plug-in .

WebSphere:service=com.ibm.ws.kernel.filemonitor.FileNotificationMBean

• Management interface: com.ibm.websphere.filemonitor.FileNotificationMBean

WebSphere:service=com.ibm.websphere.application.ApplicationMBean,name=*

• Management interface: com.ibm.websphere.application.ApplicationMBean

• Comments: One instance is available for each application in the system, where * is a unique application name.

WebSphere:type=JvmStats

• Management interface: com.ibm.websphere.monitor.jmx.JvmMXBean

• Comments: Available when the monitor-1.0 feature is enabled.

WebSphere:type=ServletStats,name=*

• Management interface: com.ibm.websphere.webcontainer.ServletStatsMXBean

• Comments: When the monitor-1.0 feature is enabled, one instance is available for each servlet that has been served, where * is of the form...
  <AppName>.<ServletName>

WebSphere:type=ThreadPoolStats,name=Default Executor

• Management interface: com.ibm.websphere.monitor.jmx.ThreadPoolMXBean

• Comments: Available when the monitor-1.0 feature is enabled.

Parent topic: Work with JMX MBeans

Concepts:

Examples of accessing MBean attributes
Collective architecture
File transfer in a Liberty collective
Collective security
File transfer
Liberty collective troubleshooting

Tasks:

Set the default host name of a Liberty server
Configure a Liberty collective
Register host computers with a Liberty collective
Set the JAVA_HOME variable for Liberty collective members
Configure Liberty collective replica sets

Reference:

Example of setting up a JMX routing environment
Apache CXF
Overriding Liberty server host information