org.gatein.wsrp.consumer.registry

Interface ConsumerCache

All Known Implementing Classes:

AbstractConsumerRegistry.InMemoryConsumerCache

public interface ConsumerCache

A cache for WSRPConsumers to avoid having to retrieve them (and restore their complete state) from persistence. This is crucial because it is not currently possible to completely restore a consumer's state from persistence without having to go through its rather complex lifecycle and negotiation with the remote producer. This cache is however guaranteed to be always provide a correct view of the persisted state, meaning that public methods will always first check if the cached data first needs to be updated from persistence and will do so before returning thus ensuring that the returned values are not staled.

Author:

Chris Laprun

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.
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.

Method Detail

getConsumers

Collection<WSRPConsumer> getConsumers()

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.

Returns:

the up-to-date consumers known by this cache

getConsumer

WSRPConsumer getConsumer(String id)

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

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

WSRPConsumer removeConsumer(String id)

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

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

void putConsumer(String id,
               WSRPConsumer consumer)

Puts the specified consumer in cache under the specified identifier.

Parameters:

id - the consumer's identifier

consumer - the consumer to put in this cache

clear

void clear()

Clears all consumers from this cache.

isInvalidated

boolean isInvalidated()

Are we invalidated?

Returns:

true if this cache has been invalidated, false otherwise

setInvalidated

void setInvalidated(boolean invalidated)

Specifies whether this cache should be invalidated.

Parameters:

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

initFromStorage

void initFromStorage()

Initializes this cache from persistent store.