Package com.tangosol.coherence.servlet

Class SessionLocalBackingMapCacheDelegator

java.lang.Object

com.tangosol.coherence.servlet.SessionLocalBackingMapCacheDelegator

All Implemented Interfaces:

CacheDelegator

public class SessionLocalBackingMapCacheDelegator
extends Object
implements CacheDelegator

An abstract base class from which implementations of HttpSessionCollection that use a SessionLocalBackingMap can be more easily built.

Author:

jk 2011.05.24

Constructor Summary

Constructors

Constructor	Description
SessionLocalBackingMapCacheDelegator()

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(String sId, AbstractHttpSessionCollection collection)	Check if the cluster cache contains a session obj.
Set<String>	deleteExpiredLocalSessions(AbstractHttpSessionCollection collection)	Deletes the locally opened sessions in the session cache which have timed-out and returns the ids for deleted sessions.
Set<String>	deleteExpiredSessions(AbstractHttpSessionCollection collection)	Deletes the sessions in the session cache which have timed-out and returns the ids for deleted sessions.
void	deleteModel(AbstractHttpSessionCollection collection, AbstractHttpSessionModel model)	Delete the session from the cluster cache.
void	flush(AbstractHttpSessionCollection collection, AbstractHttpSessionModel model)	Perform a flush operation of the session onto the cluster cache
Iterator	getIteratorForPotentiallyExpiredIds(AbstractHttpSessionCollection collection)	Retrieve an iterator of potentially expired session ids.
Iterator	getIteratorForPotentiallyExpiredLocalIds(AbstractHttpSessionCollection collection)	Retrieve an iterator of potentially expired session ids from the list of local sessions.
AbstractHttpSessionModel	getModel(String sId, AbstractHttpSessionCollection collection)	Retrieve a model from the cluster cache
AbstractHttpSessionModel	getModel(String sId, AbstractHttpSessionCollection collection, boolean fLite)	Retrieve a model from the cluster cache
void	optimisticModelUpdate(AbstractHttpSessionModel model)	Perform an optimistic model update in the cache.
void	putModel(AbstractHttpSessionModel model)	Put a session model in the cache.
void	updateModelTimestamp(AbstractHttpSessionModel model)	Update a session model timestamp in the cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionLocalBackingMapCacheDelegator

public SessionLocalBackingMapCacheDelegator()

Method Detail

deleteModel

public void deleteModel(AbstractHttpSessionCollection collection,
                        AbstractHttpSessionModel model)

Description copied from interface: CacheDelegator

Delete the session from the cluster cache.

Specified by:

deleteModel in interface CacheDelegator

Parameters:

collection - the collection obj

model - the model obj

containsKey

public boolean containsKey(String sId,
                           AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Check if the cluster cache contains a session obj.

Specified by:

containsKey in interface CacheDelegator

Parameters:

sId - the session id

collection - the session collection obj

Returns:

true, if the session obj exists in the cluster cache

optimisticModelUpdate

public void optimisticModelUpdate(AbstractHttpSessionModel model)

Description copied from interface: CacheDelegator

Perform an optimistic model update in the cache.

Specified by:

optimisticModelUpdate in interface CacheDelegator

Parameters:

model - the session mdoel

getIteratorForPotentiallyExpiredIds

public Iterator getIteratorForPotentiallyExpiredIds(AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Retrieve an iterator of potentially expired session ids.

Specified by:

getIteratorForPotentiallyExpiredIds in interface CacheDelegator

Parameters:

collection - the session collection obj

Returns:

Iterator of potentially expired session ids

getModel

public AbstractHttpSessionModel getModel(String sId,
                                         AbstractHttpSessionCollection collection,
                                         boolean fLite)

Description copied from interface: CacheDelegator

Retrieve a model from the cluster cache

Specified by:

getModel in interface CacheDelegator

Parameters:

sId - the session id

collection - the session collection obj

fLite - when set to true then if a near cache is used, the front map is avoided; thus avoiding listener registration and unnecessary eviction on the front map

Returns:

the session model

getModel

public AbstractHttpSessionModel getModel(String sId,
                                         AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Retrieve a model from the cluster cache

Specified by:

getModel in interface CacheDelegator

Parameters:

sId - the session id

collection - the session collection obj

Returns:

the session model

putModel

public void putModel(AbstractHttpSessionModel model)

Description copied from interface: CacheDelegator

Put a session model in the cache.

Specified by:

putModel in interface CacheDelegator

Parameters:

model - the session model

updateModelTimestamp

public void updateModelTimestamp(AbstractHttpSessionModel model)

Description copied from interface: CacheDelegator

Update a session model timestamp in the cache.

Specified by:

updateModelTimestamp in interface CacheDelegator

Parameters:

model - the session model

getIteratorForPotentiallyExpiredLocalIds

public Iterator getIteratorForPotentiallyExpiredLocalIds(AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Retrieve an iterator of potentially expired session ids from the list of local sessions.

Specified by:

getIteratorForPotentiallyExpiredLocalIds in interface CacheDelegator

Parameters:

collection - the session collection obj

Returns:

iterator of potentially expired session local session ids

deleteExpiredSessions

public Set<String> deleteExpiredSessions(AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Deletes the sessions in the session cache which have timed-out and returns the ids for deleted sessions.

Specified by:

deleteExpiredSessions in interface CacheDelegator

Parameters:

collection - the session collection obj

Returns:

the set of ids of sessions that are deleted

deleteExpiredLocalSessions

public Set<String> deleteExpiredLocalSessions(AbstractHttpSessionCollection collection)

Description copied from interface: CacheDelegator

Deletes the locally opened sessions in the session cache which have timed-out and returns the ids for deleted sessions.

Specified by:

deleteExpiredLocalSessions in interface CacheDelegator

Parameters:

collection - the session collection obj

Returns:

the set of ids of sessions that are deleted

flush

public void flush(AbstractHttpSessionCollection collection,
                  AbstractHttpSessionModel model)

Description copied from interface: CacheDelegator

Perform a flush operation of the session onto the cluster cache

Specified by:

flush in interface CacheDelegator

Parameters:

collection - the session collection obj

model - the session model