Package org.nuxeo.ecm.automation.core.impl

Class OperationServiceImpl

java.lang.Object

org.nuxeo.ecm.automation.core.impl.OperationServiceImpl

All Implemented Interfaces:

AutomationAdmin, AutomationService

public class OperationServiceImpl
extends Object
implements AutomationService, AutomationAdmin

The operation registry is thread safe and optimized for modifications at startup and lookups at runtime.

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field	Description
protected final AdapterKeyedRegistry	adapters
protected final Map<String,ChainException>	chainExceptions
protected final OperationChainCompiler	compiler
static final String	EXPORT_ALIASES_CONFIGURATION_PARAM
protected final Map<String,ChainExceptionFilter>	filters
protected final Map<String,OperationType>	operations

Constructor Summary

Constructors

Constructor	Description
OperationServiceImpl(Map<String,OperationType> operations, Map<String,ChainException> chainExceptions, Map<String,ChainExceptionFilter> filters, Map<TypeAdapterKey,? extends TypeAdapter> adapters)

Method Summary

Modifier and Type	Method	Description
CompiledChain	compileChain(Class<?> inputType, OperationChain chain)	Builds the operation chain given a context.
CompiledChain	compileChain(Class<?> inputType, OperationParameters... ops)	Same as previous but takes an array of operation parameters
void	flushCompiledChains()	Flush compiled chains to handle hot-reload
<T> T	getAdaptedValue(OperationContext ctx, Object toAdapt, Class<?> targetType)	Adapts an object to a target type if possible otherwise throws an exception.
AutomationFilter	getAutomationFilter(String id)
AutomationFilter[]	getAutomationFilters()
protected CatchChainException	getCatchChainExceptionByPriority(CatchChainException catchChainException, CatchChainException catchChainExceptionItem)
ChainException	getChainException(String onChainId)
ChainException[]	getChainExceptions()
protected String	getChainExceptionToRun(OperationContext ctx, String operationTypeId, OperationException oe)
List<OperationDocumentation>	getDocumentation()	Generates a documentation model for all registered operations.
OperationType	getOperation(String id)	Gets an operation type given its ID.
protected OperationChain	getOperationChain(String id)
OperationType[]	getOperations()	Gets all operation types that was registered.
TypeAdapter	getTypeAdapter(Class<?> accept, Class<?> produce)	Gets a type adapter for the input type accept and the output type produce.
static Class<?>	getTypeForPrimitive(Class<?> primitiveType)
boolean	hasChainException(String onChainId)
boolean	hasOperation(String id)
boolean	isTypeAdaptable(Class<?> typeToAdapt, Class<?> targetType)	Checks whether or not the given type is adaptable into the target type.
Object	run(OperationContext ctx, String operationId)	Same as previous but for managed chains identified by an ID.
Object	run(OperationContext ctx, String operationId, Map<String,?> args)	Shortcut to execute a single operation described by the given ID and map of parameters
Object	run(OperationContext ctx, OperationChain chain)	Builds and runs the operation chain given a context.
Object	runInNewTx(OperationContext ctx, String chainId, Map<String,?> chainParameters, Integer timeout, boolean rollbackGlobalOnError)	This running method execute operation process through a new transaction.
static OperationParameters[]	toParams(String... ids)

Methods inherited from class java.lang.Object

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

Field Details

EXPORT_ALIASES_CONFIGURATION_PARAM

public static final String EXPORT_ALIASES_CONFIGURATION_PARAM

See Also:

• Constant Field Values

operations

protected final Map<String,OperationType> operations

chainExceptions

protected final Map<String,ChainException> chainExceptions

filters

protected final Map<String,ChainExceptionFilter> filters

adapters

protected final AdapterKeyedRegistry adapters

compiler

protected final OperationChainCompiler compiler

Constructor Details

OperationServiceImpl

public OperationServiceImpl(Map<String,OperationType> operations,
 Map<String,ChainException> chainExceptions,
 Map<String,ChainExceptionFilter> filters,
 Map<TypeAdapterKey,? extends TypeAdapter> adapters)

Method Details

run

public Object run(OperationContext ctx,
 String operationId)
           throws OperationException

Description copied from interface: AutomationService

Same as previous but for managed chains identified by an ID. For managed chains always use this method since the compiled chain is cached and run will be faster

Specified by:

run in interface AutomationService

Throws:

OperationException

run

public Object run(OperationContext ctx,
 String operationId,
 Map<String,?> args)
           throws OperationException

Description copied from interface: AutomationService

Shortcut to execute a single operation described by the given ID and map of parameters

Specified by:

run in interface AutomationService

Throws:

OperationException

run

public Object run(OperationContext ctx,
 OperationChain chain)
           throws OperationException

Description copied from interface: AutomationService

Builds and runs the operation chain given a context. If the context input object or the chain cannot be resolved (no path can be found through all the operation in the chain) then InvalidChainException is thrown.

Specified by:

run in interface AutomationService

Throws:

OperationException

runInNewTx

