List of provided MBeans

Liberty provides a list of MBeans and corresponding management interfaces that you can use to manipulate and monitor the server. When using an MBean Proxy, find the classes that you need to compile inside the .jar files in ${wlp.install.dir}/dev/api/ibm.

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 (*), which is described in the Comments entries in this topic.
  • The Management interface entries specify the name of the Java™ interface that can be used to construct a proxy object for the MBean or MXBean as described in Exemple d'accès aux attributs et opérations de MBean. Pour plus d'informations sur l'interface de gestion, voir le document de l'API Java pour Liberty. La documentation d'API Java de chaque API Liberty est disponible dans un fichier .zip séparé des sous-répertoires javadoc du répertoire ${wlp.install.dir}/dev.

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=jaxws,type=WebServiceStats,service=*,port=*

  • Management interface: org.apache.cxf.management.counters.ResponseTimeCounterMBean
  • Comments: Available when the monitor-1.0 feature is enabled. The WebServiceStats can be either Performance.Counter.Server or Performance.Counter.client, where service=* is the qualified name of a service endpoint, port=* is the port name of the service endpoint. See Surveillance JAX-WS.
Remarque : This is a Dynamic Model MBean.

WebSphere:feature=jaxws,type=Bus.Service.Endpoint,bus.id=*,service=*,port=*,name=*

  • Management interface: org.apache.cxf.endpoint.ManagedEndpoint
  • Comments: Available when the localConnector-1.0 or restConnector-1.0 feature is enabled and the JAX-WS application is accessed at least once. The bus.id=* is the name of the bus, where * is of the form <AppName>-Server-Bus. The service=* is the qualified name of the endpoint, where * is of the form {ServiceNamespace}ServiceName. The port=* is the port name of the endpoint, where the * is the current port name. 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>
        Par exemple, le bean géré peut se présenter comme suit :
        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"
      • Si le masque d'URL n'est pas indiqué, le nom du service est utilisé comme valeur par défaut. Par exemple, le bean géré peut se présenter comme suit :
        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
      • Si le masque d'URL ne peut pas être extrait par le moteur de services Web lorsque le noeud géré de noeud final est enregistré, un nombre aléatoire unique est utilisé pour garantir que le noeud géré est unique. Par exemple, le bean géré peut se présenter comme suit :
        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"
Remarque :
  • Il s'agit d'un bean géré de modèle dynamique.
  • L'opération destroy sur ce MBean n'est pas prise en charge.

WebSphere:feature=kernel,name=ServerInfo

  • Interface de gestion : com.ibm.websphere.kernel.server.ServerInfoMBean
  • Commentaires : L'interface ServerInfoMbean est utilisée pour extraire des informations sur le serveur en cours. Recherchez les répertoires suivants pour la classe et la documentation d'API :
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.kernel.service_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.kernel.service_version-javadoc.zip

Les opérations exposées incluent une méthode permettant d'extraire l'installation du produit et les emplacements du répertoire utilisateur, le nom d'hôte par défaut, le nom de serveur, la version de produit, la version de la spécification Java et la version Java Runtime.

[18.0.0.1 and later]

WebSphere:feature=kernel,name=ServerEndpointControl

  • Interface de gestion : com.ibm.websphere.kernel.server.ServerEndpointControlMBean
  • Commentaires : L'interface ServerEndpointControlMBean est utilisée pour mettre en pause les noeuds finaux de serveur, les réactiver et obtenir leur statut. Le bean géré étant accessible depuis le noyau, vous n'avez pas besoin d'activer une fonction spéciale. Vous trouverez la classe du bean géré et la documentation de l'API aux emplacements suivants :
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.kernel.service_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.kernel.service_version-javadoc.zip

