org.gatein.wsrp.consumer.registry

Class AbstractConsumerRegistry.InMemoryConsumerCache

java.lang.Object

org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry.InMemoryConsumerCache

All Implemented Interfaces:

ConsumerCache

Enclosing class:

AbstractConsumerRegistry

protected static class AbstractConsumerRegistry.InMemoryConsumerCache
extends Object
implements ConsumerCache

Implements a local cache for consumers.

Constructor Summary

Constructors

Constructor and Description
AbstractConsumerRegistry.InMemoryConsumerCache(ConsumerRegistrySPI registry)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears all consumers from this cache.
WSRPConsumer	getConsumer(String id) Retrieves the consumer identified by the specified identifier, updating its state from persistence if required.
Collection<WSRPConsumer>	getConsumers() Retrieves the up-to-date collection of consumers known by this cache.
void	initFromStorage() Initializes this cache from persistent store.
boolean	isInvalidated() Are we invalidated?
void	putConsumer(String id, WSRPConsumer consumer) Puts the specified consumer in cache under the specified identifier.
protected void	refreshIfNeeded() Refreshes the cache information if needed.
WSRPConsumer	removeConsumer(String id) Removes the consumer identified by the specified identifier from this cache.
void	setInvalidated(boolean invalidated) Specifies whether this cache should be invalidated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConsumerRegistry.InMemoryConsumerCache

public AbstractConsumerRegistry.InMemoryConsumerCache(ConsumerRegistrySPI registry)

Method Detail

initFromStorage

public void initFromStorage()

Description copied from interface: ConsumerCache

Initializes this cache from persistent store.

Specified by:

initFromStorage in interface ConsumerCache

getConsumers

public Collection<WSRPConsumer> getConsumers()

Description copied from interface: ConsumerCache

Retrieves the up-to-date collection of consumers known by this cache. In particular, this means that the consumers returned by this method should match exactly the ones (and only the ones) that are currently persisted, the cached data being completely refreshed as needed.

Specified by:

getConsumers in interface ConsumerCache

Returns:

the up-to-date consumers known by this cache

getConsumer

public WSRPConsumer getConsumer(String id)

Description copied from interface: ConsumerCache

Retrieves the consumer identified by the specified identifier, updating its state from persistence if required.

Specified by:

getConsumer in interface ConsumerCache

Parameters:

id - the identifier of the consumer to retrieve

Returns:

the up-to-date consumer identified by the specified identifier or null if no such consumer exists in persistence

removeConsumer

public WSRPConsumer removeConsumer(String id)

Description copied from interface: ConsumerCache

Removes the consumer identified by the specified identifier from this cache.

Specified by:

removeConsumer in interface ConsumerCache

Parameters:

id - the identifier of the consumer to remove

Returns:

the consumer that was stored in this cache, or null if no such consumer previously was stored in this cache

putConsumer

public void putConsumer(String id,
               WSRPConsumer consumer)

Description copied from interface: ConsumerCache

Puts the specified consumer in cache under the specified identifier.

Specified by:

putConsumer in interface ConsumerCache

Parameters:

id - the consumer's identifier

consumer - the consumer to put in this cache

clear

public void clear()

Description copied from interface: ConsumerCache

Clears all consumers from this cache.

Specified by:

clear in interface ConsumerCache

isInvalidated

public boolean isInvalidated()

Description copied from interface: ConsumerCache

Are we invalidated?

Specified by:

isInvalidated in interface ConsumerCache

Returns:

true if this cache has been invalidated, false otherwise

setInvalidated

public void setInvalidated(boolean invalidated)

Description copied from interface: ConsumerCache

Specifies whether this cache should be invalidated.

Specified by:

setInvalidated in interface ConsumerCache

Parameters:

invalidated - true to mark this cache as invalidated, false otherwise

refreshIfNeeded

protected void refreshIfNeeded()

Refreshes the cache information if needed. In particular, this means that after calling this method, the set of cached consumers should be consistent with the persisted state, all consumers being up-to-date with their persisted state, obsolete consumers are removed, new ones are added.