Package org.atmosphere.cache

Class SessionBroadcasterCache

java.lang.Object

org.atmosphere.cache.AbstractBroadcasterCache

org.atmosphere.cache.SessionBroadcasterCache

All Implemented Interfaces:

BroadcasterCache, AtmosphereConfigAware

public class SessionBroadcasterCache
extends AbstractBroadcasterCache

Simple BroadcasterCache that use an HttpSession to cache messages.

Author:

Jeanfrancois Arcand

Field Summary

Fields inherited from class org.atmosphere.cache.AbstractBroadcasterCache

config, emptyList, inspectors, invalidateCacheInterval, isShared, listeners, maxCacheTime, messages, messagesIds, readWriteLock, reaper, scheduledFuture

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

DEFAULT, NULL

Constructor Summary

Constructors

Constructor	Description
SessionBroadcasterCache()

Method Summary

Modifier and Type	Method	Description
CacheMessage	addToCache(java.lang.String broadcasterId, java.lang.String uuid, BroadcastMessage message)	Start tracking messages associated with AtmosphereResource from the cache.
java.util.List<java.lang.Object>	retrieveFromCache(java.lang.String broadcasterId, java.lang.String uuid)	Retrieve messages associated with AtmosphereResource.

Methods inherited from class org.atmosphere.cache.AbstractBroadcasterCache

addBroadcasterCacheListener, cacheCandidate, cleanup, clearCache, configure, excludeFromCache, get, inspect, inspector, put, removeBroadcasterCacheListener, setInvalidateCacheInterval, setMaxCacheTime, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionBroadcasterCache

public SessionBroadcasterCache()

Method Detail

addToCache

public CacheMessage addToCache(java.lang.String broadcasterId,
                               java.lang.String uuid,
                               BroadcastMessage message)

Description copied from interface: BroadcasterCache

Start tracking messages associated with AtmosphereResource from the cache.

Parameters:

broadcasterId - The associated {@link Broadcaster#addAtmosphereResource(AtmosphereResource).getID}

uuid - AtmosphereResource.uuid()

message - BroadcastMessage.

Returns:

The CacheMessage

retrieveFromCache

public java.util.List<java.lang.Object> retrieveFromCache(java.lang.String broadcasterId,
                                                          java.lang.String uuid)

Description copied from interface: BroadcasterCache

Retrieve messages associated with AtmosphereResource.

Parameters:

broadcasterId - The associated {@link org.atmosphere.cpr.Broadcaster#addAtmosphereResource(org.atmosphere.cpr.AtmosphereResource).getID}

uuid - AtmosphereResource

Returns:

a List of messages (String).