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 int
SOM_MESSAGE_ABORT
static int
SOM_MESSAGE_DELAY_CLEAR
static int
SOM_MESSAGE_DELAY_SET
static int
SOM_MESSAGE_DELETE
static int
SOM_MESSAGE_FORCE
static int
SOM_MESSAGE_NONDELIVER
static int
SOM_MESSAGE_PAUSE
static int
SOM_MESSAGE_REDIRECT
static int
SOM_MESSAGE_RELOAD
static int
SOM_MESSAGE_REPROCESS
static int
SOM_MESSAGE_RESUME
static int
SOM_MESSAGE_START
static int
SOM_MESSAGE_STOP
static int
SOM_MESSAGE_TIMEOUT
-
Fields inherited from class com.isode.som.SomCommand
opListener, opSession
-
-
Constructor Summary
Constructors Constructor Description SomQmgrMessageControlCommand(SomSession session, int op, java.lang.String chan, java.lang.String mta, SomQmgrHandler object, SomCommandListener listener)
Create a new SomQmgrMessageControlCommand objectSomQmgrMessageControlCommand(SomSession session, int op, java.lang.String chan, java.lang.String mta, SomQmgrSelector sel, SomQmgrHandler object, SomCommandListener listener)
Create a new SomQMgrMessageControlCommand object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSelector(SomQmgrSelector sel)
Add a selector into a command objectjava.lang.String
getCommandString()
Return string representation of commandjava.lang.String
getSubcommand()
void
setDelay(SomUtcTime d)
Set a delay time for a messagevoid
setForce(java.lang.Double forceValue)
Set the value to be used if forcing a message to have a certain priority.void
setReason(java.lang.String r)
Set a reason string to be used when non-delivering a messagevoid
setRecipient(java.lang.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
-
-
-
-
Field Detail
-
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 Detail
-
SomQmgrMessageControlCommand
public SomQmgrMessageControlCommand(SomSession session, int op, java.lang.String chan, java.lang.String mta, SomQmgrHandler object, SomCommandListener listener)
Create a new SomQmgrMessageControlCommand object- Parameters:
session
- Session in which to construct commandop
- Operation codechan
- Channel name for command which may not be nullmta
- MTA name for command which may not be nullobject
- Result handler for command which may not be nulllistener
- Listener object to be notified when command completes which may be null
-
SomQmgrMessageControlCommand
public SomQmgrMessageControlCommand(SomSession session, int op, java.lang.String chan, java.lang.String mta, SomQmgrSelector sel, SomQmgrHandler object, SomCommandListener listener)
Create a new SomQMgrMessageControlCommand object- Parameters:
session
- Session in which to construct commandop
- Operation codechan
- Channel name for command which may not be nullmta
- MTA name for command which may not be nullsel
- Selector object which may be nullobject
- Result handler for command which may not be nulllistener
- Listener object to be notified when command completes which may be null
-
-
Method Detail
-
setReason
public void setReason(java.lang.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(java.lang.String recip)
Set the new recipient for message redirection- Parameters:
recip
- Recipient address to which message should be redirected
-
setForce
public void setForce(java.lang.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 java.lang.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 java.lang.String getCommandString() throws SomException
Return string representation of command- Overrides:
getCommandString
in classSomCommand
- Returns:
- Command string
- Throws:
SomException
- on error
-
-