org.jboss.web.tomcat.service.session.distributedcache.spi
Interface DistributedCacheConvergedSipManager<T extends org.jboss.web.tomcat.service.session.distributedcache.spi.OutgoingDistributableSessionData>

All Superinterfaces:
org.jboss.web.tomcat.service.session.distributedcache.spi.DistributedCacheManager<T>
All Known Implementing Classes:
AttributeBasedJBossCacheConvergedSipService, FieldBasedJBossCacheConvergedSipService, SessionBasedJBossCacheConvergedSipService

public interface DistributedCacheConvergedSipManager<T extends org.jboss.web.tomcat.service.session.distributedcache.spi.OutgoingDistributableSessionData>
extends org.jboss.web.tomcat.service.session.distributedcache.spi.DistributedCacheManager<T>

Author:
jean.deruelle@gmail.com

Method Summary
 void evictSipApplicationSession(java.lang.String key)
          Evict a sip application session from the in-memory portion of the distributed cache, on this node only.
 void evictSipApplicationSession(java.lang.String key, java.lang.String dataOwner)
          Evict a non-locally-active sip application session from the in-memory portion of the distributed cache, on this node only.
 void evictSipSession(java.lang.String sipAppSessionKey, java.lang.String key)
          Evict a sip session from the in-memory portion of the distributed cache, on this node only.
 void evictSipSession(java.lang.String sipAppSessionKey, java.lang.String key, java.lang.String dataOwner)
          Evict a non-locally-active sip session from the in-memory portion of the distributed cache, on this node only.
 java.util.Map<java.lang.String,java.lang.Object> getConvergedSessionAttributes(java.lang.String realId, java.util.Map<java.lang.Object,java.lang.Object> distributedCacheData)
           
 org.jboss.cache.Cache getJBossCache()
           
 java.lang.Object getSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String key)
          Get the value of the attribute with the given key from the given session.
 java.util.Set<java.lang.String> getSipApplicationSessionAttributeKeys(java.lang.String sipApplicationSessionKey)
          Obtain the attribute keys associated with this session.
 java.util.Map<java.lang.String,java.lang.Object> getSipApplicationSessionAttributes(java.lang.String sipApplicationSessionKey)
          Return all attributes associated with this session id.
 org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipApplicationSessionData(java.lang.String key, boolean initialLoad)
          Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip application session.
 org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipApplicationSessionData(java.lang.String key, java.lang.String dataOwner, boolean includeAttributes)
          Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip application session.
 java.util.Map<java.lang.String,java.lang.String> getSipApplicationSessionKeys()
          Gets the ids of all sip application sessions in the underlying cache.
 java.lang.Object getSipSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey, java.lang.String key)
          Get the value of the attribute with the given key from the given session.
 java.util.Set<java.lang.String> getSipSessionAttributeKeys(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey)
          Obtain the attribute keys associated with this session.
 java.util.Map<java.lang.String,java.lang.Object> getSipSessionAttributes(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey)
          Return all attributes associated with this session id.
 org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipSessionData(java.lang.String sipAppSessionKey, java.lang.String key, boolean initialLoad)
          Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip session.
 org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipSessionData(java.lang.String sipAppSessionKey, java.lang.String key, java.lang.String dataOwner, boolean includeAttributes)
          Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip session.
 java.util.Map<java.lang.String,java.lang.String> getSipSessionKeys()
          Gets the ids of all sip sessions in the underlying cache.
 void putSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey, java.util.Map<java.lang.String,java.lang.Object> map)
          Stores the given map of attribute key/value pairs in the given session.
 void putSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String key, java.lang.Object value)
          Stores the given value under the given key in the given session.
 void putSipSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey, java.util.Map<java.lang.String,java.lang.Object> map)
          Stores the given map of attribute key/value pairs in the given session.
 void putSipSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey, java.lang.String key, java.lang.Object value)
          Stores the given value under the given key in the given session.
 void removeSipApplicationSession(java.lang.String sipApplicationSessionKey)
          Globally remove a session from the distributed cache.
 java.lang.Object removeSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String key)
          Removes the attribute with the given key from the given session.
 void removeSipApplicationSessionAttributeLocal(java.lang.String sipApplicationSessionKey, java.lang.String key)
          Removes the attribute with the given key from the given session, but only on the local node.
 void removeSipApplicationSessionLocal(java.lang.String key, java.lang.String dataOwner)
          Remove a non-locally active sip application session from the distributed cache, but on this node only.
 void removeSipSession(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey)
          Globally remove a session from the distributed cache.
 java.lang.Object removeSipSessionAttribute(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey, java.lang.String key)
          Removes the attribute with the given key from the given session.
 void removeSipSessionAttributeLocal(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey, java.lang.String key)
          Removes the attribute with the given key from the given session, but only on the local node.
 void removeSipSessionLocal(java.lang.String sipAppSessionKey, java.lang.String key, java.lang.String dataOwner)
          Remove a non-locally active sip session from the distributed cache, but on this node only.
 void setApplicationName(java.lang.String applicationName)
           
 void setApplicationNameHashed(java.lang.String applicationNameHashed)
           
 void sipApplicationSessionCreated(java.lang.String key)
          Notification to the distributed cache that a session has been newly created.
 void sipSessionCreated(java.lang.String sipApplicationSessionKey, java.lang.String sipSessionKey)
          Notification to the distributed cache that a session has been newly created.
 void storeSipApplicationSessionAttributes(org.jboss.cache.Fqn<java.lang.String> fqn, T sipApplicationSessionData)
          Store or update a sip application session in the distributed cache.
 void storeSipApplicationSessionData(T sipApplicationSessionData)
          Store or update a sip application session in the distributed cache.
 void storeSipSessionAttributes(org.jboss.cache.Fqn<java.lang.String> fqn, T sipSessionData)
          Store or update a sip session in the distributed cache.
 void storeSipSessionData(T sipSessionData)
          Store or update a sip session in the distributed cache.
 