Pour obtenir une liste des types de noeuds finaux que vous pouvez mettre en pause, voir Mettre en pause et reprendre un serveur Liberty à partir de la ligne de commande.

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

  • Interface de gestion : com.ibm.websphere.filetransfer.FileServiceMXBean
  • Commentaires : Ce MXBean permet d'effectuer diverses opérations liées aux fichiers sur l'hôte sur lequel se trouve Liberty.
    Vous trouverez sa classe et la documentation de l'API aux emplacements suivants :
    liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_version.jar
    liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector_version-javadoc.zip

    Les opérations exposées incluent la capacité à interroger certaines métadonnées (la date de dernière modification, la taille, etc.) d'un fichier ou répertoire donné, ainsi que d'interroger tous les fichiers enfant (et les métadonnées correspondantes) d'un répertoire donné. La prise en charge de la création et de la décompression d'archive est également fournie, ce qui peut être utile pour compresser des fichiers journaux Liberty ou pour extraire une application avant de la déployer.

    Ce MXBean contient deux attributs : la liste de lecture et la liste d'écriture. Il s'agit de la liste des emplacements où les utilisateurs disposent d'un accès en lecture et écriture lors de l'utilisation des fonctionnalités FileService ou FileTransfer fournies par Liberty. Via le MXBean, ces attributs ne sont accessibles qu'en lecture, mais vous pouvez les configurer et les personnaliser par le biais des éléments suivants dans le fichier server.xml :
    <remoteFileAccess>
      	<readDir>${server.output.dir}/logs</readDir>
      	<readDir>${server.output.dir}/apps</readDir>
      	<writeDir>${server.output.dir}/dropins</writeDir>
    </remoteFileAccess>
    Si l'élément readDir n'est pas spécifié, la valeur par défaut est la combinaison de ${wlp.install.dir}, ${wlp.user.dir} et ${server.output.dir}. Si aucun élément writeDir n'est spécifié, la valeur par défaut est l'ensemble vide.

    La fonction restConnector-1.0 doit être incluse dans le fichier server.xml pour que ce MXBean soit chargé et que ses éléments de configuration soient appliqués.

    L'utilisation de variables définies par Liberty est autorisée avec tous les paramètres côté serveur qui admettent une chaîne représentant un chemin de fichier. Ces variables sont définies dans le fichier rép_base_liberty/README.TXT.

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

  • Interface de gestion : com.ibm.websphere.filetransfer.FileTransferMBean
  • Commentaires : Ce bean géré permet d'exécuter diverses opérations de transfert de fichier sur l'hôte sur lequel se trouve Liberty.
    Vous trouverez sa classe et la documentation de l'API aux emplacements suivants :
    liberty_home/dev/api/ibm/com.ibm.websphere.appserver.api.restConnector_version.jar
    liberty_home/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.restConnector_version-javadoc.zip

    Ce bean géré est enregistré sur PlatformMBeanServer à partir de la même machine virtuelle Java que son processus Liberty correspondant, mais il n'est accessible que via le connecteur IBM® JMX REST. La connexion peut être locale ou distante, mais dans tous les cas, le connecteur REST doit être utilisé.

    Les opérations exposées incluent la capacité de télécharger, télécharger en amont et supprimer un fichier. Chaque demande de lecture et d'écriture sur le serveur est liée aux listes de lecture et d'écriture configurables accessibles via FileServiceMXBean. FileTransferMBean est également accessible et peut être utilisé depuis la console Java intégrée JConsole, à condition que celle-ci soit connectée via le connecteur IBM JMX REST.

    L'utilisation de variables définies par Liberty est autorisée avec tous les paramètres côté serveur qui admettent une chaîne représentant un chemin de fichier. Ces variables sont définies dans le fichier rép_base_liberty/README.TXT.

WebSphere:feature=wasJmsServer,type=MessagingEngine,name=*

  • Interface de gestion : com.ibm.websphere.messaging.mbean.MessagingEngineMBean
  • Commentaires : Disponible lorsque la fonction wasJmsServer-1.0 est activée. Une instance de moteur de messagerie est disponible pour chaque serveur Liberty. name=* est le nom du bean géré, où * est le nom unique du bean géré de moteur de messagerie. Voir Messagerie JMS.

WebSphere:feature=wasJmsServer,type=Queue,name=*

  • Interface de gestion : com.ibm.websphere.messaging.mbean.QueueMBean
  • Commentaires : Le bean géré est disponible lorsque la fonction wasJmsServer-1.0 est activée et que le bean géré du moteur de messagerie est disponible. name=* est le nom du bean géré, où * est le nom du bean géré de file d'attente. Voir Messagerie JMS.

WebSphere:feature=wasJmsServer,type=Subscriber,name=*

  • Interface de gestion : com.ibm.websphere.messaging.mbean.SubscriberMBean
  • Commentaires : Le bean géré est disponible lorsque la fonction wasJmsServer-1.0 est activée et que le bean géré du moteur de messagerie est disponible. name=* est le nom du bean géré, où * est le nom du bean géré d'abonné courant.
    Remarque : SubscriberMBean est un abonné au bean géré de rubrique TopicMBean existant. Voir Messagerie JMS.

WebSphere:feature=wasJmsServer,type=Topic,name=*

  • Interface de gestion : com.ibm.websphere.messaging.mbean.TopicMBean
  • Commentaires : Le bean géré est disponible lorsque la fonction wasJmsServer-1.0 est activée et que le bean géré du moteur de messagerie est disponible. name=* est le nom du bean géré, où * est le nom du bean géré de rubrique. Voir Messagerie JMS.

