9.4 COM.volano.Shutdown

COM.volano.Shutdown requests the VolanoChat server to stop.

Synopsis

 java -cp lib/volanochat-server.jar COM.volano.Shutdown [ options ]

Description

COM.volano.Shutdown makes a local connection to the VolanoChat server and requests it to stop.

Options

-cp lib/volanochat-server.jar: This command tells Java to look inside the .jar file for the Shutdown module.
file: Specifies the path to the VolanoChat server properties file that defines the applications's configuration. If no file is specified, the application looks for its properties in a file conf/properties.txt, relative to the current working directory.

Application Properties

The following properties are read by the Shutdown application from the VolanoChat server properties file:

admin.port=8001: specifies the port number at which the administrative subsystem of the VolanoChat server accepts administrative connections.
admin.password=: defines the password required to make an administrator connection to the VolanoChat server. This must be defined for the Shutdown command to work.
server.host=: This property must be defined and must match admin.client.host for the Shutdown command to work.

An additional property is read by the server when it receives an administrative connection request:

admin.client.host=: This property must match the IP address of the machine where you're issuing the command and must be defined for the Shutdown command to work. In most cases this should be set to the same value as server.host because normally you will want to issue Shutdown commands from the same machine where VolanoChat is installed.

Once these properties are defined, you can shut down the VolanoChat server by entering the following command from the VolanoChat server installation directory:

java -cp lib/volanochat-server.jar COM.volano.Shutdown

Environment Variables

CLASSPATH: Used to provide the system a path to user-defined classes. Directories are separated by semicolons on Windows and colons on UNIX. The classpath needs to point to the lib/volanochat-server.jar archive of your VolanoChat installation.