Methods inherited from interface org.jboss.web.tomcat.service.session.distributedcache.spi.DistributedCacheManager
evictSession, evictSession, getAttribute, getAttributeKeys, getAttributes, getBatchingManager, getSessionData, getSessionData, getSessionIds, getSupportsAttributeOperations, isPassivationEnabled, putAttribute, putAttribute, removeAttribute, removeAttributeLocal, removeSession, removeSessionLocal, removeSessionLocal, sessionCreated, start, stop, storeSessionData
 

Method Detail

removeSipApplicationSession

void removeSipApplicationSession(java.lang.String sipApplicationSessionKey)
Globally remove a session from the distributed cache.

Parameters:
realId - the session's id, excluding any jvmRoute

removeSipSession

void removeSipSession(java.lang.String sipApplicationSessionKey,
                      java.lang.String sipSessionKey)
Globally remove a session from the distributed cache.

Parameters:
realId - the session's id, excluding any jvmRoute

removeSipApplicationSessionLocal

void removeSipApplicationSessionLocal(java.lang.String key,
                                      java.lang.String dataOwner)
Remove a non-locally active sip application session from the distributed cache, but on this node only.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active

removeSipSessionLocal

void removeSipSessionLocal(java.lang.String sipAppSessionKey,
                           java.lang.String key,
                           java.lang.String dataOwner)
Remove a non-locally active sip session from the distributed cache, but on this node only.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active

storeSipSessionData

void storeSipSessionData(T sipSessionData)
Store or update a sip session in the distributed cache.

Parameters:
session - the sip session

storeSipApplicationSessionData

void storeSipApplicationSessionData(T sipApplicationSessionData)
Store or update a sip application session in the distributed cache.

Parameters:
session - the sip application session

storeSipSessionAttributes

void storeSipSessionAttributes(org.jboss.cache.Fqn<java.lang.String> fqn,
                               T sipSessionData)
Store or update a sip session in the distributed cache.

Parameters:
session - the sip session

storeSipApplicationSessionAttributes

void storeSipApplicationSessionAttributes(org.jboss.cache.Fqn<java.lang.String> fqn,
                                          T sipApplicationSessionData)
