Liberty profile: List of provided MBeans

Note: The collectiveController-1.0 feature and its capabilities are available only in WebSphere® Application Server Liberty Network Deployment and WebSphere Application Server Liberty for z/OS®. The feature is not available in WebSphere Application Server Liberty, WebSphere Application Server Liberty - Express®, or WebSphere Application Server Liberty Core. If you have a WebSphere Application Server Liberty Network Deployment installation, you can use its collectiveController-1.0 feature to work with collective members from WebSphere Application Server Liberty, WebSphere Application Server Liberty - Express, or WebSphere Application Server Liberty Core installations.

See Liberty profile: Example of setting up a JMX routing environment for more information.

The getServerStatus operation allows you to get the status of a member server in a collective by providing its hostname, server's user directory, and server name. You can subscribe for server up or down changes by calling addNotificationListener. An AttributeChangeNotification is sent to all listeners when any server in the collective changes its state. The hostname, server's user directory, and server name are stored as a comma-separated string in the message for identification purposes.

All parameters are explained in detail in the API documentation.

Note: The collectiveController-1.0 feature and its capabilities are available only in WebSphere Application Server Liberty Network Deployment and WebSphere Application Server Liberty for z/OS. The feature is not available in WebSphere Application Server Liberty, WebSphere Application Server Liberty - Express, or WebSphere Application Server Liberty Core. If you have a WebSphere Application Server Liberty Network Deployment installation, you can use its collectiveController-1.0 feature to work with collective members from WebSphere Application Server Liberty, WebSphere Application Server Liberty - Express, or WebSphere Application Server Liberty Core installations.

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.

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

The restConnector-1.0 feature must be included in the server.xml file 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.

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 by 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 that are 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.

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.

The format of the MBean is as follows: <BUS>@<SERVICE>@<PORT>@<URL_PATTERN>, where:

• <BUS> is the same value as the field bus.id;
• <SERVICE> is the same value as the field service;
• <PORT> is the same value as the field port;
• <URL_PATTERN> might be the following values in different scenarios;
  • If the url-pattern element is defined in the web.xml file of your application, the value of url-pattern element is used. For example, the url-pattern element is /SayHelloURL in the web.xml file:

    <servlet-mapping>
        <servlet-name>com.ibm.ws.jaxws.test.jmx.service.WSTestEndpointService</servlet-name>
        <url-pattern>/SayHelloURL</url-pattern>
    </servlet-mapping>

    For example, the MBean might be as follows:

    WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
    service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
    name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@SayHelloURL"

  • If the URL pattern is not specified, the service name is used as the default value. For example, the MBean might be as follows:

    WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
    service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
    name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@SayHelloService

  • If the URL pattern cannot be retrieved by the web services engine when the endpoint MBean is registered, a random unique number is used to ensure that the MBean is unique. For example, the MBean might be as follows:

    WebSphere:feature=jaxws,bus.id=EJBWSBasic-Server-Bus,type=Bus.Service.Endpoint,
    service="{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService",port="SayHelloPort",
    name="EJBWSBasic-Server-Bus@{http://ejbbasic.jaxws.ws.ibm.com/}SayHelloService@SayHelloPort@261689241"