org.objectweb.joram.mom.notifications
Class ReceiveRequest

java.lang.Object
  extended byfr.dyade.aaa.agent.Notification
      extended byorg.objectweb.joram.mom.notifications.AbstractNotification
          extended byorg.objectweb.joram.mom.notifications.AbstractRequest
              extended byorg.objectweb.joram.mom.notifications.ReceiveRequest
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ReceiveRequest
extends AbstractRequest

A ReceiveRequest instance is used by a client agent for requesting a message on a queue.

See Also:
Serialized Form

Field Summary
 AgentId requester
          Identifier of the client requesting a message, set by the queue if storing the request.
 
Fields inherited from class fr.dyade.aaa.agent.Notification
persistent
 
Constructor Summary
ReceiveRequest(int clientContext, int requestId, java.lang.String selector, long timeOut, boolean autoAck)
          Constructs a ReceiveRequest instance.
 
Method Summary
 boolean getAutoAck()
          Checks the autoAck mode of this request.
 java.lang.String getSelector()
          Returns the selector of the request.
 long getTimeOut()
          Returns the time-to-live parameter of this request, in milliseconds (0 for immediate delivery, negative for infinite validity).
 boolean isValid()
          Returns false if the request expired.
 void setExpiration(long currentTime)
          Updates the expiration time field, if needed.
 
Methods inherited from class org.objectweb.joram.mom.notifications.AbstractRequest
getRequestId, toString
 
Methods inherited from class org.objectweb.joram.mom.notifications.AbstractNotification
getClientContext
 
Methods inherited from class fr.dyade.aaa.agent.Notification
clone, getContext, setContext
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

requester

public AgentId requester
Identifier of the client requesting a message, set by the queue if storing the request.

Constructor Detail

ReceiveRequest

public ReceiveRequest(int clientContext,
                      int requestId,
                      java.lang.String selector,
                      long timeOut,
                      boolean autoAck)
Constructs a ReceiveRequest instance.

Parameters:
clientContext - Identifies a client context.
requestId - Request identifier.
selector - Selector expression for filtering messages, null or empty for no selection.
timeOut - Time-to-live value. For immediate delivery, should be set to 0. For infinite time-to-live, should be negative.
autoAck - true for immediately acknowledging the delivered message on the queue, false otherwise.
Method Detail

getSelector

public java.lang.String getSelector()
Returns the selector of the request.


getTimeOut

public long getTimeOut()
Returns the time-to-live parameter of this request, in milliseconds (0 for immediate delivery, negative for infinite validity).


getAutoAck

public boolean getAutoAck()
Checks the autoAck mode of this request.


setExpiration

public void setExpiration(long currentTime)
Updates the expiration time field, if needed.


isValid

public boolean isValid()
Returns false if the request expired.



Copyright ? 2004 Scalagent - All rights reserved