Store or update a sip application session in the distributed cache.

Parameters:
session - the sip application session

getSipSessionData

org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipSessionData(java.lang.String sipAppSessionKey,
                                                                                                             java.lang.String key,
                                                                                                             boolean initialLoad)
Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip session.

Parameters:
key - the session's key
initialLoad - true if this is the first access of this session's data on this node
Returns:
the session data

getSipSessionData

org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipSessionData(java.lang.String sipAppSessionKey,
                                                                                                             java.lang.String key,
                                                                                                             java.lang.String dataOwner,
                                                                                                             boolean includeAttributes)
Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip session.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active; null if locally active or location where active is unknown
includeAttributes - should
Returns:
the session data

getSipApplicationSessionData

org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipApplicationSessionData(java.lang.String key,
                                                                                                                        boolean initialLoad)
Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip application session.

Parameters:
key - the session's key
initialLoad - true if this is the first access of this session's data on this node
Returns:
the session data

getSipApplicationSessionData

org.jboss.web.tomcat.service.session.distributedcache.spi.IncomingDistributableSessionData getSipApplicationSessionData(java.lang.String key,
                                                                                                                        java.lang.String dataOwner,
                                                                                                                        boolean includeAttributes)
Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given sip application session.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active; null if locally active or location where active is unknown
includeAttributes - should
Returns:
the session data

evictSipSession

void evictSipSession(java.lang.String sipAppSessionKey,
                     java.lang.String key)
Evict a sip session from the in-memory portion of the distributed cache, on this node only.

Parameters:
key - the session's key

evictSipApplicationSession

void evictSipApplicationSession(java.lang.String key)
Evict a sip application session from the in-memory portion of the distributed cache, on this node only.

Parameters:
key - the session's key

evictSipSession

void evictSipSession(java.lang.String sipAppSessionKey,
                     java.lang.String key,
                     java.lang.String dataOwner)
Evict a non-locally-active sip session from the in-memory portion of the distributed cache, on this node only.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active

evictSipApplicationSession

void evictSipApplicationSession(java.lang.String key,
                                java.lang.String dataOwner)
Evict a non-locally-active sip application session from the in-memory portion of the distributed cache, on this node only.

Parameters:
key - the session's key
dataOwner - identifier of node where the session is active

getSipSessionKeys

java.util.Map<java.lang.String,java.lang.String> getSipSessionKeys()
Gets the ids of all sip sessions in the underlying cache.

Returns:
Map containing all of the sip session key of sessions in the cache (with any jvmRoute removed) as keys, and the identifier of the data owner for the session as value (or a null value if buddy replication is not enabled.) Will not return null.

getSipApplicationSessionKeys

java.util.Map<java.lang.String,java.lang.String> getSipApplicationSessionKeys()
Gets the ids of all sip application sessions in the underlying cache.

Returns:
Map containing all of the sip application session key of sessions in the cache (with any jvmRoute removed) as keys, and the identifier of the data owner for the session as value (or a null value if buddy replication is not enabled.) Will not return null.

sipSessionCreated

void sipSessionCreated(java.lang.String sipApplicationSessionKey,
                       java.lang.String sipSessionKey)
Notification to the distributed cache that a session has been newly created.

Parameters:
sipApplicationSessionKey - the parent session's key
sipSessionKey - the session's key

sipApplicationSessionCreated

void sipApplicationSessionCreated(java.lang.String key)
Notification to the distributed cache that a session has been newly created.

Parameters:
key - the session's key

getSipApplicationSessionAttribute

java.lang.Object getSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey,
                                                   java.lang.String key)
Get the value of the attribute with the given key from the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Returns:
the attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

putSipApplicationSessionAttribute

void putSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey,
                                       java.lang.String key,
                                       java.lang.Object value)
Stores the given value under the given key in the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
value - the previous attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

putSipApplicationSessionAttribute

void putSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey,
                                       java.util.Map<java.lang.String,java.lang.Object> map)
Stores the given map of attribute key/value pairs in the given session.

