org.gatein.wsrp.consumer.registry

Class InMemoryConsumerRegistry

java.lang.Object

org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

org.gatein.wsrp.consumer.registry.InMemoryConsumerRegistry

All Implemented Interfaces:

ConsumerRegistry, ConsumerRegistrySPI

Direct Known Subclasses:

XMLConsumerRegistry

public class InMemoryConsumerRegistry
extends AbstractConsumerRegistry

Version:

$Revision$

Author:

Chris Laprun

Nested Class Summary

Nested classes/interfaces inherited from class org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

AbstractConsumerRegistry.InMemoryConsumerCache, AbstractConsumerRegistry.ProducerInfoIterator

Field Summary

Fields inherited from class org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

consumerCache, log

Constructor Summary

Constructors

Constructor and Description
InMemoryConsumerRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
WSRPConsumer	createConsumerFrom(ProducerInfo producerInfo, boolean putInCache) Creates a consumer from the specified ProducerInfo, caching it if so specified.
void	delete(ProducerInfo info) Deletes the specified ProducerInfo from persistence.
Collection<String>	getConfiguredConsumersIds() Retrieves the identifiers for all known consumers.
Iterator<ProducerInfo>	getProducerInfosFromStorage() Retrieves all ProducerInfos currently persisted from the persistent store.
protected void	initConsumerCache() Initializes the ConsumerCache so that subclasses have the opportunity to do some specific processing.
protected void	initConsumers(SortedMap<String,WSRPConsumer> consumers)
ProducerInfo	loadProducerInfo(String id) Loads the ProducerInfo associated with the specified identifier from the persistent state.
void	reloadConsumers() Reloads consumers from persistence, re-initializing any cache from the persisted state.
void	save(ProducerInfo info, String messageOnError) Saves for the first time the specified ProducerInfo to persistence, providing a message in case an error happens.
void	stop() Stops all consumers, deregistering them with the FederatingPortletInvoker.
String	update(ProducerInfo producerInfo) Persists the changes made to an already persisted ProducerInfo.
String	updateProducerInfo(ProducerInfo producerInfo) Persists the changes made to ProducerInfo.

Methods inherited from class org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

activateConsumer, activateConsumerWith, containsConsumer, createConsumer, deactivateConsumer, deactivateConsumerWith, deregisterWithFederatingPortletInvoker, destroyConsumer, getConfiguredConsumerNumber, getConfiguredConsumers, getConsumer, getConsumers, getFederatingPortletInvoker, getMigrationService, getPersistedLastModifiedForProducerInfoWith, getSessionRegistry, registerOrDeregisterConsumerWith, registerWithFederatingPortletInvoker, setConsumerCache, setFederatingPortletInvoker, setMigrationService, setSessionEventBroadcaster, setSessionRegistry, start

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryConsumerRegistry

public InMemoryConsumerRegistry()

Method Detail

initConsumerCache

protected void initConsumerCache()

Description copied from class: AbstractConsumerRegistry

Initializes the ConsumerCache so that subclasses have the opportunity to do some specific processing.

Specified by:

initConsumerCache in class AbstractConsumerRegistry

createConsumerFrom

public WSRPConsumer createConsumerFrom(ProducerInfo producerInfo,
                              boolean putInCache)

Description copied from interface: ConsumerRegistrySPI

Creates a consumer from the specified ProducerInfo, caching it if so specified.

Specified by:

createConsumerFrom in interface ConsumerRegistrySPI

Overrides:

createConsumerFrom in class AbstractConsumerRegistry

Parameters:

producerInfo - the ProducerInfo to create a consumer from

putInCache - whether to cache the newly created consumer

Returns:

a WSRPConsumer implementation based on the producer metadata specified by the provided ProducerInfo

updateProducerInfo

public String updateProducerInfo(ProducerInfo producerInfo)

Description copied from interface: ConsumerRegistry

Persists the changes made to ProducerInfo.

Specified by:

updateProducerInfo in interface ConsumerRegistry

Overrides:

updateProducerInfo in class AbstractConsumerRegistry

Parameters:

producerInfo - the ProducerInfo to persist

Returns:

the previous value of the ProducerInfo's id if it has changed, null otherwise

save

public void save(ProducerInfo info,
        String messageOnError)

Description copied from interface: ConsumerRegistrySPI

Saves for the first time the specified ProducerInfo to persistence, providing a message in case an error happens.

Parameters:

info - the ProducerInfo to persist

messageOnError - the message to pass along in case an error happens

delete

public void delete(ProducerInfo info)

Description copied from interface: ConsumerRegistrySPI

Deletes the specified ProducerInfo from persistence.

Parameters:

info - the ProducerInfo to delete

update

public String update(ProducerInfo producerInfo)

Description copied from interface: ConsumerRegistrySPI

Persists the changes made to an already persisted ProducerInfo. Attempting to update a ProducerInfo that has never been persisted before will yield an exception.

Parameters:

producerInfo - the ProducerInfo which modifications we want to persist

Returns:

the previous value of the ProducerInfo's id if it has changed, null otherwise

reloadConsumers

public void reloadConsumers()

Description copied from interface: ConsumerRegistry

Reloads consumers from persistence, re-initializing any cache from the persisted state.

Specified by:

reloadConsumers in interface ConsumerRegistry

Overrides:

reloadConsumers in class AbstractConsumerRegistry

getProducerInfosFromStorage

public Iterator<ProducerInfo> getProducerInfosFromStorage()

Description copied from interface: ConsumerRegistrySPI

Retrieves all ProducerInfos currently persisted from the persistent store.

Returns:

all ProducerInfos currently persisted from the persistent store.

loadProducerInfo

public ProducerInfo loadProducerInfo(String id)

Description copied from interface: ConsumerRegistrySPI

Loads the ProducerInfo associated with the specified identifier from the persistent state.

Parameters:

id - the identifier of the ProducerInfo to load

Returns:

the ProducerInfo identified by the provided identifier or null if no such ProducerInfo is currently persisted

stop

public void stop()
          throws Exception

Description copied from interface: ConsumerRegistrySPI

Stops all consumers, deregistering them with the FederatingPortletInvoker.

Specified by:

stop in interface ConsumerRegistrySPI

Overrides:

stop in class AbstractConsumerRegistry

Throws:

Exception

getConfiguredConsumersIds

public Collection<String> getConfiguredConsumersIds()

Description copied from interface: ConsumerRegistry

Retrieves the identifiers for all known consumers.

Returns:

the identifiers for all known consumers.

initConsumers

protected void initConsumers(SortedMap<String,WSRPConsumer> consumers)