Package org.objectweb.joram.shared.client

Class ConsumerDenyRequest

java.lang.Object

org.objectweb.joram.shared.client.AbstractJmsMessage

org.objectweb.joram.shared.client.AbstractJmsRequest

org.objectweb.joram.shared.client.ConsumerDenyRequest

All Implemented Interfaces:

Encodable, Streamable, Externalizable, 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

Fields

Modifier and Type	Field	Description
private boolean	doNotAck	true if the request must not be acked by the server.
private String	id	Message identifier.
private boolean	queueMode	true if the request is destinated to a queue.
private boolean	redelivered	true if the message has already been delivered.
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, ADD_CLIENTID_REPLY, ADD_CLIENTID_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, 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

Fields inherited from interface fr.dyade.aaa.common.encoding.Encodable

BOOLEAN_ENCODED_SIZE, BYTE_ENCODED_SIZE, DOUBLE_ENCODED_SIZE, FLOAT_ENCODED_SIZE, INT_ENCODED_SIZE, LONG_ENCODED_SIZE, SHORT_ENCODED_SIZE

Constructor Summary

Constructors

Constructor	Description
ConsumerDenyRequest()	Constructs a ConsumerDenyRequest instance.
ConsumerDenyRequest(String targetName, String id, boolean queueMode)	Constructs a ConsumerDenyRequest instance.
ConsumerDenyRequest(String targetName, String id, boolean queueMode, boolean doNotAck)	Constructs a ConsumerDenyRequest instance.

Method Summary

Modifier and Type	Method	Description
protected int	getClassId()
boolean	getDoNotAck()	Returns true if the request must not be acked by the server.
String	getId()	Returns the denied message identifier.
boolean	getQueueMode()	Returns true if the request is destinated to a queue.
boolean	isRedelivered()
void	readFrom(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(String id)	Sets the denied message identifier.
void	setQueueMode(boolean queueMode)	Sets the target destination type.
void	setRedelivered(boolean redelivered)
void	writeTo(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

decode, encode, getEncodableClassId, getEncodedSize, getRequestId, getTarget, setRequestId, setTarget, toString, toString

Methods inherited from class org.objectweb.joram.shared.client.AbstractJmsMessage

read, readExternal, 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 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.

redelivered

private boolean redelivered

true if the message has already been delivered.

Constructor Detail

ConsumerDenyRequest

public ConsumerDenyRequest(String targetName,
                           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(String targetName,
                           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(String id)

Sets the denied message identifier.

Parameters:

id - The denied message identifier.

getId

public String getId()

Returns the denied message identifier.

Returns:

The denied message identifier.

setQueueMode

public void setQueueMode(boolean queueMode)

Sets the target destination type.

Parameters:

queueMode - The target destination type.

getQueueMode

public boolean getQueueMode()

Returns true if the request is destinated to a queue.

Returns:

True if the request is for a queue.

setDoNotAck

public void setDoNotAck(boolean doNotAck)

Sets the server ack policy.

Parameters:

doNotAck - The ack policy.

getDoNotAck

public boolean getDoNotAck()

Returns true if the request must not be acked by the server.

Returns:

The ack policy.

isRedelivered

public boolean isRedelivered()

Returns:

the redelivered

setRedelivered

public void setRedelivered(boolean redelivered)

Parameters:

redelivered - the redelivered to set

getClassId

protected int getClassId()

Specified by:

getClassId in class AbstractJmsMessage

writeTo

public void writeTo(OutputStream os)
             throws 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:

IOException - an error occurs during IO operation.

readFrom

public void readFrom(InputStream is)
              throws 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:

IOException - an error occurs during IO operation.