org.objectweb.joram.shared.client
Class ConsumerDenyRequest

java.lang.Object
  extended by org.objectweb.joram.shared.client.AbstractJmsMessage
      extended by org.objectweb.joram.shared.client.AbstractJmsRequest
          extended by org.objectweb.joram.shared.client.ConsumerDenyRequest
All Implemented Interfaces:
Streamable, java.io.Externalizable, java.io.Serializable

public final class ConsumerDenyRequest
extends AbstractJmsRequest

A ConsumerDenyRequest instance is used by a MessageConsumer for denying a received message.

See Also:
Serialized Form

Field Summary
private  boolean doNotAck
          true if the request must not be acked by the server.
private  java.lang.String id
          Message identifier.
private  boolean queueMode
          true if the request is destinated to a queue.
private static long serialVersionUID
          define serialVersionUID for interoperability
 
Fields inherited from class org.objectweb.joram.shared.client.AbstractJmsRequest
requestId, target
 
Fields inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage
ACTIVATE_CONSUMER_REQUEST, classid, classnames, CNX_CLOSE_REPLY, CNX_CLOSE_REQUEST, CNX_CONNECT_REPLY, CNX_CONNECT_REQUEST, CNX_START_REQUEST, CNX_STOP_REQUEST, COMMIT_REQUEST, CONSUMER_ACK_REQUEST, CONSUMER_CLOSE_SUB_REQUEST, CONSUMER_DENY_REQUEST, CONSUMER_MESSAGES, CONSUMER_RECEIVE_REQUEST, CONSUMER_SET_LIST_REQUEST, CONSUMER_SUB_REQUEST, CONSUMER_UNSET_LIST_REQUEST, CONSUMER_UNSUB_REQUEST, GET_ADMIN_TOPIC_REPLY, GET_ADMIN_TOPIC_REQUEST, JMS_REQUEST_GROUP, logger, MOM_EXCEPTION_REPLY, NULL_CLASS_ID, PING_REQUEST, PRODUCER_MESSAGES, QBROWSE_REPLY, QBROWSE_REQUEST, SERVER_REPLY, SESS_ACK_REQUEST, SESS_CREATE_DEST_REPLY, SESS_CREATE_DEST_REQUEST, SESS_DENY_REQUEST, TEMP_DEST_DELETE_REQUEST, XA_CNX_COMMIT, XA_CNX_PREPARE, XA_CNX_RECOVER_REPLY, XA_CNX_RECOVER_REQUEST, XA_CNX_ROLLBACK, XXX_SESS_CREATE_TTREQUEST
 
Constructor Summary
ConsumerDenyRequest()
          Constructs a ConsumerDenyRequest instance.
ConsumerDenyRequest(java.lang.String targetName, java.lang.String id, boolean queueMode)
          Constructs a ConsumerDenyRequest instance.
ConsumerDenyRequest(java.lang.String targetName, java.lang.String id, boolean queueMode, boolean doNotAck)
          Constructs a ConsumerDenyRequest instance.
 
Method Summary
protected  int getClassId()
           
 boolean getDoNotAck()
          Returns true if the request must not be acked by the server.
 java.lang.String getId()
          Returns the denied message identifier.
 boolean getQueueMode()
          Returns true if the request is destinated to a queue.
 void readFrom(java.io.InputStream is)
          The object implements the readFrom method to restore its contents from the input stream.
 void setDoNotAck(boolean doNotAck)
          Sets the server ack policy.
 void setId(java.lang.String id)
          Sets the denied message identifier.
 void setQueueMode(boolean queueMode)
          Sets the target destination type.
 void writeTo(java.io.OutputStream os)
          The object implements the writeTo method to write its contents to the output stream.
 
Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsRequest
getRequestId, getTarget, setRequestId, setTarget, toString, toString
 
Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage
read, readExternal, soapCode, soapDecode, write, writeExternal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

private static final long serialVersionUID
define serialVersionUID for interoperability

See Also:
Constant Field Values

id

private java.lang.String id
Message identifier.


queueMode

private boolean queueMode
true if the request is destinated to a queue.


doNotAck

private boolean doNotAck
true if the request must not be acked by the server.

Constructor Detail

ConsumerDenyRequest

public ConsumerDenyRequest(java.lang.String targetName,
                           java.lang.String id,
                           boolean queueMode)
Constructs a ConsumerDenyRequest instance.

Parameters:
targetName - Name of the target queue or subscription.
id - The message identifier.
queueMode - true if this request is destinated to a queue.

ConsumerDenyRequest

public ConsumerDenyRequest(java.lang.String targetName,
                           java.lang.String id,
                           boolean queueMode,
                           boolean doNotAck)
Constructs a ConsumerDenyRequest instance.

Parameters:
targetName - Name of the target queue or subscription.
id - The message identifier.
queueMode - true if this request is destinated to a queue.
doNotAck - true if this request must not be acked by the server.

ConsumerDenyRequest

public ConsumerDenyRequest()
Constructs a ConsumerDenyRequest instance.

Method Detail

setId

public void setId(java.lang.String id)
Sets the denied message identifier.


getId

public java.lang.String getId()
Returns the denied message identifier.


setQueueMode

public void setQueueMode(boolean queueMode)
Sets the target destination type.


getQueueMode

public boolean getQueueMode()
Returns true if the request is destinated to a queue.


setDoNotAck

public void setDoNotAck(boolean doNotAck)
Sets the server ack policy.


getDoNotAck

public boolean getDoNotAck()
Returns true if the request must not be acked by the server.


getClassId

protected int getClassId()
Specified by:
getClassId in class AbstractJmsMessage

writeTo

public void writeTo(java.io.OutputStream os)
             throws java.io.IOException
The object implements the writeTo method to write its contents to the output stream.

Specified by:
writeTo in interface Streamable
Overrides:
writeTo in class AbstractJmsRequest
Parameters:
os - the stream to write the object to
Throws:
java.io.IOException

readFrom

public void readFrom(java.io.InputStream is)
              throws java.io.IOException
The object implements the readFrom method to restore its contents from the input stream.

Specified by:
readFrom in interface Streamable
Overrides:
readFrom in class AbstractJmsRequest
Parameters:
is - the stream to read data from in order to restore the object
Throws:
java.io.IOException


Copyright © 2010 ScalAgent D.T.. All Rights Reserved.