Package org.apache.activemq.command

Class ConsumerControl

java.lang.Object

org.apache.activemq.command.BaseCommand

org.apache.activemq.command.ConsumerControl

All Implemented Interfaces:

Command, DataStructure

public class ConsumerControl
extends BaseCommand

Used to start and stop transports as well as terminating clients.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	close
protected ConsumerId	consumerId
static final byte	DATA_STRUCTURE_TYPE
protected ActiveMQDestination	destination
protected boolean	flush
protected int	prefetch
protected boolean	start
protected boolean	stop

Fields inherited from class org.apache.activemq.command.BaseCommand

commandId, responseRequired

Constructor Summary

Constructors

Constructor	Description
ConsumerControl()

Method Summary

Modifier and Type	Method	Description
ConsumerId	getConsumerId()
byte	getDataStructureType()
ActiveMQDestination	getDestination()
int	getPrefetch()
boolean	isClose()
boolean	isConsumerControl()
boolean	isFlush()
boolean	isStart()
boolean	isStop()
void	setClose(boolean close)
void	setConsumerId(ConsumerId consumerId)
void	setDestination(ActiveMQDestination destination)
void	setFlush(boolean flush)
void	setPrefetch(int prefetch)
void	setStart(boolean start)
void	setStop(boolean stop)
Response	visit(CommandVisitor visitor)

Methods inherited from class org.apache.activemq.command.BaseCommand

copy, getCommandId, getFrom, getTo, isBrokerInfo, isConnectionControl, isMarshallAware, isMessage, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

DATA_STRUCTURE_TYPE

public static final byte DATA_STRUCTURE_TYPE

See Also:

• Constant Field Values

consumerId

protected ConsumerId consumerId

close

protected boolean close

stop

protected boolean stop

start

protected boolean start

flush

protected boolean flush

prefetch

protected int prefetch

destination

protected ActiveMQDestination destination

Constructor Details

ConsumerControl

public ConsumerControl()

Method Details

getDestination

public ActiveMQDestination getDestination()

Returns:

Returns the destination.

setDestination

public void setDestination(ActiveMQDestination destination)

getDataStructureType

public byte getDataStructureType()

Returns:

The type of the data structure

visit

public Response visit(CommandVisitor visitor)
               throws Exception

Throws:

Exception

isConsumerControl

public boolean isConsumerControl()

Specified by:

isConsumerControl in interface Command

Overrides:

isConsumerControl in class BaseCommand

isClose

public boolean isClose()

Returns:

Returns the close.

setClose

public void setClose(boolean close)

Parameters:

close - The new value to assign the close state flag.

getConsumerId

public ConsumerId getConsumerId()

Returns:

Returns the consumerId.

setConsumerId

public void setConsumerId(ConsumerId consumerId)

Parameters:

consumerId - The consumerId to set.

getPrefetch

public int getPrefetch()

Returns:

Returns the prefetch.

setPrefetch

public void setPrefetch(int prefetch)

Parameters:

prefetch - The prefetch to set.

isFlush

public boolean isFlush()

Returns:

the flush

setFlush

public void setFlush(boolean flush)

Parameters:

flush - The flush value to set on this command.

isStart

public boolean isStart()

Returns:

the start

setStart

public void setStart(boolean start)

Parameters:

start - The start value to set on this command.

isStop

public boolean isStop()

Returns:

the stop

setStop

public void setStop(boolean stop)

Parameters:

stop - the stop value to set on this Command.