com.caucho.boot

Interface WatchdogAPI

public interface WatchdogAPI

Process responsible for watching a backend server.

Method Summary

Modifier and Type	Method and Description
void	kill(java.lang.String password, java.lang.String serverId) Kills the named server, terminating the process.
void	restart(java.lang.String password, java.lang.String serverId, java.lang.String[] argv) Restarts the server with the given arguments.
boolean	shutdown(java.lang.String password) Shuts the entire watchdog manager down.
void	start(java.lang.String password, java.lang.String[] argv) Starts the server with the given arguments.
java.lang.String	status(java.lang.String password) Returns the status of the watchdog manager
void	stop(java.lang.String password, java.lang.String serverId) Stops the named server

Method Detail

status

java.lang.String status(java.lang.String password)

Returns the status of the watchdog manager

Parameters:

password - the watchdog password

Returns:

a user-readable status report

start

void start(java.lang.String password,
           java.lang.String[] argv)
    throws ConfigException,
           java.lang.IllegalStateException,
           java.io.IOException

Starts the server with the given arguments. If the start fails, a ConfigException is thrown.

Throws:

ConfigException

java.lang.IllegalStateException

java.io.IOException

restart

void restart(java.lang.String password,
             java.lang.String serverId,
             java.lang.String[] argv)
      throws ConfigException,
             java.lang.IllegalStateException,
             java.io.IOException

Restarts the server with the given arguments.

Parameters:

password - watchdog password

serverId - the server to be restarted

argv - the new arguments for the server

Throws:

ConfigException

java.lang.IllegalStateException

java.io.IOException

stop

void stop(java.lang.String password,
          java.lang.String serverId)
   throws ConfigException,
          java.lang.IllegalStateException,
          java.io.IOException

Stops the named server

Parameters:

password - the watchdog password

serverId - the server to stop

Throws:

ConfigException

java.lang.IllegalStateException

java.io.IOException

kill

void kill(java.lang.String password,
          java.lang.String serverId)
   throws ConfigException,
          java.lang.IllegalStateException,
          java.io.IOException

Kills the named server, terminating the process.

Parameters:

password - the watchdog password

serverId - the server to kill

Throws:

ConfigException

java.lang.IllegalStateException

java.io.IOException

shutdown

boolean shutdown(java.lang.String password)
          throws java.io.IOException

Shuts the entire watchdog manager down.

Parameters:

password -

Returns:

true on success

Throws:

java.io.IOException