org.gatein.wsrp.consumer.registry

Interface ConsumerRegistry

All Known Subinterfaces:

ConsumerRegistrySPI

All Known Implementing Classes:

AbstractConsumerRegistry, InMemoryConsumerRegistry, XMLConsumerRegistry

public interface ConsumerRegistry

Handles consumers' persistence and lifecycles.

Since:

2.6

Version:

$Revision: 12693 $

Author:

Chris Laprun

Method Summary

Methods

Modifier and Type	Method and Description
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.
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	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.
Collection<String>	getConfiguredConsumersIds() Retrieves the identifiers for all known consumers.
WSRPConsumer	getConsumer(String id) Retrieves the consumer associated with the specified producer identifier.
org.gatein.pc.federation.FederatingPortletInvoker	getFederatingPortletInvoker() Retrieves the FederatingPortletInvoker used by this ConsumerRegistry to register / unregister consumers as PortletInvokers.
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	reloadConsumers() Reloads consumers from persistence, re-initializing any cache from the persisted state.
String	updateProducerInfo(ProducerInfo producerInfo) Persists the changes made to ProducerInfo.

Method Detail

getConfiguredConsumers

List<WSRPConsumer> getConfiguredConsumers()

Retrieves the list of configured consumers.

Returns:

the list of configured consumers

getConsumer

WSRPConsumer getConsumer(String id)

Retrieves the consumer associated with the specified producer identifier.

Parameters:

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

Returns:

the consumer associated with the specified producer identifier

getFederatingPortletInvoker

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

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.

Returns:

the FederatingPortletInvoker used by this ConsumerRegistry

createConsumer

WSRPConsumer createConsumer(String id,
                          Integer expirationCacheSeconds,
                          String wsdlURL)
                            throws ConsumerException

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.

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

Throws:

ConsumerException - if something went wrong during the creation, in particular, if attempting to create a consumer with an already existing identifier

activateConsumerWith

void activateConsumerWith(String id)
                          throws ConsumerException

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.

Parameters:

id - the identifier of the consumer to be activated

Throws:

ConsumerException

updateProducerInfo

String updateProducerInfo(ProducerInfo producerInfo)
                          throws ConsumerException

Persists the changes made to ProducerInfo.

Parameters:

producerInfo - the ProducerInfo to persist

Returns:

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

Throws:

ConsumerException

deactivateConsumerWith

void deactivateConsumerWith(String id)
                            throws ConsumerException

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

Parameters:

id - the identifier associated with the consumer to deactivate

Throws:

ConsumerException

registerOrDeregisterConsumerWith

void registerOrDeregisterConsumerWith(String id,
                                    boolean register)
                                      throws ConsumerException

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

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

Throws:

ConsumerException - if something went wrong in particular during the WSRP interaction

destroyConsumer

void destroyConsumer(String id)
                     throws ConsumerException

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.

Parameters:

id - the identifier associated with the consumer to destroy

Throws:

ConsumerException - if something went wrong, in particular during potential WSRP interactions

reloadConsumers

void reloadConsumers()

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

containsConsumer

boolean containsConsumer(String id)

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

Parameters:

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

Returns:

getConfiguredConsumersIds

Collection<String> getConfiguredConsumersIds()

Retrieves the identifiers for all known consumers.

Returns:

the identifiers for all known consumers.

getConfiguredConsumerNumber

int getConfiguredConsumerNumber()

Retrieves the number of configured consumers.

Returns:

the number of configured consumers.