org.alfresco.web.scripts

Class SyncModeConfig

java.lang.Object

org.springframework.extensions.webscripts.processor.BaseProcessorExtension

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

org.alfresco.web.scripts.SyncModeConfig

All Implemented Interfaces:

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

public class SyncModeConfig
extends SingletonValueProcessorExtension<String>
implements Serializable

Singleton scripting host object provided to retrieve the value of the Sync Mode configuration from the Alfresco repository.

Author:

Kevin Roast

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SyncModeConfig()

Method Summary

Methods

Modifier and Type	Method and Description
String	getValue()
protected String	getValueName() Output value name for informational and error messages to the administrator.
protected String	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.alfresco.web.scripts.SingletonValueProcessorExtension

getSingletonValue, getSingletonValue

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

SyncModeConfig

public SyncModeConfig()

Method Detail

getValue

public String getValue()

Returns:

the Sync Mode configuration from the Alfresco repository.

Will be one of: CLOUD, ON_PREMISE, OFF

retrieveValue

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

Description copied from class: SingletonValueProcessorExtension

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.

Specified by:

retrieveValue in class SingletonValueProcessorExtension<String>

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 String getValueName()

Description copied from class: SingletonValueProcessorExtension

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

Specified by:

getValueName in class SingletonValueProcessorExtension<String>

Returns:

output value name