Parameters:
realId - the session id with any jvmRoute removed
map -
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

removeSipApplicationSessionAttribute

java.lang.Object removeSipApplicationSessionAttribute(java.lang.String sipApplicationSessionKey,
                                                      java.lang.String key)
Removes the attribute with the given key from the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Returns:
the previous attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

removeSipApplicationSessionAttributeLocal

void removeSipApplicationSessionAttributeLocal(java.lang.String sipApplicationSessionKey,
                                               java.lang.String key)
Removes the attribute with the given key from the given session, but only on the local node.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getSipApplicationSessionAttributeKeys

java.util.Set<java.lang.String> getSipApplicationSessionAttributeKeys(java.lang.String sipApplicationSessionKey)
Obtain the attribute keys associated with this session.

Parameters:
realId - the session id with any jvmRoute removed
Returns:
the attribute keys or an empty Set if none are found
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getSipApplicationSessionAttributes

java.util.Map<java.lang.String,java.lang.Object> getSipApplicationSessionAttributes(java.lang.String sipApplicationSessionKey)
Return all attributes associated with this session id.

Parameters:
realId - the session id with any jvmRoute removed
Returns:
the attributes, or any empty Map if none are found.
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getConvergedSessionAttributes

java.util.Map<java.lang.String,java.lang.Object> getConvergedSessionAttributes(java.lang.String realId,
                                                                               java.util.Map<java.lang.Object,java.lang.Object> distributedCacheData)

getSipSessionAttribute

java.lang.Object getSipSessionAttribute(java.lang.String sipApplicationSessionKey,
                                        java.lang.String sipSessionKey,
                                        java.lang.String key)
Get the value of the attribute with the given key from the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Returns:
the attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

putSipSessionAttribute

void putSipSessionAttribute(java.lang.String sipApplicationSessionKey,
                            java.lang.String sipSessionKey,
                            java.lang.String key,
                            java.lang.Object value)
Stores the given value under the given key in the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
value - the previous attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

putSipSessionAttribute

void putSipSessionAttribute(java.lang.String sipApplicationSessionKey,
                            java.lang.String sipSessionKey,
                            java.util.Map<java.lang.String,java.lang.Object> map)
Stores the given map of attribute key/value pairs in the given session.

Parameters:
realId - the session id with any jvmRoute removed
map -
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

removeSipSessionAttribute

java.lang.Object removeSipSessionAttribute(java.lang.String sipApplicationSessionKey,
                                           java.lang.String sipSessionKey,
                                           java.lang.String key)
Removes the attribute with the given key from the given session.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Returns:
the previous attribute value, or null
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

removeSipSessionAttributeLocal

void removeSipSessionAttributeLocal(java.lang.String sipApplicationSessionKey,
                                    java.lang.String sipSessionKey,
                                    java.lang.String key)
Removes the attribute with the given key from the given session, but only on the local node.

Parameters:
realId - the session id with any jvmRoute removed
key - the attribute key
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getSipSessionAttributeKeys

java.util.Set<java.lang.String> getSipSessionAttributeKeys(java.lang.String sipApplicationSessionKey,
                                                           java.lang.String sipSessionKey)
Obtain the attribute keys associated with this session.

Parameters:
realId - the session id with any jvmRoute removed
Returns:
the attribute keys or an empty Set if none are found
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getSipSessionAttributes

java.util.Map<java.lang.String,java.lang.Object> getSipSessionAttributes(java.lang.String sipApplicationSessionKey,
                                                                         java.lang.String sipSessionKey)
Return all attributes associated with this session id.

Parameters:
realId - the session id with any jvmRoute removed
Returns:
the attributes, or any empty Map if none are found.
Throws:
java.lang.UnsupportedOperationException - if DistributedCacheManager.getSupportsAttributeOperations() would return false

getJBossCache

org.jboss.cache.Cache getJBossCache()

setApplicationName

void setApplicationName(java.lang.String applicationName)

setApplicationNameHashed

void setApplicationNameHashed(java.lang.String applicationNameHashed)


Copyright © 2010. All Rights Reserved.