org.gatein.wsrp.consumer.spi

Interface ConsumerRegistrySPI

All Superinterfaces:

ConsumerRegistry

All Known Implementing Classes:

AbstractConsumerRegistry, InMemoryConsumerRegistry, XMLConsumerRegistry

public interface ConsumerRegistrySPI
extends ConsumerRegistry

Defines the behavior that ConsumerRegistry implementors need to provide in addition to the client-facing API provided by ConsumerRegistry itself.

Author:

Chris Laprun

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.
void	deregisterWithFederatingPortletInvoker(WSRPConsumer consumer) Deregisters the specified WSRPConsumer with the FederatingPortletInvoker.
MigrationService	getMigrationService()
long	getPersistedLastModifiedForProducerInfoWith(String id) Checks the last modification time that was persisted for the ProducerInfo identified by the specified identifier.
Iterator<ProducerInfo>	getProducerInfosFromStorage() Retrieves all ProducerInfos currently persisted from the persistent store.
SessionRegistry	getSessionRegistry()
ProducerInfo	loadProducerInfo(String id) Loads the ProducerInfo associated with the specified identifier from the persistent state.
void	registerWithFederatingPortletInvoker(WSRPConsumer consumer) Registers the specified WSRPConsumer with the FederatingPortletInvoker.
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	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	update(ProducerInfo producerInfo) Persists the changes made to an already persisted ProducerInfo.

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

activateConsumerWith, containsConsumer, createConsumer, deactivateConsumerWith, destroyConsumer, getConfiguredConsumerNumber, getConfiguredConsumers, getConfiguredConsumersIds, getConsumer, getFederatingPortletInvoker, registerOrDeregisterConsumerWith, reloadConsumers, updateProducerInfo

Method Detail

setSessionEventBroadcaster

void setSessionEventBroadcaster(SessionEventBroadcaster sessionEventBroadcaster)

setFederatingPortletInvoker

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

getMigrationService

MigrationService getMigrationService()

setMigrationService

void setMigrationService(MigrationService migrationService)

getSessionRegistry

SessionRegistry getSessionRegistry()

setSessionRegistry

void setSessionRegistry(SessionRegistry sessionRegistry)

start

void start()
           throws Exception

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

Throws:

Exception

stop

void stop()
          throws Exception

Stops all consumers, deregistering them with the FederatingPortletInvoker.

Throws:

Exception

save

void save(ProducerInfo info,
        String messageOnError)
          throws ConsumerException

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

Throws:

ConsumerException

delete

void delete(ProducerInfo info)
            throws ConsumerException

Deletes the specified ProducerInfo from persistence.

Parameters:

info - the ProducerInfo to delete

Throws:

ConsumerException

update

String update(ProducerInfo producerInfo)

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

getProducerInfosFromStorage

Iterator<ProducerInfo> getProducerInfosFromStorage()

Retrieves all ProducerInfos currently persisted from the persistent store.

Returns:

all ProducerInfos currently persisted from the persistent store.

loadProducerInfo

ProducerInfo loadProducerInfo(String id)

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

createConsumerFrom

WSRPConsumer createConsumerFrom(ProducerInfo producerInfo,
                              boolean putInCache)

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

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

registerWithFederatingPortletInvoker

void registerWithFederatingPortletInvoker(WSRPConsumer consumer)

Registers the specified WSRPConsumer with the FederatingPortletInvoker.

Parameters:

consumer - the WSRPConsumer to register

deregisterWithFederatingPortletInvoker

void deregisterWithFederatingPortletInvoker(WSRPConsumer consumer)

Deregisters the specified WSRPConsumer with the FederatingPortletInvoker.

Parameters:

consumer - the WSRPConsumer to deregister

getPersistedLastModifiedForProducerInfoWith

long getPersistedLastModifiedForProducerInfoWith(String id)

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.

Parameters:

id - the identifier of the ProducerInfo we want to check

Returns:

the last mo