org.quickserver.net.qsadmin
Class CommandHandler

java.lang.Object
  org.quickserver.net.qsadmin.CommandHandler

All Implemented Interfaces:

ClientCommandHandler, ClientEventHandler

public class CommandHandler

extends java.lang.Object

implements ClientCommandHandler

ClientCommandHandler for QSAdminServer.

= Protocol =
Each response starts with a status.

• +OK = Success
• -ERR = Failed

If response if one lined then it follows the status. Else You will get "info follows" as the first line followed by with many lines of response ending by a dot in a line by itself. i.e., <CR><LF>.<CR><LF>
Command supported are give below .. [ Note: <<target>> = server|self ]

Command	Param	Effect
start	<<target>>	Starts target.
stop	<<target>>	Stops target.
restart	<<target>>	=stop+start command
shutdown		Stops server and self.
kill or exit		Stops server and self and kill all threads.
info	<<target>>	Information about target.
noclient	<<target>>	No Client connected to the target.
running	<<target>>	Checks if target is running.
get	<<target>> maxClient	Gets max no of client for the target.
get	<<target>> port	Gets port for the target.
get	<<target>> maxAuthTryMsg	Gets maxAuthTryMsg for the target.
get	<<target>> clientCommandHandler	Gets ClientCommandHandler class for the target.
get	<<target>> serverAuthenticator	Gets ServerAuthenticator class for the target.
get	<<target>> clientData	Gets ClientData class for the target.
get	<<target>> timeout	Gets timeout set for clients for the target.
set	<<target>> maxClient <<value>>	Sets max no of client for the target.
set	<<target>> port <<value>>	Sets port for the target.*
set	<<target>> maxAuthTryMsg <<value>>	Sets maxAuthTryMsg for the target. *
set	<<target>> clientCommandHandler <<value>>	Sets ClientCommandHandler class for the target. *
set	<<target>> serverAuthenticator <<value>>	Sets ServerAuthenticator class for the target. *
set	<<target>> clientData <<value>>	Sets ClientData class for the target. *
set	<<target>> timeout <<value>>	Sets timeout set for clients for the target. *
version		Gets the version of the QuickServer library used.
quit		Close session.
New Command in v1.2
get	self plugin	Gets pluggable command handler for QsAdminServer. *
set	self plugin <<full class name>>	Sets Pluggable command handler for QsAdminServer. *
New Command in v1.3
suspendService	<<target>>	Suspends target.
resumeService	<<target>>	Resume target.
get	<<target>> maxAuthTry	Gets maxAuthTry for the target.
set	<<target>> maxAuthTry	Sets maxAuthTry for the target.*
get	<<target>> clientObjectHandler	Gets ClientObjectHandler class for the target.
set	<<target>> clientObjectHandler	Sets ClientObjectHandler class for the target.*
get	<<target>> timeoutMsg	Gets timeout Message for the target.
set	<<target>> timeoutMsg	Sets timeout Message for the target.*
get	<<target>> serviceState	Gets Service State for the target.
get	<<target>> consoleLoggingFormatter	Sets consoleLoggingFormatter for the target.
set	<<target>> consoleLoggingFormatter	Sets consoleLoggingFormatter for the target.
get	<<target>> consoleLoggingLevel	Sets consoleLoggingLevel for the target.
set	<<target>> consoleLoggingLevel	Sets consoleLoggingLevel for the target. [SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST]
set	<<target>> maxClientMsg	Sets maxClientMsg for the target.
get	<<target>> maxClientMsg	Gets maxClientMsg for the target.
New Command in v1.3.1
set	<<target>> loggingLevel	Sets LoggingLevel for the target. [SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST]
New Command in v1.3.2
memoryInfo		Memory Information {Total:Used:Max}
set	<<target>> communicationLogging	Sets communication logging flag for the target.
get	<<target>> communicationLogging	Gets communication logging flag for the target.
set	<<target>> objectPoolConfig-maxActive	Sets maxActive of objectPoolConfig for the target.
get	<<target>> objectPoolConfig-maxActive	Gets maxActive of objectPoolConfig for the target.
set	<<target>> objectPoolConfig-maxIdle	Sets maxIdle of objectPoolConfig for the target.
get	<<target>> objectPoolConfig-maxIdle	Gets maxIdle of objectPoolConfig for the target.
New Command in v1.4.5
all-pool-info	<<target>>	Gives stats of all pools for the target.
client-thread-pool-dump	<<target>>	Gives dump of all threads in pool for the target.
start	<<console>>	Starts console shell.
stop	<<console>>	Stops console shell.
* = Take effect after a restart command. value if set null then key will be set to null

Note:

• Stopping the QuickServer will not disconnect any client connect to it, since client connections are handled by different thread.
• restart and start response just indicate only if command was sent. Do check the state of the target using running command to see if server was started successful.
• Demo code examples\EchoServer shows the use of QsAdminServer to control itself.

Eg:

noClient server
noClient self
get server maxClient
set server maxClient 10

Since:

1.1

Constructor Summary

CommandHandler()

Method Summary

void	closingConnection(ClientHandler handler) Method called when client connection is closed.
void	gotConnected(ClientHandler handler) Method called when there is a new client connects to the QuickServer.
void	handleCommand(ClientHandler handler, java.lang.String command) Method called every time client sends a line of data.
void	lostConnection(ClientHandler handler) Method called when client connection is lost.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandHandler

public CommandHandler()

Method Detail

gotConnected

public void gotConnected(ClientHandler handler)
                  throws java.net.SocketTimeoutException,
                         java.io.IOException

Description copied from interface: ClientEventHandler

Method called when there is a new client connects to the QuickServer. Can be used to send welcome message to the client and logging.

Specified by:

gotConnected in interface ClientEventHandler

Throws:

java.io.IOException - if io error in socket

java.net.SocketTimeoutException - if socket times out

lostConnection

public void lostConnection(ClientHandler handler)
                    throws java.io.IOException

Description copied from interface: ClientEventHandler

Method called when client connection is lost. Don't write to the connection in this method. Its just information, to be used at the Server end. It can be caused due to network errors.

Specified by:

lostConnection in interface ClientEventHandler

Throws:

java.io.IOException - if io error in socket

closingConnection

public void closingConnection(ClientHandler handler)
                       throws java.io.IOException

Description copied from interface: ClientEventHandler

Method called when client connection is closed. Don't write to the connection in this method. Its just information, you can use to log time and ip of client closing connection.

Specified by:

closingConnection in interface ClientEventHandler

Throws:

java.io.IOException - if io error in socket

handleCommand

public void handleCommand(ClientHandler handler,
                          java.lang.String command)
                   throws java.net.SocketTimeoutException,
                          java.io.IOException

Description copied from interface: ClientCommandHandler

Method called every time client sends a line of data. Should be used to handle the command sent and send any requested data.

Specified by:

handleCommand in interface ClientCommandHandler

Throws:

java.net.SocketTimeoutException - if socket times out

java.io.IOException - if io error in socket