org.atmosphere.cache

Class UUIDBroadcasterCache

java.lang.Object

org.atmosphere.cache.UUIDBroadcasterCache

All Implemented Interfaces:

BroadcasterCache

public class UUIDBroadcasterCache
extends java.lang.Object
implements BroadcasterCache

An improved BroadcasterCache implementation that is based on the unique identifier (UUID) that all AtmosphereResources have.

Author:

Paul Khodchenkov, Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UUIDBroadcasterCache.ClientQueue

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.Object>	emptyList
protected java.util.List<BroadcasterCacheInspector>	inspectors
protected java.util.concurrent.ScheduledExecutorService	taskScheduler

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

DEFAULT

Constructor Summary

Constructors

Constructor and Description
UUIDBroadcasterCache()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Long>	activeClients()
CacheMessage	addToCache(java.lang.String broadcasterId, AtmosphereResource r, BroadcastMessage message) Start tracking messages associated with AtmosphereResource from the cache.
void	cleanup() Clean resources associated with this instance.
void	clearCache(java.lang.String broadcasterId, AtmosphereResource r, CacheMessage message) Remove the previously cached message.
void	configure(BroadcasterConfig config) Configure the cache.
void	excludeFromCache(java.lang.String broadcasterId, AtmosphereResource r) Allow an application to exclude, or block, an AtmosphereResource to received cached message.
protected boolean	inspect(BroadcastMessage m)
BroadcasterCache	inspector(BroadcasterCacheInspector b) Add a BroadcasterCacheInspector that will be invoked before a message gets added to the cache.
protected void	invalidateExpiredEntries()
java.util.Map<java.lang.String,UUIDBroadcasterCache.ClientQueue>	messages()
java.util.List<java.lang.Object>	retrieveFromCache(java.lang.String broadcasterId, AtmosphereResource r) Retrieve messages associated with AtmosphereResource.
void	setClientIdleTime(long clientIdleTime)
void	setInvalidateCacheInterval(long invalidateCacheInterval)
void	start() This method is invoked when the Broadcaster is started.
void	stop() This method is invoked when the Broadcaster is stopped.
java.lang.String	toString()
protected java.lang.String	uuid(AtmosphereResource r)

Methods inherited from class java.lang.Object

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

Field Detail

inspectors

protected final java.util.List<BroadcasterCacheInspector> inspectors

taskScheduler

protected java.util.concurrent.ScheduledExecutorService taskScheduler

emptyList

protected final java.util.List<java.lang.Object> emptyList

Constructor Detail

UUIDBroadcasterCache

public UUIDBroadcasterCache()

Method Detail

configure

public void configure(BroadcasterConfig config)

Description copied from interface: BroadcasterCache

Configure the cache.

Specified by:

configure in interface BroadcasterCache

Parameters:

config - a BroadcasterConfig

start

public void start()

Description copied from interface: BroadcasterCache

This method is invoked when the Broadcaster is started.

Specified by:

start in interface BroadcasterCache

stop

public void stop()

Description copied from interface: BroadcasterCache

This method is invoked when the Broadcaster is stopped.

Specified by:

stop in interface BroadcasterCache

cleanup

public void cleanup()

Description copied from interface: BroadcasterCache

Clean resources associated with this instance. This method is useful when ExecutorServices are shared and some future must be cancelled. This method will always be invoked when a Broadcaster gets destroyed.

Specified by:

cleanup in interface BroadcasterCache

addToCache

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

Description copied from interface: BroadcasterCache

Start tracking messages associated with AtmosphereResource from the cache.

Specified by:

addToCache in interface BroadcasterCache

Parameters:

broadcasterId - The associated Broadcaster#addAtmosphereResource(AtmosphereResource).getID

r - AtmosphereResource

message - BroadcastMessage.

Returns:

The CacheMessage

retrieveFromCache

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

Description copied from interface: BroadcasterCache

Retrieve messages associated with AtmosphereResource.

Specified by:

retrieveFromCache in interface BroadcasterCache

Parameters:

broadcasterId - The associated Broadcaster#addAtmosphereResource(AtmosphereResource).getID

r - AtmosphereResource

Returns:

a List of messages (String).

clearCache

public void clearCache(java.lang.String broadcasterId,
              AtmosphereResource r,
              CacheMessage message)

Description copied from interface: BroadcasterCache

Remove the previously cached message.

Specified by:

clearCache in interface BroadcasterCache

Parameters:

broadcasterId - The Broadcaster.getID()

r - an AtmosphereResource

message - the CacheMessage

inspector

public BroadcasterCache inspector(BroadcasterCacheInspector b)

Description copied from interface: BroadcasterCache

Add a BroadcasterCacheInspector that will be invoked before a message gets added to the cache.

Specified by:

inspector in interface BroadcasterCache

Parameters:

b - an instance of BroadcasterCacheInspector

Returns:

this

uuid

protected java.lang.String uuid(AtmosphereResource r)

messages

public java.util.Map<java.lang.String,UUIDBroadcasterCache.ClientQueue> messages()

activeClients

public java.util.Map<java.lang.String,java.lang.Long> activeClients()

inspect

protected boolean inspect(BroadcastMessage m)

setInvalidateCacheInterval

public void setInvalidateCacheInterval(long invalidateCacheInterval)

setClientIdleTime

public void setClientIdleTime(long clientIdleTime)

invalidateExpiredEntries

protected void invalidateExpiredEntries()

excludeFromCache

public void excludeFromCache(java.lang.String broadcasterId,
                    AtmosphereResource r)

Description copied from interface: BroadcasterCache

Allow an application to exclude, or block, an AtmosphereResource to received cached message. No new message will get sent to this client except the ones already cached.

Specified by:

excludeFromCache in interface BroadcasterCache

Parameters:

broadcasterId - The Broadcaster.getID()

r - an AtmosphereResource

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object