java.lang.Object
- org.objectweb.joram.mom.proxies.ClientSubscription

All Implemented Interfaces:

Encodable, Serializable, ClientSubscriptionMBean
```
public final class ClientSubscription
extends Object
implements ClientSubscriptionMBean, Serializable, Encodable
```
The ClientSubscription class holds the data of a client subscription, and the methods managing the delivery and acknowledgement of the messages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ClientSubscription.ClientSubscriptionFactory

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`active`	Give the maximum number of messages per request if the subscription is active, 0 if the subscription is passive.
`private String`	`clientID`
`private int`	`contextId`	Identifier of the subscription context.
`private static boolean`	`DEBUG`
`private Map<String,String>`	`deliveredIds`	Table of delivered messages identifiers.
`private Map<String,Integer>`	`deniedMsgs`	Table keeping the denied messages identifiers.
`private AgentId`	`dmqId`	Identifier of the subscriber's dead message queue, `null` for DMQ not set.
`private boolean`	`durable`	`true` if the subscription is durable.
`private static Logger`	`logger`
`static int`	`MAX_NUMBER_OF_MSG_PER_REQUEST`
`static String`	`MAX_NUMBER_OF_MSG_PER_REQUEST_PROPERTY`
`static String`	`MESSAGE_ID_LIST_PREFIX`
`static String`	`MESSAGE_TIME_ID_LIST_PREFIX`
`private MessageIdList`	`messageIds`	List of identifiers of the messages to deliver.
`private MessageTable`	`messagesTable`	Proxy messages table.
`private MessageIdList`	`messageTimeIds`	List of identifiers of the messages delivery time.
`private boolean`	`modified`	Transient should be useless, should only be used via the engine thread..
`private String`	`name`	The subscription name.
`private int`	`nbMaxMsg`	Max number of Message stored in the queue (-1 no limit).
`private long`	`nbMsgsDeliveredSinceCreation`	the number of delivered messages
`private long`	`nbMsgsSentToDMQSinceCreation`	the number of erroneous messages forwarded to the DMQ
`private boolean`	`noFiltering`	`true` if the subscription does not filter messages in any way.
`private boolean`	`noLocal`	`true` if the subscriber does not wish to consume messages published in the same context.
`private ProxyAgentItf`	`proxy`	An handle to proxy Agent
`private AgentId`	`proxyId`	The proxy's agent identifier.
`private long`	`requestExpTime`	Expiration time of the "receive" request, if any.
`private int`	`requestId`	Identifier of the request requesting messages, either the listener's request, or a "receive" request.
`private String`	`selector`	The selector for filtering messages.
`private static long`	`serialVersionUID`	define serialVersionUID for interoperability
`private int`	`subRequestId`	Identifier of the subscription request.
`private int`	`threshold`	Threshold above which messages are considered as undeliverable because constantly denied. 0 stands for no threshold, -1 for value not set (use servers' default value).
`private boolean`	`toListener`	`true` if the messages are destinated to a listener.
`private AgentId`	`topicId`	The topic identifier.
`private String`	`txName`	Transient should be useless, should only be used via the engine thread..

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
`ClientSubscription()`
`ClientSubscription(AgentId proxyId, int contextId, int reqId, boolean durable, AgentId topicId, String name, String selector, boolean noLocal, AgentId dmqId, int threshold, int nbMaxMsg, MessageTable messagesTable, String clientID)`	Constructs a `ClientSubscription` instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`acknowledge(String id)`
`(package private) void`	`acknowledge(Iterator<String> acks)`	Acknowledges messages.
`(package private) void`	`browseNewMessages(List<Message> newMessages)`	Browses messages and keeps those which will have to be delivered to the subscriber.
`void`	`clear()`	Deletes all messages
`(package private) void`	`deactivate(boolean denies)`	De-activates the subscription.
`void`	`decode(Decoder decoder)`	Decodes the content of this object
`private void`	`decrAckCounters(String msgId, Message message)`
`void`	`delete()`
`void`	`deleteMessage(String msgId)`	Deletes a particular pending message in the subscription.
`(package private) void`	`deleteMessages()`	Decreases the subscription's messages acknowledgement expectations, deletes those not to be consumed anymore.
`(package private) ConsumerMessages`	`deliver()`	Launches a delivery sequence, either for a listener, or for a receiver.
`(package private) void`	`deny(Iterator<String> denies, boolean redelivered)`	Denies messages.
`private void`	`deny(Iterator<String> denies, boolean remove, boolean redelivered)`	Denies the messages.
`void`	`encode(Encoder encoder)`	Encodes the content of this object
`int`	`getActive()`	Returns the maximum number of messages per request if the subscription is active.
`(package private) String`	`getClientID()`	Only used in tests.
`int`	`getContextId()`	Returns the subscription's context identifier.
`(package private) Map<String,String>`	`getDeliveredIds()`	Only used in tests.
`int`	`getDeliveredMessageCount()`	Returns the number of messages delivered and waiting for acknowledge.
`(package private) Map<String,Integer>`	`getDeniedMsgs()`	Only used in tests.
`boolean`	`getDurable()`	Returns `true` if the subscription is durable.
`int`	`getEncodableClassId()`	Returns a unique class identifier.
`int`	`getEncodedSize()`	Returns the size of the byte array that results from the encoding of this object.
`CompositeData`	`getMessage(String msgId)`	Returns the description of a particular pending message.
`String[]`	`getMessageIds()`	Returns the list of message's identifiers for the subscription.
`TabularData`	`getMessages()`	Returns the description of all pending messages.
`List<MessageView>`	`getMessagesView()`	Only used from shell-mom MOMCommandsImpl.
`String`	`getName()`	Returns the name of the subscription.
`int`	`getNbMaxMsg()`	Returns the maximum number of message for the subscription.
`long`	`getNbMsgsDeliveredSinceCreation()`	Returns the number of messages delivered to the client since creation time of this subscription.
`long`	`getNbMsgsSentToDMQSinceCreation()`	Returns the number of erroneous messages forwarded to the DMQ since creation time of this subscription.
`int`	`getPendingDeliveryTimeMessageCount()`	Returns the number of pending delivery time messages for the subscription.
`int`	`getPendingMessageCount()`	Returns the number of pending messages for the subscription.
`String`	`getSelector()`	Returns the selector.
`(package private) Message`	`getSubMessage(String msgId)`
`int`	`getSubRequestId()`	Returns the identifier of the subscribing request.
`(package private) Message`	`getSubscriptionMessage(String msgId)`
`int`	`getThreshold()`	Returns the threshold above which messages are considered undeliverable because constantly denied.
`AgentId`	`getTopicId()`	Returns the identifier of the subscription topic.
`String`	`getTopicIdAsString()`	Returns the identifier of the subscription topic.
`static String`	`getTransactionPrefix(AgentId proxyId)`
`private String`	`getTxName()`
`void`	`initMessageIds()`
`private boolean`	`isUndeliverable(int deliveryAttempts)`	Returns `true` if a given message is considered as undeliverable, because its delivery count matches the subscription's threshold, if any, or the server's default threshold value (if any).
`static ClientSubscription`	`load(String txName)`
`void`	`loadMessageIds()`
`(package private) void`	`reactivate(int contextId, int reqId, AgentId topicId, String selector, boolean noLocal)`	Reactivates the subscription.
`(package private) void`	`reinitialize(MessageTable messagesTable, List<Message> persistedMessages, boolean denyDeliveredMessages)`	Re-initializes the client subscription.
`(package private) Message`	`removeMessage(String msgId)`	Removes a particular pending message in the subscription.
`(package private) void`	`removeMessagesTimeIds(String msgId)`
`void`	`save()`
`(package private) void`	`scheduleDeliveryTimeMessage(Message message)`	schedule the delivery time message.
`(package private) void`	`setActive(int active)`
`(package private) void`	`setDMQId(AgentId dmqId)`	Sets the subscription's dead message queue identifier.
`(package private) void`	`setListener(int requestId)`	Sets a listener.
`private void`	`setModified()`
`void`	`setNbMaxMsg(int nbMaxMsg)`	Sets the maximum number of message for the subscription.
`(package private) void`	`setProxyAgent(ProxyAgentItf proxy)`
`(package private) void`	`setReceiver(int requestId, long timeToLive)`	Sets a receiver request.
`void`	`setThreshold(int threshold)`	Sets the subscription's threshold value.
`String`	`toString()`
`(package private) void`	`unsetListener()`	Unsets the listener.
`(package private) void`	`unsetReceiver()`	Unsets a receiver request.

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
  - logger
```
private static final Logger logger
```
  - DEBUG
```
private static final boolean DEBUG
```
  - MESSAGE_ID_LIST_PREFIX
```
public static final String MESSAGE_ID_LIST_PREFIX
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TIME_ID_LIST_PREFIX
```
public static final String MESSAGE_TIME_ID_LIST_PREFIX
```
    See Also:
    
    Constant Field Values
  - proxyId
```
private AgentId proxyId
```
    The proxy's agent identifier.
  - proxy
```
private transient ProxyAgentItf proxy
```
    An handle to proxy Agent
  - durable
```
private boolean durable
```
    true if the subscription is durable.
  - topicId
```
private AgentId topicId
```
    The topic identifier.
  - name
```
private String name
```
    The subscription name.
  - selector
```
private String selector
```
    The selector for filtering messages.
  - dmqId
```
private AgentId dmqId
```
    Identifier of the subscriber's dead message queue, null for DMQ not set.
  - threshold
```
private int threshold
```
    Threshold above which messages are considered as undeliverable because constantly denied. 0 stands for no threshold, -1 for value not set (use servers' default value).
  - nbMaxMsg
```
private int nbMaxMsg
```
    Max number of Message stored in the queue (-1 no limit).
  - messageIds
```
private transient MessageIdList messageIds
```
    List of identifiers of the messages to deliver.
  - messageTimeIds
```
private transient MessageIdList messageTimeIds
```
    List of identifiers of the messages delivery time.
  - deliveredIds
```
private Map<String,String> deliveredIds
```
    Table of delivered messages identifiers.
  - deniedMsgs
```
private Map<String,Integer> deniedMsgs
```
    Table keeping the denied messages identifiers.
  - contextId
```
private transient int contextId
```
    Identifier of the subscription context.
  - subRequestId
```
private transient int subRequestId
```
    Identifier of the subscription request.
  - noLocal
```
private transient boolean noLocal
```
    true if the subscriber does not wish to consume messages published in the same context.
  - noFiltering
```
private transient boolean noFiltering
```
    true if the subscription does not filter messages in any way.
  - active
```
private transient int active
```
    Give the maximum number of messages per request if the subscription is active, 0 if the subscription is passive.
  - requestId
```
private transient int requestId
```
    Identifier of the request requesting messages, either the listener's request, or a "receive" request.
  - toListener
```
private transient boolean toListener
```
    true if the messages are destinated to a listener.
  - requestExpTime
```
private transient long requestExpTime
```
    Expiration time of the "receive" request, if any.
  - messagesTable
```
private transient MessageTable messagesTable
```
    Proxy messages table. Be careful: currently this table is shared between all subscription.
  - nbMsgsSentToDMQSinceCreation
```
private long nbMsgsSentToDMQSinceCreation
```
    the number of erroneous messages forwarded to the DMQ
  - nbMsgsDeliveredSinceCreation
```
private long nbMsgsDeliveredSinceCreation
```
    the number of delivered messages
  - MAX_NUMBER_OF_MSG_PER_REQUEST_PROPERTY
```
public static final String MAX_NUMBER_OF_MSG_PER_REQUEST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MAX_NUMBER_OF_MSG_PER_REQUEST
```
public static final int MAX_NUMBER_OF_MSG_PER_REQUEST
```
  - txName
```
private transient String txName
```
    Transient should be useless, should only be used via the engine thread..
  - modified
```
private transient boolean modified
```
    Transient should be useless, should only be used via the engine thread..
  - clientID
```
private String clientID
```
- Constructor Detail
  - ClientSubscription
```
ClientSubscription()
```
  - ClientSubscription
```
ClientSubscription(AgentId proxyId,
                   int contextId,
                   int reqId,
                   boolean durable,
                   AgentId topicId,
                   String name,
                   String selector,
                   boolean noLocal,
                   AgentId dmqId,
                   int threshold,
                   int nbMaxMsg,
                   MessageTable messagesTable,
                   String clientID)
            throws RequestException
```
    Constructs a ClientSubscription instance.
    
    Parameters:
    
    proxyId - Proxy's identifier.
    
    contextId - Context identifier.
    
    reqId - Request identifier.
    
    durable - true for a durable subscription.
    
    topicId - Topic identifier.
    
    name - Subscription's name.
    
    selector - Selector for filtering messages.
    
    noLocal - true for not consuming messages published within the same proxy's context.
    
    dmqId - Identifier of the proxy's dead message queue, if any.
    
    threshold - Proxy's threshold value, if any.
    
    messagesTable - Proxy's messages table.
    
    clientID - the clientID
    
    Throws:
    
    RequestException
- Method Detail
  - setProxyAgent
```
void setProxyAgent(ProxyAgentItf proxy)
```
  - getDurable
```
public boolean getDurable()
```
    Returns true if the subscription is durable.
    
    Specified by:
    
    getDurable in interface ClientSubscriptionMBean
  - getTopicId
```
public AgentId getTopicId()
```
    Returns the identifier of the subscription topic.
  - getName
```
public String getName()
```
    Returns the name of the subscription.
    
    Specified by:
    
    getName in interface ClientSubscriptionMBean
  - getSelector
```
public String getSelector()
```
    Returns the selector.
    
    Specified by:
    
    getSelector in interface ClientSubscriptionMBean
  - getThreshold
```
public int getThreshold()
```
    Returns the threshold above which messages are considered undeliverable because constantly denied.
    
    Specified by:
    
    getThreshold in interface ClientSubscriptionMBean
    
    Returns:
    
    the threshold if set; -1 otherwise.
  - setThreshold
```
public void setThreshold(int threshold)
```
    Sets the subscription's threshold value.
  - getNbMaxMsg
```
public int getNbMaxMsg()
```
    Returns the maximum number of message for the subscription. If the limit is unset the method returns -1.
    
    Specified by:
    
    getNbMaxMsg in interface ClientSubscriptionMBean
    
    Returns:
    
    the maximum number of message for subscription if set; -1 otherwise.
  - setNbMaxMsg
```
public void setNbMaxMsg(int nbMaxMsg)
```
    Sets the maximum number of message for the subscription.
    
    Specified by:
    
    setNbMaxMsg in interface ClientSubscriptionMBean
    
    Parameters:
    
    nbMaxMsg - the maximum number of message for subscription (-1 set no limit).
  - getPendingMessageCount
```
public int getPendingMessageCount()
```
    Returns the number of pending messages for the subscription.
    
    Specified by:
    
    getPendingMessageCount in interface ClientSubscriptionMBean
    
    Returns:
    
    The number of pending message for the subscription.
  - getPendingDeliveryTimeMessageCount
```
public int getPendingDeliveryTimeMessageCount()
```
    Returns the number of pending delivery time messages for the subscription.
    
    Returns:
    
    The number of pending delivery time message for the subscription.
  - getDeliveredIds
```
Map<String,String> getDeliveredIds()
```
    Only used in tests.
  - getDeniedMsgs
```
Map<String,Integer> getDeniedMsgs()
```
    Only used in tests.
  - getContextId
```
public int getContextId()
```
    Returns the subscription's context identifier.
    
    Specified by:
    
    getContextId in interface ClientSubscriptionMBean
  - getSubRequestId
```
public int getSubRequestId()
```
    Returns the identifier of the subscribing request.
    
    Specified by:
    
    getSubRequestId in interface ClientSubscriptionMBean
  - getActive
```
public int getActive()
```
    Returns the maximum number of messages per request if the subscription is active.
    
    Specified by:
    
    getActive in interface ClientSubscriptionMBean
  - setActive
```
void setActive(int active)
```
  - setModified
```
private void setModified()
```
  - getClientID
```
String getClientID()
```
    Only used in tests.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDeliveredMessageCount
```
public int getDeliveredMessageCount()
```
    Returns the number of messages delivered and waiting for acknowledge.
    
    Specified by:
    
    getDeliveredMessageCount in interface ClientSubscriptionMBean
    
    Returns:
    
    The number of messages delivered and waiting for acknowledge.
  - getMessageIds
```
public String[] getMessageIds()
```
    Returns the list of message's identifiers for the subscription.
    
    Specified by:
    
    getMessageIds in interface ClientSubscriptionMBean
    
    Returns:
    
    the list of message's identifiers for the subscription.
  - reinitialize
```
void reinitialize(MessageTable messagesTable,
                  List<Message> persistedMessages,
                  boolean denyDeliveredMessages)
```
    Re-initializes the client subscription.
    
    Parameters:
    
    messagesTable - Proxy's table where storing the messages.
    
    persistedMessages - Proxy's persisted messages.
    
    denyDeliveredMessages - Denies already delivered messages.
  - reactivate
```
void reactivate(int contextId,
                int reqId,
                AgentId topicId,
                String selector,
                boolean noLocal)
```
    Reactivates the subscription.
    
    Parameters:
    
    contextId - Re-activation context.
    
    reqId - Re-activation request identifier.
    
    topicId - Topic identifier.
    
    selector - Selector for filtering messages.
    
    noLocal - true for not consuming messages published within the same proxy's context.
  - deactivate
```
void deactivate(boolean denies)
```
    De-activates the subscription.
    
    Parameters:
    
    denies - denies the non acknowledged messages.
  - setListener
```
void setListener(int requestId)
```
    Sets a listener.
    
    Parameters:
    
    requestId - Identifier of the listener request.
  - unsetListener
```
void unsetListener()
```
    Unsets the listener.
  - setReceiver
```
void setReceiver(int requestId,
                 long timeToLive)
```
    Sets a receiver request.
    
    Parameters:
    
    requestId - Identifier of the "receive" request.
    
    timeToLive - Request's time to live value.
  - unsetReceiver
```
void unsetReceiver()
```
    Unsets a receiver request.
  - setDMQId
```
void setDMQId(AgentId dmqId)
```
    Sets the subscription's dead message queue identifier.
  - scheduleDeliveryTimeMessage
```
void scheduleDeliveryTimeMessage(Message message)
```
    schedule the delivery time message.
    
    Parameters:
    
    message - the message.
  - removeMessagesTimeIds
```
void removeMessagesTimeIds(String msgId)
```
  - browseNewMessages
```
void browseNewMessages(List<Message> newMessages)
```
    Browses messages and keeps those which will have to be delivered to the subscriber.
  - deliver
```
ConsumerMessages deliver()
```
    Launches a delivery sequence, either for a listener, or for a receiver.
  - acknowledge
```
void acknowledge(Iterator<String> acks)
```
    Acknowledges messages.
  - acknowledge
```
void acknowledge(String id)
```
  - deny
```
void deny(Iterator<String> denies,
          boolean redelivered)
```
    Denies messages.
    
    Parameters:
    
    denies - all ids of the messages to deny
    
    redelivered - true if redelivered.
  - deny
```
private void deny(Iterator<String> denies,
                  boolean remove,
                  boolean redelivered)
```
    Denies the messages.
    
    Parameters:
    
    denies - all ids of the messages to deny
    
    remove - true to remove messages from deliveredIds map. Must be false when denies iterates over deliveredIds map keys, to avoid a ConcurrentModificationException.
    
    redelivered - true if redelivered.
  - deleteMessages
```
void deleteMessages()
```
    Decreases the subscription's messages acknowledgement expectations, deletes those not to be consumed anymore.
  - isUndeliverable
```
private boolean isUndeliverable(int deliveryAttempts)
```
    Returns true if a given message is considered as undeliverable, because its delivery count matches the subscription's threshold, if any, or the server's default threshold value (if any).
  - getNbMsgsSentToDMQSinceCreation
```
public long getNbMsgsSentToDMQSinceCreation()
```
    Description copied from interface: ClientSubscriptionMBean
    
    Returns the number of erroneous messages forwarded to the DMQ since creation time of this subscription.
    
    Specified by:
    
    getNbMsgsSentToDMQSinceCreation in interface ClientSubscriptionMBean
    
    Returns:
    
    the number of erroneous messages forwarded to the DMQ.
  - getNbMsgsDeliveredSinceCreation
```
public long getNbMsgsDeliveredSinceCreation()
```
    Description copied from interface: ClientSubscriptionMBean
    
    Returns the number of messages delivered to the client since creation time of this subscription.
    
    Specified by:
    
    getNbMsgsDeliveredSinceCreation in interface ClientSubscriptionMBean
    
    Returns:
    
    the number of delivered messages.
  - getSubscriptionMessage
```
Message getSubscriptionMessage(String msgId)
```
  - getSubMessage
```
Message getSubMessage(String msgId)
```
  - deleteMessage
```
public void deleteMessage(String msgId)
```
    Description copied from interface: ClientSubscriptionMBean
    
    Deletes a particular pending message in the subscription. The message is pointed out through its unique identifier.
    
    Specified by:
    
    deleteMessage in interface ClientSubscriptionMBean
    
    Parameters:
    
    msgId - The unique message's identifier.
  - clear
```
public void clear()
```
    Description copied from interface: ClientSubscriptionMBean
    
    Deletes all messages
    
    Specified by:
    
    clear in interface ClientSubscriptionMBean
  - removeMessage
```
Message removeMessage(String msgId)
```
    Removes a particular pending message in the subscription. The message is pointed out through its unique identifier.
    
    Parameters:
    
    msgId - The unique message's identifier.
  - decrAckCounters
```
private void decrAckCounters(String msgId,
                             Message message)
```
  - getMessage
```
public CompositeData getMessage(String msgId)
                         throws Exception
```
    Returns the description of a particular pending message. The message is pointed out through its unique identifier.
    
    Specified by:
    
    getMessage in interface ClientSubscriptionMBean
    
    Parameters:
    
    msgId - The unique message's identifier.
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getMessages
```
public TabularData getMessages()
                        throws Exception
```
    Returns the description of all pending messages.
    
    Specified by:
    
    getMessages in interface ClientSubscriptionMBean
    
    Returns:
    
    the description of the message.
    
    Throws:
    
    Exception
    
    See Also:
    
    MessageJMXWrapper
  - getMessagesView
```
public List<MessageView> getMessagesView()
```
    Only used from shell-mom MOMCommandsImpl.
  - getTopicIdAsString
```
public String getTopicIdAsString()
```
    Returns the identifier of the subscription topic. Only used from shell-mom MOMCommandsImpl.
    
    Specified by:
    
    getTopicIdAsString in interface ClientSubscriptionMBean
  - getTransactionPrefix
```
public static String getTransactionPrefix(AgentId proxyId)
```
  - initMessageIds
```
public void initMessageIds()
                    throws Exception
```
    Throws:
    
    Exception
  - loadMessageIds
```
public void loadMessageIds()
                    throws Exception
```
    Throws:
    
    Exception
  - getTxName
```
private final String getTxName()
```
  - load
```
public static final ClientSubscription load(String txName)
                                     throws Exception
```
    Throws:
    
    Exception
  - save
```
public void save()
```
  - delete
```
public void delete()
```
  - getEncodableClassId
```
public int getEncodableClassId()
```
    Description copied from interface: Encodable
    
    Returns a unique class identifier.
    
    Specified by:
    
    getEncodableClassId in interface Encodable
    
    Returns:
    
    a unique class identifier
  - getEncodedSize
```
public int getEncodedSize()
                   throws Exception
```
    Description copied from interface: Encodable
    
    Returns the size of the byte array that results from the encoding of this object.
    
    Specified by:
    
    getEncodedSize in interface Encodable
    
    Returns:
    
    the size of the encoded byte array
    
    Throws:
    
    Exception - if an error occurs
  - encode
```
public void encode(Encoder encoder)
            throws Exception
```
    Description copied from interface: Encodable
    
    Encodes the content of this object
    
    Specified by:
    
    encode in interface Encodable
    
    Parameters:
    
    encoder - the encoder to be used for the encoding
    
    Throws:
    
    Exception - if an error occurs
  - decode
```
public void decode(Decoder decoder)
            throws Exception
```
    Description copied from interface: Encodable
    
    Decodes the content of this object
    
    Specified by:
    
    decode in interface Encodable
    
    Parameters:
    
    decoder - the decoder to be used for the decoding
    
    Throws:
    
    Exception - if an error occurs

Class ClientSubscription

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

logger

DEBUG

MESSAGE_ID_LIST_PREFIX

MESSAGE_TIME_ID_LIST_PREFIX

proxyId

proxy

durable

topicId

name

selector

dmqId

threshold

nbMaxMsg

messageIds

messageTimeIds

deliveredIds

deniedMsgs

contextId

subRequestId

noLocal

noFiltering

active

requestId

toListener

requestExpTime

messagesTable

nbMsgsSentToDMQSinceCreation

nbMsgsDeliveredSinceCreation

MAX_NUMBER_OF_MSG_PER_REQUEST_PROPERTY

MAX_NUMBER_OF_MSG_PER_REQUEST

txName

modified

clientID

Constructor Detail

ClientSubscription

ClientSubscription

Method Detail

setProxyAgent

getDurable

getTopicId

getName

getSelector

getThreshold

setThreshold

getNbMaxMsg

setNbMaxMsg

getPendingMessageCount

getPendingDeliveryTimeMessageCount

getDeliveredIds

getDeniedMsgs

getContextId

getSubRequestId

getActive

setActive

setModified

getClientID

toString

getDeliveredMessageCount

getMessageIds

reinitialize

reactivate

deactivate

setListener

unsetListener

setReceiver

unsetReceiver

setDMQId

scheduleDeliveryTimeMessage

removeMessagesTimeIds

browseNewMessages

deliver