Package com.isode.som

Class SomCommand

java.lang.Object

com.isode.som.SomCommand

All Implemented Interfaces:

SomResponseProcessor

Direct Known Subclasses:

SomPumiceCommand, SomQmgrCommand

public abstract class SomCommand
extends java.lang.Object
implements SomResponseProcessor

Class which represents a generic SOM command.

Author:

tc

Field Summary

Fields

Modifier and Type	Field	Description
protected SomCommandListener	opListener
protected SomSession	opSession

Constructor Summary

Constructors

Constructor	Description
SomCommand(SomSession sess)	Create a new SomCommand object.
SomCommand(SomSession sess, SomHandler handler)	Create a new SomCommand object.
SomCommand(SomSession sess, SomHandler handler, SomCommandListener listener)	Create a new SomCommand object.

Method Summary

Modifier and Type	Method	Description
void	dispatch()	Send off a command once constructed.
protected java.lang.String	getCommandString()
protected SomSession	getSession()	Obtain the SomSession object with which a command is associated.
void	notifyListener(int status)	Tell the command listener about an event.
void	notifyListener(int status, java.lang.String detail)	Tell the command listener about an event which includes a detail string
void	notifyListener(int status, java.lang.String[] pairs)	Tell the listener about an event which includes an array of data pairs
void	processResponse(java.lang.String commandData, byte[] data, int status)	Process response to command.

Methods inherited from class java.lang.Object

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

Field Detail

opSession

protected SomSession opSession

opListener

protected SomCommandListener opListener

Constructor Detail

SomCommand

public SomCommand(SomSession sess)

Create a new SomCommand object.

Parameters:

sess - SomSession to use for command

SomCommand

public SomCommand(SomSession sess,
                  SomHandler handler)

Create a new SomCommand object.

Parameters:

sess - SomSession to use for command which must not be null

handler - SomHandler which will be used during session establishment which must not be null

SomCommand

public SomCommand(SomSession sess,
                  SomHandler handler,
                  SomCommandListener listener)

Create a new SomCommand object.

Parameters:

sess - SomSession to use for command

handler - SomHandler which be will used during session establishment which must not be null

listener - SomCommandListener which will handle results and error info which may be null

Method Detail

dispatch

public void dispatch()
              throws SomException

Send off a command once constructed. Wait for a response if we are operating synchronously.

Throws:

SomException - Indicating a problem with the command

getSession

protected SomSession getSession()

Obtain the SomSession object with which a command is associated.

Returns:

SomSession object

processResponse

public void processResponse(java.lang.String commandData,
                            byte[] data,
                            int status)

Process response to command.

Specified by:

processResponse in interface SomResponseProcessor

getCommandString

protected java.lang.String getCommandString()
                                     throws SomException

Returns:

The command string to be sent over the wire.

Throws:

SomException - Indicating a problem with the command

notifyListener

public void notifyListener(int status)

Tell the command listener about an event.

Parameters:

status - the status code

notifyListener

public void notifyListener(int status,
                           java.lang.String detail)

Tell the command listener about an event which includes a detail string

Parameters:

status - the status code

detail - which must not be null

notifyListener

public void notifyListener(int status,
                           java.lang.String[] pairs)

Tell the listener about an event which includes an array of data pairs

Parameters:

status - the status code

pairs - which must not be null