org.apache.activemq.command

Interface Command

All Superinterfaces:

DataStructure

All Known Implementing Classes:

ActiveMQBlobMessage, ActiveMQBytesMessage, ActiveMQMapMessage, ActiveMQMessage, ActiveMQObjectMessage, ActiveMQStreamMessage, ActiveMQTextMessage, BaseCommand, BrokerInfo, ConnectionControl, ConnectionError, ConnectionInfo, ConsumerControl, ConsumerInfo, ControlCommand, DataArrayResponse, DataResponse, DestinationInfo, ExceptionResponse, FlushCommand, IntegerResponse, KeepAliveInfo, LastPartialCommand, Message, MessageAck, MessageDispatch, MessageDispatchNotification, MessagePull, PartialCommand, ProducerAck, ProducerInfo, RemoveInfo, RemoveSubscriptionInfo, ReplayCommand, Response, SessionInfo, ShutdownInfo, StompFrame, StompFrameError, Tracked, TransactionInfo, WireFormatInfo

public interface Command
extends DataStructure

The Command Pattern so that we can send and receive commands on the different transports

Method Summary

Methods

Modifier and Type	Method and Description
int	getCommandId()
Endpoint	getFrom() The endpoint within the transport where this message came from which could be null if the transport only supports a single endpoint.
Endpoint	getTo() The endpoint within the transport where this message is going to - null means all endpoints.
boolean	isBrokerInfo()
boolean	isConnectionControl()
boolean	isConsumerControl()
boolean	isMessage()
boolean	isMessageAck()
boolean	isMessageDispatch()
boolean	isMessageDispatchNotification()
boolean	isResponse()
boolean	isResponseRequired()
boolean	isShutdownInfo()
boolean	isWireFormatInfo()
void	setCommandId(int value)
void	setFrom(Endpoint from)
void	setResponseRequired(boolean responseRequired)
void	setTo(Endpoint to)
Response	visit(CommandVisitor visitor)

Methods inherited from interface org.apache.activemq.command.DataStructure

getDataStructureType, isMarshallAware

Method Detail

setCommandId

void setCommandId(int value)

getCommandId

int getCommandId()

Returns:

the unique ID of this request used to map responses to requests

setResponseRequired

void setResponseRequired(boolean responseRequired)

isResponseRequired

boolean isResponseRequired()

isResponse

boolean isResponse()

isMessageDispatch

boolean isMessageDispatch()

isBrokerInfo

boolean isBrokerInfo()

isWireFormatInfo

boolean isWireFormatInfo()

isMessage

boolean isMessage()

isMessageAck

boolean isMessageAck()

isMessageDispatchNotification

boolean isMessageDispatchNotification()

isShutdownInfo

boolean isShutdownInfo()

isConnectionControl

boolean isConnectionControl()

isConsumerControl

boolean isConsumerControl()

visit

Response visit(CommandVisitor visitor)
               throws Exception

Throws:

Exception

getFrom

Endpoint getFrom()

The endpoint within the transport where this message came from which could be null if the transport only supports a single endpoint.

setFrom

void setFrom(Endpoint from)

getTo

Endpoint getTo()

The endpoint within the transport where this message is going to - null means all endpoints.

setTo

void setTo(Endpoint to)