WebSphere:name=com.ibm.websphere.config.mbeans.ServerXMLConfigurationMBean

  • Interface de gestion : com.ibm.websphere.config.mbeans.ServerXMLConfigurationMBean
  • Commentaires : L'élément ServerXMLConfigurationMBean fournit une interface pour l'extraction des chemins de fichier de tous les fichiers de configuration du serveur connus du serveur. Le bean géré étant accessible depuis le noyau, vous n'avez pas besoin d'activer une fonction spéciale. Vous trouverez la classe du bean géré et la documentation de l'API aux emplacements suivants :
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

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

  • Interface de gestion : com.ibm.websphere.runtime.update.RuntimeUpdateNotificationMBean
  • Commentaires : L'élément RuntimeUpdateNotificationMBean fournit des notifications pour les mises à jour d'exécution de serveur. L'objet de données utilisateur associé à la notification est un élément java.util.Map. Le type de notification pour les notifications de mise à jour d'exécution émises par ce bean géré est le suivant : com.ibm.websphere.runtime.update.notification.

WebSphere:name=com.ibm.ws.config.mbeans.FeatureListMBean

  • Interface de gestion : com.ibm.websphere.config.mbeans.FeatureListMBean
  • Commentaires : L'élément FeatureListMBean expose une seule méthode pour générer un rapport XML sur toutes les fonctions installées lors de l'exécution. Le bean géré étant accessible depuis le noyau, vous n'avez pas besoin d'activer une fonction spéciale. Vous trouverez la classe du bean géré et la documentation de l'API aux emplacements suivants :
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

WebSphere:name=com.ibm.ws.config.serverSchemaGenerator

  • Interface de gestion : com.ibm.websphere.config.mbeans.ServerSchemaGenerator
  • Commentaires : Le bean géré ServerSchemaGenerator MBean expose des méthodes pour générer un schéma à partir de l'image installée, la plupart du temps, ou à partir d'une exécution en cours. Le bean géré étant accessible depuis le noyau, vous n'avez pas besoin d'activer une fonction spéciale. Vous trouverez la classe du bean géré et la documentation de l'API aux emplacements suivants :
    • ${wlp.install.dir}/dev/api/ibm/com.ibm.websphere.appserver.api.config_version.jar
    • ${wlp.install.dir}/dev/api/ibm/javadoc/com.ibm.websphere.appserver.api.config_version-javadoc.zip

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

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

  • Interface de gestion : com.ibm.websphere.application.ApplicationMBean
  • Commentaires : Une instance est disponible pour chaque application sur le système, où * est un nom d'application unique.

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

  • Interface de gestion : com.ibm.websphere.webcontainer.WebModuleMBean
  • Commentaires : Une instance est disponible pour chaque module Web dans le système, où application=* est le nom d'une application dans le système et name=* est le nom d'un module Web dans cette application.

WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,*

  • Interface de gestion :com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean
  • Commentaires : Une instance est disponible pour chaque gestionnaire de connexion dans le système, y compris ceux ayant été créés dans les contextes suivants :
    • Lorsque configurés explicitement dans la configuration du serveur
    • Lorsque créés implicitement en raison des annotations @DataSourceDefinition ou @ConnectionFactoryDefinition
    • Lorsque créés comme résultat d'une fabrique de connexions ou de source de données dans la configuration du serveur
    L'instance mbean n'est pas disponible tant que la fabrique de connexions ou la source de données correspondante n'est pas utilisée pour la première fois.
    Pour limiter l'instance du gestionnaire de connexions, vous pouvez spécifier des attributs supplémentaires, comme illustré dans les exemples suivants :
    WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,jndiName=jdbc/db2,*
    WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,name=jmsConnectionFactory[cf1]/connectionManager[default-0],*
    WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,name=databaseStore[dbstore1]/dataSource[default-0]/connectionManager,*
    WebSphere:type=com.ibm.ws.jca.cm.mbean.ConnectionManagerMBean,jndiName=java.module/env/jdbc/ds3,application=MyApp,module=myweb,*

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

  • Interface de gestion : com.ibm.websphere.filemonitor.FileNotificationMBean

WebSphere:type=JvmStats

WebSphere:type=ServletStats,name=*

  • Interface de gestion : com.ibm.websphere.webcontainer.ServletStatsMXBean
  • Commentaires : Lorsque la fonction monitor-1.0 est activée, une instance est disponible pour chaque servlet traité, où * suit le format <nom_application>.<nom_servlet>. Voir surveillance des applications Web.

WebSphere:type=ThreadPoolStats,name=Default Executor

  • Interface de gestion : com.ibm.websphere.monitor.jmx.ThreadPoolMXBean
  • Commentaires : Disponible lorsque la fonction monitor-1.0 est activée. Voir Surveillance ThreadPool.

Icône indiquant le type de rubrique Rubrique de référence

Nom du fichier : rwlp_mbeans_list.html