public Object runInNewTx(OperationContext ctx,
 String chainId,
 Map<String,?> chainParameters,
 Integer timeout,
 boolean rollbackGlobalOnError)
                  throws OperationException

Description copied from interface: AutomationService

This running method execute operation process through a new transaction.

Specified by:

runInNewTx in interface AutomationService

Parameters:

ctx - the operation context.

chainId - the chain Id.

chainParameters - chain parameters.

timeout - Transaction timeout.

rollbackGlobalOnError - Rollback or not transaction after failing.

Throws:

OperationException

getChainExceptionToRun

protected String getChainExceptionToRun(OperationContext ctx,
 String operationTypeId,
 OperationException oe)
                                 throws OperationException

Throws:

OperationException

Since:

5.7.3 Fetch the right chain id to run when catching exception for given chain failure.

getCatchChainExceptionByPriority

protected CatchChainException getCatchChainExceptionByPriority(CatchChainException catchChainException,
 CatchChainException catchChainExceptionItem)

Since:

5.7.3

toParams

public static OperationParameters[] toParams(String... ids)

getOperationChain

protected OperationChain getOperationChain(String id)
                                    throws OperationNotFoundException

Throws:

OperationNotFoundException

flushCompiledChains

public void flushCompiledChains()

Description copied from interface: AutomationAdmin

Flush compiled chains to handle hot-reload

Specified by:

flushCompiledChains in interface AutomationAdmin

getOperations

public OperationType[] getOperations()

Description copied from interface: AutomationService

Gets all operation types that was registered.

Specified by:

getOperations in interface AutomationService

getOperation

public OperationType getOperation(String id)
                           throws OperationNotFoundException

Description copied from interface: AutomationService

Gets an operation type given its ID. Throws an exception if the operation is not found.

Specified by:

getOperation in interface AutomationService

Throws:

OperationNotFoundException

hasOperation

public boolean hasOperation(String id)

Specified by:

hasOperation in interface AutomationService

Parameters:

id - operation ID.

Returns:

true if operation registry contains the given operation.

Since:

5.7.2

compileChain

public CompiledChain compileChain(Class<?> inputType,
 OperationParameters... ops)
                           throws OperationException

Description copied from interface: AutomationService

Same as previous but takes an array of operation parameters

Specified by:

compileChain in interface AutomationService

Throws:

OperationException

compileChain

public CompiledChain compileChain(Class<?> inputType,
 OperationChain chain)
                           throws OperationException

Description copied from interface: AutomationService

Builds the operation chain given a context. If the context input object or the chain cannot be resolved (no path can be found through all the operation in the chain) then InvalidChainException is thrown. The returned object can be used to run the chain.

Specified by:

compileChain in interface AutomationService

Throws:

OperationException

getTypeAdapter

public TypeAdapter getTypeAdapter(Class<?> accept,
 Class<?> produce)

Description copied from interface: AutomationService

Gets a type adapter for the input type accept and the output type produce. Returns null if no adapter was registered for these types.

Specified by:

getTypeAdapter in interface AutomationService

isTypeAdaptable

public boolean isTypeAdaptable(Class<?> typeToAdapt,
 Class<?> targetType)

Description copied from interface: AutomationService

Checks whether or not the given type is adaptable into the target type. An instance of an adaptable type can be converted into an instance of the target type.

This is a shortcut to getTypeAdapter(typeToAdapt, targetType) != null

Specified by:

isTypeAdaptable in interface AutomationService

getAdaptedValue

public <T> T getAdaptedValue(OperationContext ctx,
 Object toAdapt,
 Class<?> targetType)
                      throws OperationException

Description copied from interface: AutomationService

Adapts an object to a target type if possible otherwise throws an exception. The method must be called in an operation execution with a valid operation context.

Specified by:

getAdaptedValue in interface AutomationService

Throws:

OperationException

getDocumentation

public List<OperationDocumentation> getDocumentation()
                                              throws OperationException

Description copied from interface: AutomationService

Generates a documentation model for all registered operations. The documentation model is generated from operation annotations and can be used in UI tools to describe operations. The returned list is sorted using operation ID. Optional method.

Specified by:

getDocumentation in interface AutomationService

Throws:

OperationException

getTypeForPrimitive

public static Class<?> getTypeForPrimitive(Class<?> primitiveType)

getChainExceptions

public ChainException[] getChainExceptions()

Specified by:

getChainExceptions in interface AutomationService

Since:

5.7.3

getChainException

public ChainException getChainException(String onChainId)

Specified by:

getChainException in interface AutomationService

Since:

5.7.3

hasChainException

public boolean hasChainException(String onChainId)

Specified by:

hasChainException in interface AutomationService

Since:

5.7.3

getAutomationFilter

public AutomationFilter getAutomationFilter(String id)

Specified by:

getAutomationFilter in interface AutomationService

Since:

5.7.3

getAutomationFilters

public AutomationFilter[] getAutomationFilters()

Specified by:

getAutomationFilters in interface AutomationService

Since:

5.7.3