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

All Implemented Interfaces:

Encodable, Serializable
```
public final class ClientContext
extends Object
implements Serializable, Encodable
```
The ClientContext class holds the data related to a connection context. Contexts are only reloaded during a broker restart to allow them to be cleaned up, they are then immediately deleted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ClientContext.ClientContextFactory

(package private) static class ClientContext.MultiReplyContext

Field Summary

Fields
Modifier and Type	Field	Description
`private Vector<String>`	`activeSubs`	Vector of active subscriptions' names.
`private int`	`cancelledRequestId`	Identifier of a cancelled "receive" request, set when a PTP listener has been unset.
`private Hashtable<Integer,ClientContext.MultiReplyContext>`	`commitTable`	Contexts waiting for the replies from some local agents
`private static boolean`	`DEBUG`
`private Hashtable<AgentId,AgentId>`	`deliveringQueues`	Identifiers of queues delivering messages.
`private boolean`	`first`
`private int`	`id`	Context identifier.
`static Logger`	`logger`	logger
`private boolean`	`modified`
`private ProxyAgentItf`	`proxy`	An handle to proxy Agent
`private AgentId`	`proxyId`	The proxy's agent identifier
`private Vector<AbstractJmsReply>`	`repliesBuffer`	Pending replies waiting for the context to be activated.
`private static long`	`serialVersionUID`	define serialVersionUID for interoperability
`private boolean`	`started`	`true` if the context is activated.
`private Vector<AgentId>`	`tempDestinations`	Vector of temporary destinations.
`private Hashtable<Xid,XACnxPrepare>`	`transactionsTable`	Prepared transactions objects waiting for commit.
`private String`	`txName`

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

ClientContext()

ClientContext(AgentId proxyId, int id)
Constructs a ClientContext instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`addDeliveringQueue(AgentId queueId)`	Adds, if not already, the identifier of a delivering queue.
`(package private) void`	`addMultiReplyContext(int requestId, int asyncReplyCount)`	Some requests may require to wait for several SendReplyNot notifications before replying to the client.
`(package private) void`	`addPendingDelivery(AbstractJmsReply reply)`	Adds a pending delivery.
`(package private) void`	`addSubName(String subName)`	Adds an active subscription name.
`(package private) void`	`addTemporaryDestination(AgentId destId)`	Adds a temporary destination identifier.
`(package private) void`	`cancelReceive(int cancelledRequestId)`	Cancels a "receive" request.
`(package private) void`	`clearPendingDeliveries()`	Clears the pending deliveries buffer.
`void`	`decode(Decoder decoder)`	Decodes the content of this object
`void`	`delete()`
`void`	`encode(Encoder encoder)`	Encodes the content of this object
`(package private) List<String>`	`getActiveSubList()`
`(package private) Iterator<String>`	`getActiveSubs()`	Returns the active subscriptions' names.
`(package private) int`	`getCancelledReceive()`	Returns the cancelled "receive" request identifier.
`(package private) Iterator<AgentId>`	`getDeliveringQueues()`	Returns the identifiers of the delivering queues.
`(package private) Map<AgentId,AgentId>`	`getDeliveringQueueTable()`
`int`	`getEncodableClassId()`	Returns a unique class identifier.
`int`	`getEncodedSize()`	Returns the size of the byte array that results from the encoding of this object.
`(package private) int`	`getId()`	Returns the identifier of the context.
`(package private) Iterator<AbstractJmsReply>`	`getPendingDeliveries()`	Returns the pending deliveries.
`AgentId`	`getProxyId()`
`(package private) List<AgentId>`	`getTempDestinationList()`
`(package private) Iterator<AgentId>`	`getTempDestinations()`
`static String`	`getTransactionPrefix(AgentId proxyId)`
`(package private) Hashtable<Xid,XACnxPrepare>`	`getTransactionsTable()`
`(package private) Iterator<Xid>`	`getTxIds()`	Returns the identifiers of the prepared transactions.
`String`	`getTxName()`
`(package private) XACnxPrepare`	`getTxPrepare(Object key)`	Returns and deletes a given transaction "prepare".
`(package private) boolean`	`isActivated()`	Returns `true` if the context is activated.
`boolean`	`isPrepared(Object key)`
`static ClientContext`	`load(String txName)`
`(package private) void`	`registerTxPrepare(Object key, XACnxPrepare prepare)`	Registers a given transaction "prepare".
`(package private) void`	`removeSubName(String subName)`	Removes an active subscription name.
`(package private) void`	`removeTemporaryDestination(AgentId destId)`	Removes a temporary destination identifier.
`void`	`save()`
`(package private) void`	`setActivated(boolean started)`	Sets the activation status of the context.
`private void`	`setModified()`
`(package private) void`	`setProxyAgent(ProxyAgentItf proxy)`
`(package private) int`	`setReply(int requestId)`	Called by UserAgent when a SendReplyNot arrived.
`String`	`toString()`

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
```
public static final Logger logger
```
    logger
  - DEBUG
