org.gatein.wsrp.consumer.registry

Class JCRConsumerRegistry

java.lang.Object

org.gatein.wsrp.consumer.registry.AbstractConsumerRegistry

org.gatein.wsrp.consumer.registry.JCRConsumerRegistry

All Implemented Interfaces:

ConsumerRegistry, ConsumerRegistrySPI, StoresByPathManager<ProducerInfo>

public class JCRConsumerRegistry
extends AbstractConsumerRegistry
implements StoresByPathManager<ProducerInfo>

Provides JCR-backed (using Chromattic) implementation of ConsumerRegistry.

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

Modifier and Type	Field and Description
static List<Class>	mappingClasses Classes that this class knows how to map from JCR data and back

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

consumerCache, log

Constructor Summary

Constructors

Modifier	Constructor and Description
	JCRConsumerRegistry(ChromatticPersister persister)
protected	JCRConsumerRegistry(ChromatticPersister persister, boolean loadFromXMLIfNeeded) for tests
protected	JCRConsumerRegistry(ChromatticPersister persister, boolean loadFromXMLIfNeeded, String rootNodePath) Creates a new JCRConsumerRegistry.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsConsumer(String id)
void	delete(ProducerInfo info)
String	getChildPath(ProducerInfo needsComputedPath) Computes the JCR path of the specified child from the root of the workspace associated with the data.
int	getConfiguredConsumerNumber()
Collection<String>	getConfiguredConsumersIds()
long	getPersistedLastModifiedForProducerInfoWith(String id)
Iterator<ProducerInfo>	getProducerInfosFromStorage()
protected void	initConsumerCache()
LastModified	lastModifiedToUpdateOnDelete(org.chromattic.api.ChromatticSession session) Retrieves a LastModified view of the object that needs to be set as modified when this manager is asked to delete a child.
ProducerInfo	loadProducerInfo(String id)
void	save(ProducerInfo info, String messageOnError)
void	setConfigurationIS(InputStream is) Specifies an InputStream pointing to a configuration this registry needs to load.
protected void	setLoadFromXMLIfNeeded(boolean loadFromXMLIfNeeded) for tests
String	update(ProducerInfo producerInfo)

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

activateConsumer, activateConsumerWith, createConsumer, createConsumerFrom, deactivateConsumer, deactivateConsumerWith, deregisterWithFederatingPortletInvoker, destroyConsumer, getConfiguredConsumers, getConsumer, getConsumers, getFederatingPortletInvoker, getMigrationService, getSessionRegistry, registerOrDeregisterConsumerWith, registerWithFederatingPortletInvoker, reloadConsumers, setConsumerCache, setFederatingPortletInvoker, setMigrationService, setSessionEventBroadcaster, setSessionRegistry, start, stop, updateProducerInfo

Methods inherited from class java.lang.Object

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

Field Detail

mappingClasses

public static final List<Class> mappingClasses

Classes that this class knows how to map from JCR data and back

Constructor Detail

JCRConsumerRegistry

public JCRConsumerRegistry(ChromatticPersister persister)
                    throws Exception

Throws:

Exception

JCRConsumerRegistry

protected JCRConsumerRegistry(ChromatticPersister persister,
                   boolean loadFromXMLIfNeeded)

for tests

Parameters:

persister -

loadFromXMLIfNeeded -

JCRConsumerRegistry

protected JCRConsumerRegistry(ChromatticPersister persister,
                   boolean loadFromXMLIfNeeded,
                   String rootNodePath)

Creates a new JCRConsumerRegistry. for tests

Parameters:

persister - the ChromatticPersister that will deal with JCR via Chromattic

loadFromXMLIfNeeded - whether or not we should load initial data from an XML configuration file

rootNodePath - the root node path, only useful to be specified for tests where the root node path of the JCR hierarchy might not be standard

Method Detail

setLoadFromXMLIfNeeded

protected void setLoadFromXMLIfNeeded(boolean loadFromXMLIfNeeded)

for tests

Parameters:

loadFromXMLIfNeeded -

initConsumerCache

protected void initConsumerCache()

Specified by:

initConsumerCache in class AbstractConsumerRegistry

setConfigurationIS

public void setConfigurationIS(InputStream is)

Specifies an InputStream pointing to a configuration this registry needs to load.

Parameters:

is - an InputStream pointing to a configuration this registry needs to load

save

public void save(ProducerInfo info,
        String messageOnError)

Specified by:

save in interface ConsumerRegistrySPI

delete

public void delete(ProducerInfo info)

Specified by:

delete in interface ConsumerRegistrySPI

update

public String update(ProducerInfo producerInfo)

Specified by:

update in interface ConsumerRegistrySPI

getProducerInfosFromStorage

public Iterator<ProducerInfo> getProducerInfosFromStorage()

Specified by:

getProducerInfosFromStorage in interface ConsumerRegistrySPI

loadProducerInfo

public ProducerInfo loadProducerInfo(String id)

Specified by:

loadProducerInfo in interface ConsumerRegistrySPI

getPersistedLastModifiedForProducerInfoWith

public long getPersistedLastModifiedForProducerInfoWith(String id)

Specified by:

getPersistedLastModifiedForProducerInfoWith in interface ConsumerRegistrySPI

Overrides:

getPersistedLastModifiedForProducerInfoWith in class AbstractConsumerRegistry

containsConsumer

public boolean containsConsumer(String id)

Specified by:

containsConsumer in interface ConsumerRegistry

Overrides:

containsConsumer in class AbstractConsumerRegistry

getConfiguredConsumersIds

public Collection<String> getConfiguredConsumersIds()

Specified by:

getConfiguredConsumersIds in interface ConsumerRegistry

getConfiguredConsumerNumber

public int getConfiguredConsumerNumber()

Specified by:

getConfiguredConsumerNumber in interface ConsumerRegistry

Overrides:

getConfiguredConsumerNumber in class AbstractConsumerRegistry

getChildPath

public String getChildPath(ProducerInfo needsComputedPath)

Description copied from interface: StoresByPathManager

Computes the JCR path of the specified child from the root of the workspace associated with the data.

Specified by:

getChildPath in interface StoresByPathManager<ProducerInfo>

Parameters:

needsComputedPath - the child we want to retrieve the path of

Returns:

the JCR path of the specified child.

lastModifiedToUpdateOnDelete

public LastModified lastModifiedToUpdateOnDelete(org.chromattic.api.ChromatticSession session)

Description copied from interface: StoresByPathManager

Retrieves a LastModified view of the object that needs to be set as modified when this manager is asked to delete a child. GTNWSRP-239

Specified by:

lastModifiedToUpdateOnDelete in interface StoresByPathManager<ProducerInfo>

Parameters:

session - the ChromatticSession managing the deletion

Returns:

a LastModified view of the object that needs to be set as modified when this manager is asked to delete a child or null if no such object exists