com.highqsoft.corbafileserver.plugin.impl.client

Interface ClientCommand

All Known Implementing Classes:

BasicClient, DELClientCommand, FileTransferClientCommand, GETClientCommand, PUTClientCommand

public interface ClientCommand

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFileHash() Returns the hash value of the file that was transferred.
int	getResult() Returns the result of the command.
java.lang.String	getServerException() Returns the exception from the server when getResult() returns CommandResult#FAILED.
java.lang.String	getServerResponse() Returns whatever the server may have sent to the client at the end of the command.
void	init(java.util.Properties properties) Initializes the ClientCommand with a set of properties.
void	run() Starts the job for the command.

Method Detail

init

void init(java.util.Properties properties)

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

Parameters:

properties - a set of properties for the command to use

run

void run()
         throws java.io.IOException

Starts the job for the command. This method should contain all necessary work to get the result from the server. Prior to this method, init(Properties) must be called to prepare the command for execution.

Throws:

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

getResult

int getResult()

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

Returns:

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

getServerException

java.lang.String getServerException()

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

Returns:

the exception on the server or null

getServerResponse

java.lang.String getServerResponse()

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.

Returns:

the response from the server

getFileHash

java.lang.String getFileHash()

Returns the hash value of the file that was transferred. This method will only return a valid value when an upload or a download was executed. Any other command on a file does not produce a hash value.

Returns:

a hashvalue for the file that was transferred or null if not applicable