Package com.isode.som.qmgr

Class SomQmgrMessageControlCommand

java.lang.Object

com.isode.som.SomCommand

com.isode.som.qmgr.SomQmgrCommand

com.isode.som.qmgr.SomQmgrMessageControlCommand

All Implemented Interfaces:

SomResponseProcessor

public class SomQmgrMessageControlCommand
extends SomQmgrCommand

SOM Command which enables Control operations to be performed on Messages. Commands are: SOM_MESSAGE_STOP SOM_MESSAGE_START SOM_MESSAGE_DELAY_CLEAR SOM_MESSAGE_DELAY_SET SOM_MESSAGE_DELETE SOM_MESSAGE_NONDELIVER SOM_MESSAGE_REPROCESS SOM_MESSAGE_TIMEOUT SOM_MESSAGE_REDIRECT SOM_MESSAGE_RELOAD SOM_MESSAGE_ABORT SOM_MESSAGE_PAUSE SOM_MESSAGE_RESUME

Author:

tc

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SOM_MESSAGE_ABORT
static final int	SOM_MESSAGE_DELAY_CLEAR
static final int	SOM_MESSAGE_DELAY_SET
static final int	SOM_MESSAGE_DELETE
static final int	SOM_MESSAGE_FORCE
static final int	SOM_MESSAGE_NONDELIVER
static final int	SOM_MESSAGE_PAUSE
static final int	SOM_MESSAGE_REDIRECT
static final int	SOM_MESSAGE_RELOAD
static final int	SOM_MESSAGE_REPROCESS
static final int	SOM_MESSAGE_RESUME
static final int	SOM_MESSAGE_START
static final int	SOM_MESSAGE_STOP
static final int	SOM_MESSAGE_TIMEOUT

Fields inherited from class com.isode.som.SomCommand

opListener, opSession

Constructor Summary

Constructors

Constructor	Description
SomQmgrMessageControlCommand(SomSession session, int op, String chan, String mta, SomQmgrHandler object, SomCommandListener listener)	Create a new SomQmgrMessageControlCommand object
SomQmgrMessageControlCommand(SomSession session, int op, String chan, String mta, SomQmgrSelector sel, SomQmgrHandler object, SomCommandListener listener)	Create a new SomQMgrMessageControlCommand object

Method Summary

Modifier and Type	Method	Description
void	addSelector(SomQmgrSelector sel)	Add a selector into a command object
String	getCommandString()	Return string representation of command
String	getSubcommand()
void	setDelay(SomUtcTime d)	Set a delay time for a message
void	setForce(Double forceValue)	Set the value to be used if forcing a message to have a certain priority.
void	setReason(String r)	Set a reason string to be used when non-delivering a message
void	setRecipient(String recip)	Set the new recipient for message redirection

Methods inherited from class com.isode.som.qmgr.SomQmgrCommand

getHandler, processResponse

Methods inherited from class com.isode.som.SomCommand

dispatch, getSession, notifyListener, notifyListener, notifyListener

Methods inherited from class java.lang.Object

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

Field Details

SOM_MESSAGE_STOP

public static final int SOM_MESSAGE_STOP

See Also:

• Constant Field Values

SOM_MESSAGE_START

public static final int SOM_MESSAGE_START

See Also:

• Constant Field Values

SOM_MESSAGE_DELAY_CLEAR

public static final int SOM_MESSAGE_DELAY_CLEAR

See Also:

• Constant Field Values

SOM_MESSAGE_DELAY_SET

public static final int SOM_MESSAGE_DELAY_SET

See Also:

• Constant Field Values

SOM_MESSAGE_DELETE

public static final int SOM_MESSAGE_DELETE

See Also:

• Constant Field Values

SOM_MESSAGE_NONDELIVER

public static final int SOM_MESSAGE_NONDELIVER

See Also:

• Constant Field Values

SOM_MESSAGE_REPROCESS

public static final int SOM_MESSAGE_REPROCESS

See Also:

• Constant Field Values

SOM_MESSAGE_TIMEOUT

public static final int SOM_MESSAGE_TIMEOUT

See Also:

• Constant Field Values

SOM_MESSAGE_REDIRECT

public static final int SOM_MESSAGE_REDIRECT

See Also:

• Constant Field Values

SOM_MESSAGE_RELOAD

public static final int SOM_MESSAGE_RELOAD

See Also:

• Constant Field Values

SOM_MESSAGE_ABORT

public static final int SOM_MESSAGE_ABORT

See Also:

• Constant Field Values

SOM_MESSAGE_PAUSE

public static final int SOM_MESSAGE_PAUSE

See Also:

• Constant Field Values

SOM_MESSAGE_RESUME

public static final int SOM_MESSAGE_RESUME

See Also:

• Constant Field Values

SOM_MESSAGE_FORCE

public static final int SOM_MESSAGE_FORCE

See Also:

• Constant Field Values

Constructor Details

SomQmgrMessageControlCommand

public SomQmgrMessageControlCommand(SomSession session,
 int op,
 String chan,
 String mta,
 SomQmgrHandler object,
 SomCommandListener listener)

Create a new SomQmgrMessageControlCommand object

Parameters:

session - Session in which to construct command

op - Operation code

chan - Channel name for command which may not be null

mta - MTA name for command which may not be null

object - Result handler for command which may not be null

listener - Listener object to be notified when command completes which may be null

SomQmgrMessageControlCommand

public SomQmgrMessageControlCommand(SomSession session,
 int op,
 String chan,
 String mta,
 SomQmgrSelector sel,
 SomQmgrHandler object,
 SomCommandListener listener)

Create a new SomQMgrMessageControlCommand object

Parameters:

session - Session in which to construct command

op - Operation code

chan - Channel name for command which may not be null

mta - MTA name for command which may not be null

sel - Selector object which may be null

object - Result handler for command which may not be null

listener - Listener object to be notified when command completes which may be null

Method Details

setReason

public void setReason(String r)

Set a reason string to be used when non-delivering a message

Parameters:

r - Reason string

setDelay

public void setDelay(SomUtcTime d)

Set a delay time for a message

Parameters:

d - Time to delay message until (UTC Time String)

setRecipient

public void setRecipient(String recip)

Set the new recipient for message redirection

Parameters:

recip - Recipient address to which message should be redirected

setForce

public void setForce(Double forceValue)

Set the value to be used if forcing a message to have a certain priority.

Parameters:

forceValue - the forced priority value to use

getSubcommand

public String getSubcommand()
                     throws SomException

Throws:

SomException

addSelector

public void addSelector(SomQmgrSelector sel)

Add a selector into a command object

Parameters:

sel - Selector to add

getCommandString

public String getCommandString()
                        throws SomException

Return string representation of command

Overrides:

getCommandString in class SomCommand

Returns:

Command string

Throws:

SomException - on error