org.quickserver.net.server
Interface ClientCommandHandler

All Known Implementing Classes:

CommandHandler

public interface ClientCommandHandler

This interface defines the methods that should be implemented by any class that wants to handle client interaction.

Recommendations to be followed when implementing ClientCommandHandler

• Should have a default constructor.
• Should be thread safe.
• It should not store any client data that may be needed in the implementation.
• If any client data is need to be saved from the client session, it should be saved to a ClientData class, which can be retrieved using hadler.getClientData() method.

Ex:

 package echoserver;
 
 import java.net.*;
 import java.io.*;
 import org.quickserver.net.server.ClientCommandHandler;
 import org.quickserver.net.server.ClientHandler;
 
 public class EchoCommandHandler implements ClientCommandHandler {
 
         public void gotConnected(ClientHandler handler)
                 throws SocketTimeoutException, IOException {
                 handler.sendSystemMsg("Connection opened : "+
                         handler.getSocket().getInetAddress());
 
                 handler.sendClientMsg("Welcome to EchoServer v1.0 ");
                 handler.sendClientMsg("Note: Password = Username");
                 handler.sendClientMsg("Send 'Quit' to exit");
         }
 
         public void lostConnection(ClientHandler handler) 
                 throws IOException {
                 handler.sendSystemMsg("Connection lost : " + 
                         handler.getSocket().getInetAddress());
         }
         public void closingConnection(ClientHandler handler) 
                 throws IOException {
                 handler.sendSystemMsg("Connection closing : " + 
                         handler.getSocket().getInetAddress());
         }
 
         public void handleCommand(ClientHandler handler, String command)
                         throws SocketTimeoutException, IOException {
                 if(command.toLowerCase().equals("quit")) {
                         handler.sendClientMsg("Bye ;-)");
                         handler.closeConnection();
                 } else {
                         handler.sendClientMsg("Echo : " + command);
                 }
         }
 }
 

Author:

Akshathkumar Shetty

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.

Method Detail

handleCommand

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

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

Throws:

java.net.SocketTimeoutException - if socket times out

java.io.IOException - if io error in socket

gotConnected

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

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

Throws:

java.net.SocketTimeoutException - if socket times out

java.io.IOException - if io error in socket

lostConnection

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

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.

Throws:

java.io.IOException - if io error in socket

closingConnection

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

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.

Throws:

java.io.IOException - if io error in socket