com.highqsoft.corbafileserver.plugin.impl.client

Class BasicClient

java.lang.Object

com.highqsoft.corbafileserver.plugin.impl.client.BasicClient

All Implemented Interfaces:

ClientCommand

Direct Known Subclasses:

DELClientCommand, FileTransferClientCommand

public abstract class BasicClient
extends java.lang.Object
implements ClientCommand

Abstract class for a basic client functionality. Initializes the client, checks the necessary properties and provides methods to get and set server information.
Code example:

BasicClient client = ...;
client.init(props);
client.run();
if(client.getResult() != CommandResult.VALUE_OK) {
// handle problems
} else {
// handle success
}



If the client is supposed to work with a different socket than the one it will create by itself, the method setSocket(Socket) must be called before the client is initialized.

Author:

alex

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BasicClient.Debug

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Long	aid
protected boolean	compress
protected java.lang.String	filename
protected java.lang.String	host
protected java.lang.Long	iid
protected org.apache.commons.logging.Log	logger
protected java.lang.Integer	port
protected java.lang.String	session
protected java.lang.String	subDir

Constructor Summary

Constructors

Constructor and Description
BasicClient()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doRun() This method will execute the command itself.
int	getResult() Returns the result of the command.
java.lang.String	getServerException() Returns the exception from the server when ClientCommand.getResult() returns CommandResult#FAILED.
java.lang.String	getServerResponse() Returns whatever the server may have sent to the client at the end of the command.
protected java.net.Socket	getSocket() Returns a socket through the mechanics of the CorbafileServer socket creation process.
protected void	identifyClient() Identifies the client with the server.
void	init(java.util.Properties properties) Initializes the ClientCommand with a set of properties.
protected boolean	readResponse(java.io.DataInputStream in) Reads the response from the server through the socket.
void	run() Opens the connection to the server and identifies the client, registering it at the server side in the waiting queue.
protected void	setException(java.lang.String exception)
protected void	setResult(int result)
protected void	setServerRepsonse(java.lang.String text)
void	setSocket(java.net.Socket s) Sets the socket that the client is supposed to use.
void	setSocketTimeOut(int milliSeconds) Set a timeout for the socket of the client.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.corbafileserver.plugin.impl.client.ClientCommand

getFileHash

Field Detail

session

protected java.lang.String session

subDir

protected java.lang.String subDir

filename

protected java.lang.String filename

host

protected java.lang.String host

port

protected java.lang.Integer port

aid

protected java.lang.Long aid

iid

protected java.lang.Long iid

compress

protected boolean compress

logger

protected org.apache.commons.logging.Log logger

Constructor Detail

BasicClient

public BasicClient()

Method Detail

init

public void init(java.util.Properties properties)

Description copied from interface: ClientCommand

Initializes the ClientCommand with a set of properties. The necessary and optional properties are defined by the implementing class.

Specified by:

init in interface ClientCommand

Parameters:

properties - a set of properties for the command to use

getSocket

protected java.net.Socket getSocket()
                             throws java.net.UnknownHostException,
                                    java.io.IOException

Returns a socket through the mechanics of the CorbafileServer socket creation process. Returns an SSL socket if the system has been set up to use SSL. The method returns the same socket with every call.

Returns:

a Socket object

Throws:

java.net.UnknownHostException - if the given host is unknown

java.io.IOException - if another IOException occurs

identifyClient

protected void identifyClient()
                       throws java.io.IOException

Identifies the client with the server. Send the supported server version to the server and expects a return from the server which is OK or WRONG_VERSION.

Throws:

java.io.IOException

getResult

public int getResult()

Description copied from interface: ClientCommand

Returns the result of the command. Only valid after ClientCommand.run() was called.

Specified by:

getResult in interface ClientCommand

Returns:

the value of a CommandResult or -1 if the method could not determine the state of the command

setResult

protected void setResult(int result)

getServerException

public java.lang.String getServerException()

Description copied from interface: ClientCommand

Returns the exception from the server when ClientCommand.getResult() returns CommandResult#FAILED. If no exception happened on the server this method returns null. Only usable after ClientCommand.run() was called.

Specified by:

getServerException in interface ClientCommand

Returns:

the exception on the server or null

setException

protected void setException(java.lang.String exception)

getServerResponse

public java.lang.String getServerResponse()

Description copied from interface: ClientCommand

Returns whatever the server may have sent to the client at the end of the command. This method may return null in which case the server did not send anything to the client.

Specified by:

getServerResponse in interface ClientCommand

Returns:

the response from the server

setServerRepsonse

protected void setServerRepsonse(java.lang.String text)

readResponse

protected boolean readResponse(java.io.DataInputStream in)
                        throws java.io.IOException

Reads the response from the server through the socket. The following constellations can exist:

Code	Meaning	Additional Data
1	OK	none
2	VALUE_OK_WITH_RESULT	A String representing the server side response
3	FAILED_SERVER	A String representing the server side exception

Parameters:

in - the InputStream from which to read the response

Returns:

true if the server returned any OK status, otherwise false

Throws:

java.io.IOException

setSocket

public void setSocket(java.net.Socket s)
               throws java.io.IOException

Sets the socket that the client is supposed to use. This method can be used when the socket is NOT created by the client itself but with an external mechanism.
This method will throw an IOException, when an attempt is made to set the socket after it was already created by the BasicClient itself.
That means this method should be called before the client is actually used.
This method can only be called once per client.

Parameters:

s - the socket to be used.

Throws:

java.io.IOException - thrown if the socket is already set

setSocketTimeOut

public void setSocketTimeOut(int milliSeconds)
                      throws java.net.SocketException

Set a timeout for the socket of the client. If a foreign socket was supplied by setSocket(Socket) then this method may throw an exception while setting the timeout on the foreign socket.

Parameters:

milliSeconds -

Throws:

java.net.SocketException - thrown if a foreign socket was provided and we try to set the timeout

run

public final void run()
               throws java.io.IOException

Opens the connection to the server and identifies the client, registering it at the server side in the waiting queue. When the server opens a slot for handling the request, the client will then progress with the command details specified by doRun().

Specified by:

run in interface ClientCommand

Throws:

java.io.IOException - thrown if something happened during the execution of the command

doRun

protected abstract void doRun()
                       throws java.io.IOException

This method will execute the command itself. The method is called by run()

Throws:

java.io.IOException