All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.ow2.jonas.server.mbeans-descriptors.xml Maven / Gradle / Ivy

The newest version!
<?xml version="1.0"?>
<!DOCTYPE mbeans-descriptors PUBLIC
 "-//Apache Software Foundation//DTD Model MBeans Configuration File"
 "http://jakarta.apache.org/commons/dtds/mbeans-descriptors.dtd">

<!--
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - JOnAS: Java(TM) Open Application Server
    - Copyright (C) 1999 Bull S.A.
    - Contact: [email protected]
    -
    - This library is free software; you can redistribute it and/or
    - modify it under the terms of the GNU Lesser General Public
    - License as published by the Free Software Foundation; either
    - version 2.1 of the License, or any later version.
    -
    - This library is distributed in the hope that it will be useful,
    - but WITHOUT ANY WARRANTY; without even the implied warranty of
    - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    - Lesser General Public License for more details.
    -
    - You should have received a copy of the GNU Lesser General Public
    - License along with this library; if not, write to the Free Software
    - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
    - USA
    -
    - Initial developer(s): Michel-Ange Anton
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    - $Id: mbeans-descriptors.xml 12246 2007-12-09 21:42:38Z benoitf $
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-->

<mbeans-descriptors>

    <!-- J2EE Server =============================================================== -->
    <mbean name="J2EEServer"
        className="org.ow2.jonas.server.J2EEServerMBean"
        description="J2EEServer Component" domain="JOnAS" group="J2EEManaged"
        type="org.ow2.jonas.server.J2EEServer">

        <attribute name="eventProvider"
            description="Event provider support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="objectName" description="Name of the object"
            type="java.lang.String" writeable="false" />

        <attribute name="stateManageable"
            description="State management support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="statisticsProvider"
            description="Performance statistics support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="serverName" description="JOnAS server name"
            type="java.lang.String" writeable="false" />

        <attribute name="serverVendor" description="JOnAS server vendor"
            type="java.lang.String" writeable="false" />

        <attribute name="serverVersion"
            description="JOnAS server version" type="java.lang.String"
            writeable="false" />

        <attribute name="jonasBase"
            description="jonas.base environment property" type="java.lang.String"
            writeable="false" />

        <attribute name="deployedObjects"
            description="The list of MBean names corresponding to the deployed J2EEModules and J2EEApplications"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="protocols"
            description="Protocols supported by this Server"
            type="java.lang.String" writeable="false" />

        <attribute name="resources"
            description="The list of MBean names corresponding to the resources available on this server"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="javaVMs"
            description="The list of MBean names corresponding to the JVMs on which this server has running threads"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="versions" description="VERSIONS file content"
            type="java.lang.String" writeable="false" />

        <!-- Monitoring attributes -->

        <attribute name="currentUsedMemory"
            description="JVM free memory" type="long" writeable="false" />

        <attribute name="currentTotalMemory"
            description="JVM total memory" type="long" writeable="false" />

        <attribute name="range"
            description="For free memory measurement" type="int" />

        <attribute name="sizeTableMeasures"
            description="The size of the table of measures" type="int" />

        <attribute name="activated" description="Monitoring activation"
            is="true" type="boolean" />

        <attribute name="tableMeasures"
            description="The table of values" type="[Ljava.lang.Long;"
            writeable="false" />

        <operation name="deployJar"
            description="Deploy a stand-alone J2EE module packaged in a JAR file"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName"
                description="Name of the JAR file" type="java.lang.String" />
        </operation>

        <operation name="unDeployJar"
            description="Undeploy a stand-alone J2EE module" impact="ACTION"
            returnType="void">
            <parameter name="fileName"
                description="Name of the JAR file" type="java.lang.String" />
        </operation>

        <operation name="getDeployableJars"
            description="Return the list of installed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getDeployedJars"
            description="Return the list of deployed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getJarsDirectory"
            description="The WebApps directory" impact="ACTION"
            returnType="java.lang.String">
        </operation>

        <operation name="deployEar"
            description="Deploy a J2EE application packaged in a EAR file"
            impact="ACTION" returnType="String">
            <parameter name="fileName"
                description="Name of the EAR file" type="java.lang.String" />
        </operation>

        <operation name="isEarDeployed"
            description="Test if the specified EAR file is loaded" impact="INFO"
            returnType="Boolean">
            <parameter name="fileName"
                description="Name of the EAR file" type="java.lang.String" />
        </operation>

        <operation name="unDeployEar"
            description="Undeploy a J2EE application" impact="ACTION"
            returnType="void">
            <parameter name="fileName"
                description="Name of the EAR file" type="java.lang.String" />
        </operation>

        <operation name="getDeployableEars"
            description="Return the list of installed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getDeployedEars"
            description="Return the list of deployed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getAppsDirectory"
            description="The WebApps directory" impact="ACTION"
            returnType="java.lang.String">
        </operation>

        <operation name="deployWar"
            description="Deploy a J2EE application packaged in a WAR file"
            impact="ACTION" returnType="void">
            <parameter name="fileName"
                description="Name of the WAR file" type="java.lang.String" />
        </operation>

        <operation name="isWarDeployed"
            description="Test if the specified WAR file is loaded" impact="INFO"
            returnType="Boolean">
            <parameter name="fileName"
                description="Name of the WAR file" type="java.lang.String" />
        </operation>

        <operation name="unDeployWar"
            description="Undeploy a J2EE application" impact="ACTION"
            returnType="void">
            <parameter name="fileName"
                description="Name of the WAR file" type="void" />
        </operation>

        <operation name="getDeployableWars"
            description="Return the list of installed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getDeployedWars"
            description="Return the list of deployed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getWarsDirectory"
            description="The WebApps directory" impact="ACTION"
            returnType="java.lang.String">
        </operation>

        <operation name="getDeployableRars"
            description="Return the list of installed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getDeployedRars"
            description="Return the list of deployed web applications ready to deploy"
            impact="ACTION" returnType="java.util.List">
        </operation>

        <operation name="getRarsDirectory"
            description="The WebApps directory" impact="ACTION"
            returnType="java.lang.String">
        </operation>

        <operation name="deployRar"
            description="Deploy a J2EE application packaged in a RAR file"
            impact="ACTION" returnType="String">
            <parameter name="fileName"
                description="Name of the RAR file" type="java.lang.String" />
        </operation>

        <operation name="isRarDeployed"
            description="Test if the specified RAR file is loaded" impact="INFO"
            returnType="Boolean">
            <parameter name="fileName"
                description="Name of the RAR file" type="java.lang.String" />
        </operation>

        <operation name="isJarDeployed"
            description="Test if the specified JAR file is loaded" impact="INFO"
            returnType="java.lang.Boolean">
            <parameter name="fileName"
                description="Name of the JAR file" type="java.lang.String" />
        </operation>

        <operation name="unDeployRar"
            description="Undeploy a J2EE application" impact="ACTION"
            returnType="void">
            <parameter name="fileName"
                description="Name of the RAR file" type="java.lang.String" />
        </operation>

        <operation name="sendFile"
            description="Send a file into JOnAS BASE" impact="ACTION"
            returnType="String">
            <parameter name="type"
                description="Binary content of the file" type="[B" />
            <parameter name="type" description="Name of the file"
                type="java.lang.String" />
            <parameter name="type" description="Replace existing file ?"
                type="boolean" />
        </operation>

        <operation name="removeModuleFile"
            description="Remove a J2EE module file into JOnAS BASE"
            impact="ACTION" returnType="boolean">
            <parameter name="type" description="Name of the file"
                type="java.lang.String" />
        </operation>

        <operation name="deployFile"
            description="Dump and Deploy the given to JOnAS filesystem"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
            <parameter name="fileContent"
                description="File binary content" type="[B" />
        </operation>

        <operation name="dumpFile" description="Dump the given file"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
            <parameter name="fileContent"
                description="File binary content" type="[B" />
        </operation>

        <operation name="deploy" description="Deploy a Java EE module"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName"
                description="Path to the Java EE module" type="java.lang.String" />
        </operation>

        <operation name="undeploy" description="Uneploy a Java EE module"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName"
                description="Path to the Java EE module" type="java.lang.String" />
        </operation>

        <operation name="deployFile" description="JSR 88 deploy"
            impact="ACTION" returnType="String">
            <parameter name="type" description="Type of the file"
                type="int" />
            <parameter name="bfile" description="File binary content"
                type="[Ljava.lang.Byte;" />
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
            <parameter name="genicArgs" description="Options for Genic"
                type="[Ljava.lang.String;" />
            <parameter name="moveIntoDeployableDirectory"
                description="true to copy the file into the deployable JOnAS_BASE directory"
                type="boolean" />
        </operation>

        <operation name="wsgenLocalFile"
            description="Apply WsGen on the specified archive" impact="ACTION"
            returnType="java.lang.String">
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
            <parameter name="unpacked"
                description="true if the result must be unpacked"
                type="java.lang.Boolean" />
        </operation>

        <!-- Monitoring operations -->

        <operation name="stop" description="Stop server" impact="ACTION"
            returnType="void">
        </operation>

        <operation name="runGC" description="Run the garbage collector"
            impact="ACTION" returnType="void">
        </operation>
        <operation name="getSystemProperty"
            description="Find system property. return default value if not found"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="key" description="Property key"
                type="java.lang.String" />
            <parameter name="defaultVal"
                description="Default value to return if not found"
                type="java.lang.String" />
        </operation>
        <operation name="getSystemProperty"
            description="Find system property. return Null if not found"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="key" description="Property key"
                type="java.lang.String" />
        </operation>

        <operation name="getSystemProperties"
            description="Find system property. return Null if not found"
            impact="ACTION" returnType="java.lang.List">
            <parameter name="keys" description="Keys list"
                type="java.lang.List" />
        </operation>

    </mbean>

    <!-- JVM ======================================================================= -->
    <mbean name="JVM" description="JVM Component" domain="JOnAS"
        group="J2EEManaged" type="org.ow2.jonas.server.JavaVm">

        <attribute name="eventProvider"
            description="Event provider support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="javaVendor"
            description="The Java Runtime Environnement vendor"
            type="java.lang.String" writeable="false" />

        <attribute name="javaVersion"
            description="The Java Runtime Environnement version"
            type="java.lang.String" writeable="false" />

        <attribute name="node"
            description="The node (machine) this JVM is running on"
            type="java.lang.String" writeable="false" />

        <attribute name="objectName" description="Name of the object"
            type="java.lang.String" writeable="false" />

        <attribute name="stateManageable"
            description="State management support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="statisticsProvider"
            description="Performance statistics support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="allThreadsCount"
            description="The number of active threads in the JVM" type="int"
            writeable="false" />

        <attribute name="threadGroups"
            description="List of names of all thread groups"
            type="[Ljava.lang.String;" writeable="false" />

        <operation name="listThreads"
            description="Get the list of thread names for a thread group"
            impact="ACTION" returnType="[Ljava.lang.String;">
            <parameter name="threadgroupname"
                description="Name of the thread group" type="java.lang.String" />
        </operation>
    </mbean>


    <!-- J2EEDomain ======================================================================= -->
    <mbean name="J2EEDomain" description="J2EEDomain Component"
        domain="JOnAS" group="J2EEManaged"
        type="org.ow2.jonas.lib.management.J2EEDomain">

        <!-- JSR77 -->

        <attribute name="eventProvider"
            description="Event provider support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="objectName" description="Name of the object"
            type="java.lang.String" writeable="false" />

        <attribute name="stateManageable"
            description="State management support for this managed object"
            is="true" type="boolean" writeable="false" />

        <attribute name="statisticsProvider"
            description="Performance statistics support for this managed object"
            is="true" type="boolean" writeable="false" />

        <!-- JSR77 J2EEDomain -->

        <attribute name="servers"
            description="The list of MBean names corresponding to the J2EEServers in the domain"
            type="[Ljava.lang.String;" writeable="false" />

        <!-- JOnAS Domain Management -->

        <attribute name="startedServers"
            description="The list of MBean names corresponding to the running J2EEServers in the domain"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="serverNames"
            description="The list of names corresponding to the servers in the domain"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="clusters"
            description="The list of MBean names corresponding to the clusters in the domain"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="clusterDaemons"
            description="The list of MBean names corresponding to the clusterDaemons in the domain"
            type="[Ljava.lang.String;" writeable="false" />

        <attribute name="description"
            description="The domain description" type="java.lang.String"
            writeable="false" />

        <attribute name="master"
            description="true if the current server is a master" is="true"
            type="boolean" writeable="false" />

        <attribute name="myName"
            description="Domain name or cluster name if this is a cluster"
            type="java.lang.String" writeable="false" />

        <operation name="createCluster"
            description="Create a cluster in the management domain"
            impact="ACTION" returnType="String">
            <parameter name="clusterName" description="cluster name"
                type="java.lang.String" />
        </operation>

        <operation name="getErrorMessage"
            description="Get the error message" impact="ACTION"
            returnType="[Ljava.lang.String;">
            <parameter name="fileName"
                description="Name of the file to deploy" type="java.lang.String" />
            <parameter name="serverName"
                description="Name of the server where the file is deployed"
                type="java.lang.String" />
        </operation>

        <operation name="getServersInCluster"
            description="Get the list of servers that are in a given cluster"
            impact="ACTION" returnType="[Ljava.lang.String;">
            <parameter name="clusterName"
                description="Name of the cluster" type="java.lang.String" />
        </operation>

        <operation name="getServerState"
            description="Get the state of a server in the domain" impact="ACTION"
            returnType="String">
            <parameter name="serverName"
                description="Name of the server" type="java.lang.String" />
        </operation>

        <operation name="getClusterState"
            description="Get the state of a cluster in the domain"
            impact="ACTION" returnType="String">
            <parameter name="clusterName"
                description="Name of the cluster" type="java.lang.String" />
        </operation>

        <operation name="getClusterdaemonState"
            description="Get the state of a cluster daemon in the domain"
            impact="ACTION" returnType="String">
            <parameter name="clusterdaemonName"
                description="Name of the cluster daemon" type="java.lang.String" />
        </operation>

        <operation name="getClusterType"
            description="Get the type of a cluster in the domain" impact="ACTION"
            returnType="String">
            <parameter name="clusterName"
                description="Name of the cluster" type="java.lang.String" />
        </operation>

        <operation name="getServerClusterdaemon"
            description="Get the cluster daemon name of a server in the domain"
            impact="ACTION" returnType="String">
            <parameter name="serverName"
                description="Name of the server" type="java.lang.String" />
        </operation>

        <operation name="getServersNotInCluster"
            description="Get the list of servers that are not in a given cluster"
            impact="ACTION" returnType="[Ljava.lang.String;">
            <parameter name="clusterName"
                description="Name of the cluster" type="java.lang.String" />
        </operation>

        <operation name="deployJar"
            description="Deploy a JAR file on a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the JAR file to deploy on the target"
                type="java.lang.String" />
        </operation>

        <operation name="unDeployJar"
            description="Undeploy a JAR file from a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the JAR file" type="java.lang.String" />
        </operation>

        <operation name="deployWar"
            description="Deploy a WAR file on a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the WAR file to deploy on the target"
                type="java.lang.String" />
        </operation>

        <operation name="unDeployWar"
            description="Undeploy a WAR file from a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the WAR file" type="java.lang.String" />
        </operation>

        <operation name="deployRar"
            description="Deploy a RAR file on a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the RAR file to deploy on the target"
                type="java.lang.String" />
        </operation>

        <operation name="unDeployRar"
            description="Undeploy a RAR file from a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the RAR file" type="java.lang.String" />
        </operation>

        <operation name="deployEar"
            description="Deploy a EAR file on a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the EAR file to deploy on the target"
                type="java.lang.String" />
        </operation>

        <operation name="unDeployEar"
            description="Undeploy a EAR file from a management target"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the EAR file" type="java.lang.String" />
        </operation>

        <operation name="uploadFile" description="Upload a new file"
            impact="ACTION" returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the file to upload" type="java.lang.String" />
            <parameter name="replaceExisting"
                description="Replace the file on the target server with the same name"
                type="boolean" />
        </operation>

        <operation name="uploadDeployEar"
            description="Upload a new EAR file and (re)deploy it" impact="ACTION"
            returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the EAR file" type="java.lang.String" />
            <parameter name="replaceExisting"
                description="Replace the file on the target server with the same name"
                type="boolean" />
        </operation>

        <operation name="uploadDeployRar"
            description="Upload a new RAR file and (re)deploy it" impact="ACTION"
            returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the RAR file" type="java.lang.String" />
            <parameter name="replaceExisting"
                description="Replace the file on the target server with the same name"
                type="boolean" />
        </operation>

        <operation name="uploadDeployWar"
            description="Upload a new WAR file and (re)deploy it" impact="ACTION"
            returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the WAR file" type="java.lang.String" />
            <parameter name="replaceExisting"
                description="Replace the file on the target server with the same name"
                type="boolean" />
        </operation>

        <operation name="uploadDeployJar"
            description="Upload a new JAR file and (re)deploy it" impact="ACTION"
            returnType="void">
            <parameter name="target"
                description="J2EEServer ObjectNames of servers in the target"
                type="[Ljava.lang.String;" />
            <parameter name="fileName"
                description="Name of the JAR file" type="java.lang.String" />
            <parameter name="replaceExisting"
                description="Replace the file on the target server with the same name"
                type="boolean" />
        </operation>

        <operation name="getDeployServers"
            description="Get the list of servers where a file is being deployed"
            impact="ACTION" returnType="[Ljava.lang.String;">
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
        </operation>

        <operation name="getDeployState"
            description="Get the current state of deployment operation"
            impact="ACTION" returnType="java.lang.String">
            <parameter name="fileName" description="Name of the file"
                type="java.lang.String" />
            <parameter name="serverName"
                description="Name of the target server" type="java.lang.String" />
        </operation>

        <operation name="startServer"
            description="Ask cluster daemon to start a server" impact="ACTION"
            returnType="void">
            <parameter name="serverName"
                description="Server to start name" type="java.lang.String" />
        </operation>

        <operation name="stopServer"
            description="Ask cluster daemon to stop a server" impact="ACTION"
            returnType="void">
            <parameter name="serverName"
                description="Server to start name" type="java.lang.String" />
        </operation>

        <operation name="forgetAllDeploy"
            description="Forget all deploy information" impact="ACTION"
            returnType="void">
        </operation>

    </mbean>

    <!-- WorkManager ======================================================================= -->
    <mbean name="WorkManager" description="WorkManager Component"
        domain="JOnAS" group="JonasManaged"
        type="org.ow2.jonas.workmanager.internal.JWorkManager">

        <attribute name="currentPoolSize"
            description="Current number of threads in the pool" type="int"
            writeable="false" />

        <attribute name="minPoolSize"
            description="Minimum number of threads in the pool" type="int"
            writeable="true" />

        <attribute name="maxPoolSize"
            description="Maximum number of threads in the pool" type="int"
            writeable="true" />
    </mbean>



</mbeans-descriptors>




© 2015 - 2025 Weber Informatics LLC | Privacy Policy