```
private static final boolean DEBUG
```
  - id
```
private int id
```
    Context identifier.
  - tempDestinations
```
private Vector<AgentId> tempDestinations
```
    Vector of temporary destinations.
  - deliveringQueues
```
private Hashtable<AgentId,AgentId> deliveringQueues
```
    Identifiers of queues delivering messages.
  - transactionsTable
```
private Hashtable<Xid,XACnxPrepare> transactionsTable
```
    Prepared transactions objects waiting for commit.
  - started
```
private transient boolean started
```
    true if the context is activated.
  - cancelledRequestId
```
private transient int cancelledRequestId
```
    Identifier of a cancelled "receive" request, set when a PTP listener has been unset.
  - activeSubs
```
private transient Vector<String> activeSubs
```
    Vector of active subscriptions' names.
  - repliesBuffer
```
private transient Vector<AbstractJmsReply> repliesBuffer
```
    Pending replies waiting for the context to be activated.
  - commitTable
```
private transient Hashtable<Integer,ClientContext.MultiReplyContext> commitTable
```
    Contexts waiting for the replies from some local agents
  - proxyId
```
private AgentId proxyId
```
    The proxy's agent identifier
  - proxy
```
private transient ProxyAgentItf proxy
```
    An handle to proxy Agent
  - txName
```
private transient String txName
```
  - modified
```
private transient boolean modified
```
  - first
```
private transient boolean first
```
- Constructor Detail
  - ClientContext
```
ClientContext()
```
  - ClientContext
```
ClientContext(AgentId proxyId,
              int id)
```
    Constructs a ClientContext instance.
    
    Parameters:
    
    proxyId - The proxy's agent identifier.
    
    id - Identifier of the context.
- Method Detail
  - getId
```
int getId()
```
    Returns the identifier of the context.
  - addTemporaryDestination
```
void addTemporaryDestination(AgentId destId)
```
    Adds a temporary destination identifier.
  - getTempDestinations
```
Iterator<AgentId> getTempDestinations()
```
  - removeTemporaryDestination
```
void removeTemporaryDestination(AgentId destId)
```
    Removes a temporary destination identifier.
  - addDeliveringQueue
```
void addDeliveringQueue(AgentId queueId)
```
    Adds, if not already, the identifier of a delivering queue.
  - getDeliveringQueues
```
Iterator<AgentId> getDeliveringQueues()
```
    Returns the identifiers of the delivering queues.
  - setActivated
```
void setActivated(boolean started)
```
    Sets the activation status of the context.
  - isActivated
```
boolean isActivated()
```
    Returns true if the context is activated.
  - cancelReceive
```
void cancelReceive(int cancelledRequestId)
```
    Cancels a "receive" request.
  - getCancelledReceive
```
int getCancelledReceive()
```
    Returns the cancelled "receive" request identifier.
  - addSubName
