org.objectweb.jonas.cluster.daemon
Interface ClusterDaemonMBean

All Known Implementing Classes:
ClusterDaemon

public interface ClusterDaemonMBean

Defines the MBean interface. Don't use Models MBeans as it will imply some external libraries like commons-modeler (easier).

Author:
Benoit Pelletier

Method Summary
 void addServer(java.lang.String name, java.lang.String description, java.lang.String javaHome, java.lang.String jonasRoot, java.lang.String jonasBase, java.lang.String xprm, java.lang.String autoBoot, java.lang.String jonasCmd)
          Add a server configuration
 java.lang.String getAutoBoot4Server(java.lang.String name)
           
 java.lang.String getJavaHome4Server(java.lang.String name)
           
 java.lang.String getJonasBase4Server(java.lang.String name)
           
 java.lang.String getJonasCmd4Server(java.lang.String name)
           
 java.lang.String getJonasRoot4Server(java.lang.String name)
           
 java.lang.String getobjectName()
           
 java.lang.String getServersList()
           
 java.lang.String getXprm4Server(java.lang.String name)
           
 boolean iseventProvider()
           
 boolean isstateManageable()
           
 boolean isstatisticsProvider()
           
 void modifyServer(java.lang.String name, java.lang.String description, java.lang.String javaHome, java.lang.String jonasRoot, java.lang.String jonasBase, java.lang.String xprm, java.lang.String autoBoot, java.lang.String jonasCmd)
          Modify a server configuration
 int pingJOnAS(java.lang.String name)
          Ping a JOnAS instance (MBean interface)
 void reloadConfiguration()
          Reload the configuration
 void removeServer(java.lang.String name)
          Remove a server configuration
 void setobjectName(java.lang.String name)
          Sets the object name of this mbean
 java.lang.String startAllJOnAS(java.lang.String domainName, java.lang.String prm)
          Start all the JOnAS instances configured with auto-reboot
 void startJOnAS(java.lang.String name, java.lang.String domainName, java.lang.String prm)
          Start a JOnAS instance
 java.lang.String stopAllJOnAS()
          Stop all the JOnAS instances
 void stopClusterDaemon()
          Stop the cluster daemon instance
 void stopJOnAS(java.lang.String name)
          Stop a JOnAS instance
 

Method Detail

getobjectName

java.lang.String getobjectName()
Returns:
Object Name

setobjectName

void setobjectName(java.lang.String name)
Sets the object name of this mbean

Parameters:
name - the Object Name

iseventProvider

boolean iseventProvider()
Returns:
true if it is an event provider

isstateManageable

boolean isstateManageable()
Returns:
true if this managed object implements J2EE State Management Model

isstatisticsProvider

boolean isstatisticsProvider()
Returns:
true if this managed object implements the J2EE StatisticProvider Model

getServersList

java.lang.String getServersList()
Returns:
the list of JOnAS instances

getJavaHome4Server

java.lang.String getJavaHome4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
the JAVA_HOME for a specified server name

getJonasRoot4Server

java.lang.String getJonasRoot4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
the JONAS_ROOT for a specified server name

getJonasBase4Server

java.lang.String getJonasBase4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
the JONAS_BASE for a specified server name

getJonasCmd4Server

java.lang.String getJonasCmd4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
the user command for a specified server name

getXprm4Server

java.lang.String getXprm4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
xprm for a specified server name

getAutoBoot4Server

java.lang.String getAutoBoot4Server(java.lang.String name)
Parameters:
name - JOnAS instance name
Returns:
autoBoot value for a specified server name

reloadConfiguration

void reloadConfiguration()
                         throws ClusterDaemonException
Reload the configuration

Throws:
ClusterDaemonException - if an error occurs

addServer

void addServer(java.lang.String name,
               java.lang.String description,
               java.lang.String javaHome,
               java.lang.String jonasRoot,
               java.lang.String jonasBase,
               java.lang.String xprm,
               java.lang.String autoBoot,
               java.lang.String jonasCmd)
               throws ClusterDaemonException
Add a server configuration

Parameters:
name - server name
description - server description
javaHome - JAVA_HOME dir
jonasBase - JONAS_BASE dir
jonasRoot - JONAS_ROOT dir
xprm - extra JVM parameters
autoBoot - automatic start
jonasCmd - user command
Throws:
ClusterDaemonException - if an error occurs

removeServer

void removeServer(java.lang.String name)
                  throws ClusterDaemonException
Remove a server configuration

Parameters:
name - server name
Throws:
ClusterDaemonException - if an error occurs

modifyServer

void modifyServer(java.lang.String name,
                  java.lang.String description,
                  java.lang.String javaHome,
                  java.lang.String jonasRoot,
                  java.lang.String jonasBase,
                  java.lang.String xprm,
                  java.lang.String autoBoot,
                  java.lang.String jonasCmd)
                  throws ClusterDaemonException
Modify a server configuration

Parameters:
name - server name
description - server description
javaHome - JAVA_HOME dir
jonasBase - JONAS_BASE dir
jonasRoot - JONAS_ROOT dir
xprm - extra JVM parameters
autoBoot - automatic start
jonasCmd - user command
Throws:
ClusterDaemonException - if an error occurs

startJOnAS

void startJOnAS(java.lang.String name,
                java.lang.String domainName,
                java.lang.String prm)
                throws ClusterDaemonException
Start a JOnAS instance

Parameters:
name - instance name
domainName - domain name
prm - extra parameters
Throws:
ClusterDaemonException - if an error occurs

stopJOnAS

void stopJOnAS(java.lang.String name)
               throws ClusterDaemonException
Stop a JOnAS instance

Parameters:
name - instance name
Throws:
ClusterDaemonException - if an error occurs

pingJOnAS

int pingJOnAS(java.lang.String name)
              throws ClusterDaemonException
Ping a JOnAS instance (MBean interface)

Parameters:
name - instance name
Returns:
exit code of the ping (0 ok, 1 ko)
Throws:
ClusterDaemonException - if an error occurs

startAllJOnAS

java.lang.String startAllJOnAS(java.lang.String domainName,
                               java.lang.String prm)
Start all the JOnAS instances configured with auto-reboot

Parameters:
domainName - domain name
prm - extra parameters
Returns:
the nodes list with an indicator started/starting failed

stopAllJOnAS

java.lang.String stopAllJOnAS()
Stop all the JOnAS instances

Returns:
the nodes list with an indicator stopped/stopping failed

stopClusterDaemon

void stopClusterDaemon()
Stop the cluster daemon instance