Package com.isode.som.qmgr

Class SomQmgrChannelControlCommand

java.lang.Object

com.isode.som.SomCommand

com.isode.som.qmgr.SomQmgrCommand

com.isode.som.qmgr.SomQmgrChannelControlCommand

All Implemented Interfaces:

SomResponseProcessor

public class SomQmgrChannelControlCommand
extends SomQmgrCommand

Class which provides Channel Control commands. Sub commands are: SOM_CHANNEL_STOP SOM_CHANNEL_START SOM_CHANNEL_DELAY_CLEAR SOM_CHANNEL_DELAY_SET SOM_CHANNEL_ENABLE_INBOUND SOM_CHANNEL_DISABLE_INBOUND SOM_CHANNEL_CONNECT SOM_CHANNEL_MINIMISE

Author:

tc

Field Summary

Fields

Modifier and Type	Field	Description
static int	SOM_CHANNEL_CONNECT
static int	SOM_CHANNEL_DELAY_CLEAR
static int	SOM_CHANNEL_DELAY_SET
static int	SOM_CHANNEL_DELETE_MESSAGES
static int	SOM_CHANNEL_DISABLE_INBOUND
static int	SOM_CHANNEL_ENABLE_INBOUND
static int	SOM_CHANNEL_MINIMISE
static int	SOM_CHANNEL_NONDELIVER_MESSAGES
static int	SOM_CHANNEL_REPROCESS_MESSAGES
static int	SOM_CHANNEL_REPROCESS_MTAS
static int	SOM_CHANNEL_START
static int	SOM_CHANNEL_STOP
static int	SOM_CHANNEL_TIMEOUT_MESSAGES

Fields inherited from class com.isode.som.SomCommand

opListener, opSession

Constructor Summary

Constructors

Constructor	Description
SomQmgrChannelControlCommand(SomSession session, int op, SomQmgrHandler object, SomCommandListener listener)	Create a new SomQmgrChannelControlCommand object.
SomQmgrChannelControlCommand(SomSession session, int op, SomQmgrSelector sel, SomQmgrHandler object, SomCommandListener listener)	Create a new SomQmgrChannelControlCommand object, with Selector.

Method Summary

Modifier and Type	Method	Description
void	addSelector(SomQmgrSelector sel)	Add a selector into a command object
java.lang.String	getCommandString()	Get the command string to be sent to the Queue Manager
java.lang.String	getSubcommand()	Get the sub command string
void	haveMta(java.lang.Boolean val)	Set flag which indicates whether an mtaname regexp should be included in some control commands.
void	setDelay(SomUtcTime d)	Configure the delay value to be used in the DELAY SET subcommand
void	setMinimisePriority(int max)	Set the maximum priority to which the MINIMISE operation should apply
void	setMinimiseStart(SomUtcTime time)	Set the start time for the MINIMISE operation
void	setMinimiseStop(SomUtcTime time)	Set the stop time for the MINIMISE operation
void	setMtaName(java.lang.String m)	Set the MTA name value to be used in the CHANNEL CONNECT subcommand
void	setReason(java.lang.String r)	Set the reason string for NONDELIVER MESSAGES operation

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 Detail

SOM_CHANNEL_STOP

public static final int SOM_CHANNEL_STOP

See Also:

Constant Field Values

SOM_CHANNEL_START

public static final int SOM_CHANNEL_START

See Also:

Constant Field Values

SOM_CHANNEL_DELAY_CLEAR

public static final int SOM_CHANNEL_DELAY_CLEAR

See Also:

Constant Field Values

SOM_CHANNEL_DELAY_SET

public static final int SOM_CHANNEL_DELAY_SET

See Also:

Constant Field Values

SOM_CHANNEL_ENABLE_INBOUND

public static final int SOM_CHANNEL_ENABLE_INBOUND

See Also:

Constant Field Values

SOM_CHANNEL_DISABLE_INBOUND

public static final int SOM_CHANNEL_DISABLE_INBOUND

See Also:

Constant Field Values

SOM_CHANNEL_CONNECT

public static final int SOM_CHANNEL_CONNECT

See Also:

Constant Field Values

SOM_CHANNEL_MINIMISE

public static final int SOM_CHANNEL_MINIMISE

See Also:

Constant Field Values

SOM_CHANNEL_DELETE_MESSAGES

public static final int SOM_CHANNEL_DELETE_MESSAGES

See Also:

Constant Field Values

SOM_CHANNEL_NONDELIVER_MESSAGES

public static final int SOM_CHANNEL_NONDELIVER_MESSAGES

See Also:

Constant Field Values

SOM_CHANNEL_TIMEOUT_MESSAGES

public static final int SOM_CHANNEL_TIMEOUT_MESSAGES

See Also:

Constant Field Values

SOM_CHANNEL_REPROCESS_MTAS

public static final int SOM_CHANNEL_REPROCESS_MTAS

See Also:

Constant Field Values

SOM_CHANNEL_REPROCESS_MESSAGES

public static final int SOM_CHANNEL_REPROCESS_MESSAGES

See Also:

Constant Field Values

Constructor Detail

SomQmgrChannelControlCommand

public SomQmgrChannelControlCommand(SomSession session,
                                    int op,
                                    SomQmgrHandler object,
                                    SomCommandListener listener)

Create a new SomQmgrChannelControlCommand object.

Parameters:

session - Session with which command is associated

op - Subcommand code

object - Result handler object

listener - Listener for notification of operation completion

SomQmgrChannelControlCommand

public SomQmgrChannelControlCommand(SomSession session,
                                    int op,
                                    SomQmgrSelector sel,
                                    SomQmgrHandler object,
                                    SomCommandListener listener)

Create a new SomQmgrChannelControlCommand object, with Selector.

Parameters:

session - Session with which command is associated

op - Subcommand code

sel - Selector to include

object - Result handler object

listener - Listener for notification of operation completion

Method Detail

setDelay

public void setDelay(SomUtcTime d)

Configure the delay value to be used in the DELAY SET subcommand

Parameters:

d - The time until which to delay the channel

setMtaName

public void setMtaName(java.lang.String m)

Set the MTA name value to be used in the CHANNEL CONNECT subcommand

Parameters:

m - MTA name to connect to

haveMta

public void haveMta(java.lang.Boolean val)

Set flag which indicates whether an mtaname regexp should be included in some control commands.

Parameters:

val - indicates whether this command should include a regexp or not

Since:

R16.6

setMinimiseStart

public void setMinimiseStart(SomUtcTime time)

Set the start time for the MINIMISE operation

Parameters:

time - at which MIMIMISE operation should come in to force

setMinimiseStop

public void setMinimiseStop(SomUtcTime time)

Set the stop time for the MINIMISE operation

Parameters:

time - at which MIMIMISE operation should stop

setMinimisePriority

public void setMinimisePriority(int max)

Set the maximum priority to which the MINIMISE operation should apply

Parameters:

max - priority for MINIMISE operation

setReason

public void setReason(java.lang.String r)

Set the reason string for NONDELIVER MESSAGES operation

Parameters:

r - reason string to insert into NDR

getSubcommand

public java.lang.String getSubcommand()
                               throws SomException

Get the sub command string

Returns:

subcommand string

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

Get the command string to be sent to the Queue Manager

Overrides:

getCommandString in class SomCommand

Returns:

command string

Throws:

SomException - Indicating a problem with the command