org.alfresco.web.scripts

Class SingletonValueProcessorExtension<T>

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessorExtension

org.alfresco.web.scripts.SingletonValueProcessorExtension<T>

All Implemented Interfaces:

org.springframework.extensions.surf.core.processor.ProcessorExtension

Direct Known Subclasses:

DictionaryQuery, GoogleDocsStatus, ImapServerStatus, MimetypesQuery, SyncModeConfig

public abstract class SingletonValueProcessorExtension<T>
extends org.springframework.extensions.webscripts.processor.BaseProcessorExtension

Helper base class to wrap the thread-safe singleton locking pattern used to retrieve single instance values from the repository. Example might be the Data Dictionary (used by all users, different per tenant, only retrieved once) or the Sync Mode status (used by all users, same per tenant, only retrieved once).

The implementing class only needs to provide method to perform the remote retrieval of the value and indicate if the value needs to be stored per-tenant or not.

Author:

Kevin Roast

Constructor Summary

Constructors

Constructor and Description
SingletonValueProcessorExtension()

Method Summary

Methods

Modifier and Type	Method and Description
protected T	getSingletonValue() Thread-safe get of the singleton value.
protected T	getSingletonValue(boolean tenant) Thread-safe get of the singleton value.
protected abstract String	getValueName() Output value name for informational and error messages to the administrator.
protected abstract T	retrieveValue(String userId, String storeId) Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API.

Methods inherited from class org.springframework.extensions.webscripts.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessors

Methods inherited from class java.lang.Object

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

Constructor Detail

SingletonValueProcessorExtension

public SingletonValueProcessorExtension()

Method Detail

getSingletonValue

protected final T getSingletonValue()

Thread-safe get of the singleton value.

Returns:

singleton value

getSingletonValue

protected final T getSingletonValue(boolean tenant)

Thread-safe get of the singleton value. Can be optionally stored per tenant based on user Id.

Parameters:

tenant - True to get/store per tenant, false for a single value for all repo instances.

Returns:

singleton value, optionally per tenant.

retrieveValue

protected abstract T retrieveValue(String userId,
              String storeId)
                            throws org.springframework.extensions.surf.exception.ConnectorServiceException

Method for implementing class to provide that retrieve the remote value from the appropriate endpoint and API. This is generally used to execute a REST API and extract a value from a response. The value is then automatically stored by the base class.

Parameters:

userId - Current user Id

storeId - Current store Id if any - may be used if per-tenant values are required

Returns:

value from the remote endpoint

Throws:

org.springframework.extensions.surf.exception.ConnectorServiceException

getValueName

protected abstract String getValueName()

Output value name for informational and error messages to the administrator.

Returns:

output value name