org.apache.activemq.command
Class MessagePull

java.lang.Object
  extended by org.apache.activemq.command.BaseCommand
      extended by org.apache.activemq.command.MessagePull
All Implemented Interfaces:
Command, DataStructure

public class MessagePull
extends BaseCommand

Used to pull messages on demand.


Field Summary
protected  ConsumerId consumerId
           
static byte DATA_STRUCTURE_TYPE
           
protected  ActiveMQDestination destination
           
protected  long timeout
           
 
Fields inherited from class org.apache.activemq.command.BaseCommand
commandId, responseRequired
 
Constructor Summary
MessagePull()
           
 
Method Summary
 void configure(ConsumerInfo info)
          Configures a message pull from the consumer information
 ConsumerId getConsumerId()
           
 String getCorrelationId()
          An optional correlation ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer
 byte getDataStructureType()
           
 ActiveMQDestination getDestination()
           
 MessageId getMessageId()
          An optional message ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer
 long getTimeout()
           
 void setConsumerId(ConsumerId consumerId)
           
 void setCorrelationId(String correlationId)
           
 void setDestination(ActiveMQDestination destination)
           
 void setMessageId(MessageId messageId)
           
 void setTimeout(long timeout)
           
 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 Detail

DATA_STRUCTURE_TYPE

public static final byte DATA_STRUCTURE_TYPE
See Also:
Constant Field Values

consumerId

protected ConsumerId consumerId

destination

protected ActiveMQDestination destination

timeout

protected long timeout
Constructor Detail

MessagePull

public MessagePull()
Method Detail

getDataStructureType

public byte getDataStructureType()
Returns:
The type of the data structure

visit

public Response visit(CommandVisitor visitor)
               throws Exception
Throws:
Exception

configure

public void configure(ConsumerInfo info)
Configures a message pull from the consumer information


getConsumerId

public ConsumerId getConsumerId()

setConsumerId

public void setConsumerId(ConsumerId consumerId)

getDestination

public ActiveMQDestination getDestination()

setDestination

public void setDestination(ActiveMQDestination destination)

getTimeout

public long getTimeout()

setTimeout

public void setTimeout(long timeout)

getCorrelationId

public String getCorrelationId()
An optional correlation ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer


setCorrelationId

public void setCorrelationId(String correlationId)

getMessageId

public MessageId getMessageId()
An optional message ID which could be used by a broker to decide which messages are pulled on demand from a queue for a consumer


setMessageId

public void setMessageId(MessageId messageId)


Copyright © 2005-2012 The Apache Software Foundation. All Rights Reserved.