org.gatein.wsrp.consumer.registry

Class AbstractConsumerRegistry

java.lang.Object

org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

All Implemented Interfaces:

ConsumerRegistry, ConsumerRegistrySPI

Direct Known Subclasses:

InMemoryConsumerRegistry

public abstract class AbstractConsumerRegistry
extends Object
implements ConsumerRegistrySPI

Provides a base implementation for ConsumerRegistry behavior. It is strongly recommended that implementations inherit from this abstract superclass. The goal is to make sure that the consumer states are properly stored and consistent across cluster nodes.

Since:

2.6

Version:

$Revision: 12693 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractConsumerRegistry.InMemoryConsumerCache Implements a local cache for consumers.
protected class	AbstractConsumerRegistry.ProducerInfoIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected ConsumerCache	consumerCache Caches consumers to avoid having to recreate them if possible as the lifecycle transitions might be a little complex and not completely possible to restore from persistence
protected static org.slf4j.Logger	log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractConsumerRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateConsumer(WSRPConsumer consumer)
void	activateConsumerWith(String id) Activates the consumer associated with the specified identifier if and only if access to the remote producer is properly setup (i.e.
boolean	containsConsumer(String id) Whether or not this registry knows about a consumer with the specified identifier.
WSRPConsumer	createConsumer(String id, Integer expirationCacheSeconds, String wsdlURL) Creates a consumer with the specified associated producer identifier, caching producer metadata for the specified time in seconds and accessing the related producer via the specified WSDL location.
WSRPConsumer	createConsumerFrom(ProducerInfo producerInfo, boolean putInCache) Creates a consumer from the specified ProducerInfo, caching it if so specified.
protected void	deactivateConsumer(WSRPConsumer consumer)
void	deactivateConsumerWith(String id) Desactivates the consumer, unregistering it from the FederatingPortletInvoker, meaning that it cannot be interacted with anymore by the portal in which WSRP is running.
void	deregisterWithFederatingPortletInvoker(WSRPConsumer consumer) Deregisters the specified WSRPConsumer with the FederatingPortletInvoker.
void	destroyConsumer(String id) Destroys the specified consumer taking care of cleaning (if needed) things up at the same time, meaning: unregistering if registered, deactivating if activated and removing the consumer from persistent storage.
int	getConfiguredConsumerNumber() Retrieves the number of configured consumers.
List<WSRPConsumer>	getConfiguredConsumers() Retrieves the list of configured consumers.
WSRPConsumer	getConsumer(String id) Retrieves the consumer associated with the specified producer identifier.
protected List<WSRPConsumer>	getConsumers(boolean startConsumers)
org.gatein.pc.federation.FederatingPortletInvoker	getFederatingPortletInvoker() Retrieves the FederatingPortletInvoker used by this ConsumerRegistry to register / unregister consumers as PortletInvokers.
MigrationService	getMigrationService()
long	getPersistedLastModifiedForProducerInfoWith(String id) Checks the last modification time that was persisted for the ProducerInfo identified by the specified identifier.
SessionRegistry	getSessionRegistry()
protected abstract void	initConsumerCache() Initializes the ConsumerCache so that subclasses have the opportunity to do some specific processing.
void	registerOrDeregisterConsumerWith(String id, boolean register) Attempts to register (if the specified boolean is true) or deregister (otherwise) the consumer associated with the specified identifier with the associated remote producer.
void	registerWithFederatingPortletInvoker(WSRPConsumer consumer) Registers the specified WSRPConsumer with the FederatingPortletInvoker.
void	reloadConsumers() Reloads consumers from persistence, re-initializing any cache from the persisted state.
void	setConsumerCache(ConsumerCache consumers)
void	setFederatingPortletInvoker(org.gatein.pc.federation.FederatingPortletInvoker federatingPortletInvoker)
void	setMigrationService(MigrationService migrationService)
void	setSessionEventBroadcaster(SessionEventBroadcaster sessionEventBroadcaster)
void	setSessionRegistry(SessionRegistry sessionRegistry)
void	start() Gets this ConsumerRegistry ready to work, in particular, loads the consumers from persistence and starts them, registering the active ones with the FederatingPortletInvoker.
void	stop() Stops all consumers, deregistering them with the FederatingPortletInvoker.
String	updateProducerInfo(ProducerInfo producerInfo) Persists the changes made to ProducerInfo.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gatein.wsrp.consumer.spi.ConsumerRegistrySPI

delete, getProducerInfosFromStorage, loadProducerInfo, save, update

Methods inherited from interface org.gatein.wsrp.consumer.registry.ConsumerRegistry

getConfiguredConsumersIds

Field Detail

log

protected static final org.slf4j.Logger log

consumerCache

protected ConsumerCache consumerCache

Caches consumers to avoid having to recreate them if possible as the lifecycle transitions might be a little complex and not completely possible to restore from persistence

Constructor Detail

AbstractConsumerRegistry

protected AbstractConsumerRegistry()

Method Detail

initConsumerCache

protected abstract void initConsumerCache()

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

setConsumerCache

public void setConsumerCache(ConsumerCache consumers)

setSessionRegistry

public void setSessionRegistry(SessionRegistry sessionRegistry)

Specified by:

setSessionRegistry in interface ConsumerRegistrySPI

getSessionRegistry

public SessionRegistry getSessionRegistry()

Specified by:

getSessionRegistry in interface ConsumerRegistrySPI

getFederatingPortletInvoker

public org.gatein.pc.federation.FederatingPortletInvoker getFederatingPortletInvoker()

Description copied from interface: ConsumerRegistry

Retrieves the FederatingPortletInvoker used by this ConsumerRegistry to register / unregister consumers as PortletInvokers. This is how the portal in which WSRP is running can interact with remote portlets.

Specified by:

getFederatingPortletInvoker in interface ConsumerRegistry

Returns:

the FederatingPortletInvoker used by this ConsumerRegistry

setSessionEventBroadcaster

public void setSessionEventBroadcaster(SessionEventBroadcaster sessionEventBroadcaster)

Specified by:

setSessionEventBroadcaster in interface ConsumerRegistrySPI

getMigrationService

public MigrationService getMigrationService()

Specified by:

getMigrationService in interface ConsumerRegistrySPI

setMigrationService

public void setMigrationService(MigrationService migrationService)

Specified by:

setMigrationService in interface ConsumerRegistrySPI

createConsumer

public WSRPConsumer createConsumer(String id,
                          Integer expirationCacheSeconds,
                          String wsdlURL)

Description copied from interface: ConsumerRegistry

Creates a consumer with the specified associated producer identifier, caching producer metadata for the specified time in seconds and accessing the related producer via the specified WSDL location.

Specified by:

createConsumer in interface ConsumerRegistry

Parameters:

id - the producer identifier associated with this consumer

expirationCacheSeconds - the number of seconds before cached producer metadata is considered obsolete and needs to be retrieved again from the remote producer

wsdlURL - the String representation of the URL where the producer WSDL is located

Returns:

a new WSRPConsumer minimally configured to accessed the remote producer publishing the specified WSDL

destroyConsumer

public void destroyConsumer(String id)

Description copied from interface: ConsumerRegistry

Destroys the specified consumer taking care of cleaning (if needed) things up at the same time, meaning: unregistering if registered, deactivating if activated and removing the consumer from persistent storage.

Specified by:

destroyConsumer in interface ConsumerRegistry

Parameters:

id - the identifier associated with the consumer to destroy

setFederatingPortletInvoker

public void setFederatingPortletInvoker(org.gatein.pc.federation.FederatingPortletInvoker federatingPortletInvoker)

Specified by:

setFederatingPortletInvoker in interface ConsumerRegistrySPI

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

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

activateConsumerWith

public void activateConsumerWith(String id)
                          throws ConsumerException

Description copied from interface: ConsumerRegistry

Activates the consumer associated with the specified identifier if and only if access to the remote producer is properly setup (i.e. the associated service factory MUST be available). Activating a consumer means that the consumer is ready to be interacted with, meaning, in particular, that it has been registered with the FederatingPortletInvoker and that the portal in which WSRP is running can therefore interact with the remote portlets the consumer proxies.

Specified by:

activateConsumerWith in interface ConsumerRegistry

Parameters:

id - the identifier of the consumer to be activated

Throws:

ConsumerException

activateConsumer

protected void activateConsumer(WSRPConsumer consumer)

deactivateConsumerWith

public void deactivateConsumerWith(String id)
                            throws ConsumerException

Description copied from interface: ConsumerRegistry

Desactivates the consumer, unregistering it from the FederatingPortletInvoker, meaning that it cannot be interacted with anymore by the portal in which WSRP is running.

Specified by:

deactivateConsumerWith in interface ConsumerRegistry

Parameters:

id - the identifier associated with the consumer to deactivate

Throws:

ConsumerException

deactivateConsumer

protected void deactivateConsumer(WSRPConsumer consumer)

registerWithFederatingPortletInvoker

public void registerWithFederatingPortletInvoker(WSRPConsumer consumer)

Description copied from interface: ConsumerRegistrySPI

Registers the specified WSRPConsumer with the FederatingPortletInvoker.

Specified by:

registerWithFederatingPortletInvoker in interface ConsumerRegistrySPI

Parameters:

consumer - the WSRPConsumer to register

deregisterWithFederatingPortletInvoker

public void deregisterWithFederatingPortletInvoker(WSRPConsumer consumer)

Description copied from interface: ConsumerRegistrySPI

Deregisters the specified WSRPConsumer with the FederatingPortletInvoker.

Specified by:

deregisterWithFederatingPortletInvoker in interface ConsumerRegistrySPI

Parameters:

consumer - the WSRPConsumer to deregister

getPersistedLastModifiedForProducerInfoWith

public long getPersistedLastModifiedForProducerInfoWith(String id)

Description copied from interface: ConsumerRegistrySPI

Checks the last modification time that was persisted for the ProducerInfo identified by the specified identifier. This is useful to check whether a given, local ProducerInfo has been modified since it was last persisted or, on the flip side, whether some other process (like a different node cluster) has persisted changes since we last loaded the ProducerInfo from the persistent store. This method is meant to be a lightweight dirty check of the ProducerInfo with respect to the persistence layer.

Specified by:

getPersistedLastModifiedForProducerInfoWith in interface ConsumerRegistrySPI

Parameters:

id - the identifier of the ProducerInfo we want to check

Returns:

the last mo

updateProducerInfo

public String updateProducerInfo(ProducerInfo producerInfo)

Description copied from interface: ConsumerRegistry

Persists the changes made to ProducerInfo.

Specified by:

updateProducerInfo in interface ConsumerRegistry

Parameters:

producerInfo - the ProducerInfo to persist

Returns:

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

start

public void start()
           throws Exception

Description copied from interface: ConsumerRegistrySPI

Gets this ConsumerRegistry ready to work, in particular, loads the consumers from persistence and starts them, registering the active ones with the FederatingPortletInvoker.

Specified by:

start in interface ConsumerRegistrySPI

Throws:

Exception

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

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

Throws:

Exception

getConfiguredConsumers

public List<WSRPConsumer> getConfiguredConsumers()

Description copied from interface: ConsumerRegistry

Retrieves the list of configured consumers.

Specified by:

getConfiguredConsumers in interface ConsumerRegistry

Returns:

the list of configured consumers

getConsumer

public WSRPConsumer getConsumer(String id)

Description copied from interface: ConsumerRegistry

Retrieves the consumer associated with the specified producer identifier.

Specified by:

getConsumer in interface ConsumerRegistry

Parameters:

id - the producer identifier of the consumer we want to retrieve

Returns:

the consumer associated with the specified producer identifier

containsConsumer

public boolean containsConsumer(String id)

Description copied from interface: ConsumerRegistry

Whether or not this registry knows about a consumer with the specified identifier.

Specified by:

containsConsumer in interface ConsumerRegistry

Parameters:

id - the identifier of a consumer whose existence we want to check with this registry

Returns:

getConfiguredConsumerNumber

public int getConfiguredConsumerNumber()

Description copied from interface: ConsumerRegistry

Retrieves the number of configured consumers.

Specified by:

getConfiguredConsumerNumber in interface ConsumerRegistry

Returns:

the number of configured consumers.

registerOrDeregisterConsumerWith

public void registerOrDeregisterConsumerWith(String id,
                                    boolean register)

Description copied from interface: ConsumerRegistry

Attempts to register (if the specified boolean is true) or deregister (otherwise) the consumer associated with the specified identifier with the associated remote producer.

Specified by:

registerOrDeregisterConsumerWith in interface ConsumerRegistry

Parameters:

id - the identifier of the consumer to de-/register

register - true if a registration should be attempted, false if we want to deregister the specified consumer

getConsumers

protected List<WSRPConsumer> getConsumers(boolean startConsumers)