```
void addSubName(String subName)
```
    Adds an active subscription name.
  - getActiveSubs
```
Iterator<String> getActiveSubs()
```
    Returns the active subscriptions' names.
  - removeSubName
```
void removeSubName(String subName)
```
    Removes an active subscription name.
  - addPendingDelivery
```
void addPendingDelivery(AbstractJmsReply reply)
```
    Adds a pending delivery.
  - getPendingDeliveries
```
Iterator<AbstractJmsReply> getPendingDeliveries()
```
    Returns the pending deliveries.
  - clearPendingDeliveries
```
void clearPendingDeliveries()
```
    Clears the pending deliveries buffer.
  - addMultiReplyContext
```
void addMultiReplyContext(int requestId,
                          int asyncReplyCount)
```
    Some requests may require to wait for several SendReplyNot notifications before replying to the client.
    
    Parameters:
    
    requestId -
    
    asyncReplyCount -
  - getProxyId
```
public AgentId getProxyId()
```
  - setProxyAgent
```
void setProxyAgent(ProxyAgentItf proxy)
```
  - setModified
```
private final void setModified()
```
  - setReply
```
int setReply(int requestId)
```
    Called by UserAgent when a SendReplyNot arrived.
    
    Parameters:
    
    requestId -
    
    Returns:
    
    > 0 if there are still some pending replies, 0 if all the replies arrived (the context is removed) or if the context doesn't exist
  - registerTxPrepare
```
void registerTxPrepare(Object key,
                       XACnxPrepare prepare)
                throws Exception
```
    Registers a given transaction "prepare".
    
    Throws:
    
    Exception
  - getTxPrepare
```
XACnxPrepare getTxPrepare(Object key)
```
    Returns and deletes a given transaction "prepare".
  - isPrepared
```
public boolean isPrepared(Object key)
```
    Parameters:
    
    key - XID
    
    Returns:
    
    true if prepared transation.
  - getTxIds
```
Iterator<Xid> getTxIds()
```
    Returns the identifiers of the prepared transactions.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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
  - getTransactionPrefix
```
public static String getTransactionPrefix(AgentId proxyId)
```
  - getTxName
```
public final String getTxName()
```
  - load
```
public static final ClientContext load(String txName)
                                throws Exception
```
    Throws:
    
    Exception
  - save
```
public final void save()
```
  - delete
```
public void delete()
```
  - getActiveSubList
```
List<String> getActiveSubList()
```
  - getDeliveringQueueTable
```
Map<AgentId,AgentId> getDeliveringQueueTable()
```
  - getTempDestinationList
```
List<AgentId> getTempDestinationList()
```
  - getTransactionsTable
```
Hashtable<Xid,XACnxPrepare> getTransactionsTable()
```

Modifier and Type	Class	Description
`static class`	`ClientContext.ClientContextFactory`
`(package private) static class`	`ClientContext.MultiReplyContext`

Constructor	Description
`ClientContext()`
`ClientContext(AgentId proxyId, int id)`	Constructs a `ClientContext` instance.

Class ClientContext

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

id

tempDestinations

deliveringQueues

transactionsTable

started

cancelledRequestId

activeSubs

repliesBuffer

commitTable

proxyId

proxy

txName

modified

first

Constructor Detail

ClientContext

ClientContext

Method Detail

getId

addTemporaryDestination

getTempDestinations

removeTemporaryDestination

addDeliveringQueue

getDeliveringQueues

setActivated

isActivated

cancelReceive

getCancelledReceive

addSubName

getActiveSubs

removeSubName

addPendingDelivery

getPendingDeliveries

clearPendingDeliveries

addMultiReplyContext

getProxyId

setProxyAgent

setModified

setReply

registerTxPrepare

getTxPrepare

isPrepared

getTxIds

toString

getEncodableClassId

getEncodedSize

encode

decode

getTransactionPrefix

getTxName

load

save

delete

getActiveSubList

getDeliveringQueueTable

getTempDestinationList

getTransactionsTable