OperationServiceImpl (Nuxeo ECM Projects 5.8-SNAPSHOT API Documentation)

java.lang.Object
- org.nuxeo.ecm.automation.core.impl.OperationServiceImpl

All Implemented Interfaces:

AutomationService
```
public class OperationServiceImpl
extends Object
implements AutomationService
```
The operation registry is thread safe and optimized for modifications at startup and lookups at runtime.

Author:

Bogdan Stefanescu

Constructor Summary

Constructors
Constructor and Description

OperationServiceImpl()

Constructors
Constructor and Description
`OperationServiceImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`CompiledChain`	`compileChain(Class<?> inputType, OperationChain chain)` Builds the operation chain given a context.
`CompiledChain`	`compileChain(Class<?> inputType, OperationParameters... operations)` Same as previous but takes an array of operation parameters
`void`	`flushCompiledChains()`
`<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()`
`ChainException`	`getChainException(String onChainId)`
`ChainException[]`	`getChainExceptions()`
`List<OperationDocumentation>`	`getDocumentation()` Generates a documentation model for all registered operations.
`OperationType`	`getOperation(String id)` Gets an operation type given its ID.
`OperationChain`	`getOperationChain(String id)` Deprecated.
`List<OperationChain>`	`getOperationChains()` Deprecated.
`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.
`void`	`putAutomationFilter(AutomationFilter automationFilter)`
`void`	`putChainException(ChainException exceptionChain)`
`void`	`putOperation(Class<?> type)` Registers an operation given its class.
`void`	`putOperation(Class<?> type, boolean replace)` Registers an operation given its class.
`void`	`putOperation(Class<?> type, boolean replace, String contributingComponent)` Registers an operation given its class.
`void`	`putOperation(OperationType op, boolean replace)`
`void`	`putOperationChain(OperationChain chain)` Deprecated.
`void`	`putOperationChain(OperationChain chain, boolean replace)` Deprecated.
`void`	`putTypeAdapter(Class<?> accept, Class<?> produce, TypeAdapter adapter)` Registers a new type adapter that can adapt an instance of the accepted type into one of the produced type.
`void`	`removeAutomationFilter(AutomationFilter automationFilter)`
`void`	`removeExceptionChain(ChainException exceptionChain)`
`void`	`removeOperation(Class<?> key)` Removes an operation given its class.
`void`	`removeOperationChain(String id)` Deprecated.
`void`	`removeTypeAdapter(Class<?> accept, Class<?> produce)` Removes a type adapter
`Object`	`run(OperationContext ctx, OperationChain chain)` Builds and runs the operation chain given a context.
`Object`	`run(OperationContext ctx, OperationType operationType, Map<String,Object> params)`
`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,Object> runtimeParameters)` TODO avoid creating a temporary chain and then compile it.
`static OperationParameters[]`	`toParams(String... ids)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OperationServiceImpl
```
public OperationServiceImpl()
```
- Method Detail
  - run
```
public Object run(OperationContext ctx,
         String operationId)
           throws Exception
```
    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:
    
    Exception
  - run
```
public Object run(OperationContext ctx,
         OperationChain chain)
           throws Exception
```
    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:
    
    Exception
  - run
```
public Object run(OperationContext ctx,
         String operationId,
         Map<String,Object> runtimeParameters)
           throws Exception
```
    TODO avoid creating a temporary chain and then compile it. try to find a way to execute the single operation without compiling it. (for optimization)
    
    Specified by:
    
    run in interface AutomationService
    
    Throws:
    
    Exception
  - run
```
public Object run(OperationContext ctx,
         OperationType operationType,
         Map<String,Object> params)
           throws Exception
```
    Parameters:
    ctx - the operation context.
    operationType - a chain or an operation.
    params - The chain parameters.
    
    Throws:
    
    Exception
    Since:
    
    5.7.2
  - toParams
```
public static OperationParameters[] toParams(String... ids)
```
  - putOperationChain
```
@Deprecated
public void putOperationChain(OperationChain chain)
                       throws OperationException
```
    Deprecated.
    
    Deprecated since 5.7.2 - Reason: no chain registry existence since chain. became an operation - use #putOperation method instead.
    
    Specified by:
    
    putOperationChain in interface AutomationService
    
    Throws:
    
    OperationException
  - putOperationChain
```
@Deprecated
public void putOperationChain(OperationChain chain,
                                boolean replace)
                       throws OperationException
```
    Deprecated.
    
    Deprecated since 5.7.2 - Reason: no chain registry existence since chain. became an operation - use #putOperation method instead.
    
    Specified by:
    
    putOperationChain in interface AutomationService
    
    Throws:
    
    OperationException
  - removeOperationChain
```
@Deprecated
public void removeOperationChain(String id)
```
    Deprecated.
    
    Deprecated since 5.7.2 - Reason: no chain registry existence since chain. became an operation - use #removeOperation method instead.
    
    Specified by:
    
    removeOperationChain in interface AutomationService
  - getOperationChain
```
@Deprecated
public OperationChain getOperationChain(String id)
                                 throws OperationNotFoundException
```
    Deprecated.
    
    Deprecated since 5.7.2 - Reason: no chain registry existence since chain. became an operation - use #getOperation method instead.
    
    Specified by:
    
    getOperationChain in interface AutomationService
    
    Throws:
    
    OperationNotFoundException
  - getOperationChains
```
@Deprecated
public List<OperationChain> getOperationChains()
```
    Deprecated.
    
    Deprecated since 5.7.2 - Reason: no chain registry existence since chain. became an operation - use #getOperations method instead.
    
    Specified by:
    
    getOperationChains in interface AutomationService
    
    Returns:
    the list or an empty list if no registered chains exists
  - flushCompiledChains
```
public void flushCompiledChains()
```
  - putOperation
```
public void putOperation(Class<?> type)
                  throws OperationException
```
    Description copied from interface: AutomationService
    
    Registers an operation given its class. The operation class MUST be annotated using Operation annotation. If an operation having the same ID exists an exception will be thrown.
    
    Specified by:
    
    putOperation in interface AutomationService
    
    Throws:
    
    OperationException
  - putOperation
```
public void putOperation(Class<?> type,
                boolean replace)
                  throws OperationException
```
    Description copied from interface: AutomationService
    
    Registers an operation given its class. The operation class MUST be annotated using Operation annotation. If the replace argument is true then any existing operation having the same ID will replaced with this one.
    
    Specified by:
    
    putOperation in interface AutomationService
    
    Throws:
    
    OperationException
  - putOperation
```
public void putOperation(Class<?> type,
                boolean replace,
                String contributingComponent)
                  throws OperationException
```
    Description copied from interface: AutomationService
    
    Registers an operation given its class. The operation class MUST be annotated using Operation annotation. If the replace argument is true then any existing operation having the same ID will replaced with this one. Third argument represents the name of the component registring the operation
    
    Specified by:
    
    putOperation in interface AutomationService
    
    Throws:
    
    OperationException
  - putOperation
```
public void putOperation(OperationType op,
                boolean replace)
                  throws OperationException
```
    Throws:
    
    OperationException
  - removeOperation
```
public void removeOperation(Class<?> key)
```
    Description copied from interface: AutomationService
    
    Removes an operation given its class. If the operation was not registered does nothing.
    
    Specified by:
    
    removeOperation in interface AutomationService
  - 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,
                         OperationChain chain)
                           throws Exception,
                                  InvalidChainException
```
    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:
    
    Exception
    
    InvalidChainException
  - compileChain
```
public CompiledChain compileChain(Class<?> inputType,
                         OperationParameters... operations)
                           throws Exception,
                                  InvalidChainException
```
    Description copied from interface: AutomationService
    
    Same as previous but takes an array of operation parameters
    
    Specified by:
    
    compileChain in interface AutomationService
    
    Throws:
    
    Exception
    
    InvalidChainException
  - putTypeAdapter
```
public void putTypeAdapter(Class<?> accept,
                  Class<?> produce,
                  TypeAdapter adapter)
```
    Description copied from interface: AutomationService
    
    Registers a new type adapter that can adapt an instance of the accepted type into one of the produced type.
    
    Specified by:
    
    putTypeAdapter in interface AutomationService
  - removeTypeAdapter
```
public void removeTypeAdapter(Class<?> accept,
                     Class<?> produce)
```
    Description copied from interface: AutomationService
    
    Removes a type adapter
    
    Specified by:
    
    removeTypeAdapter in interface AutomationService
  - 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 Exception
```
    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:
    
    Exception
  - 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)
```
  - putChainException
```
public void putChainException(ChainException exceptionChain)
```
    Specified by:
    
    putChainException in interface AutomationService
    
    Since:
    
    5.7.3
  - removeExceptionChain
```
public void removeExceptionChain(ChainException exceptionChain)
```
    Specified by:
    
    removeExceptionChain in interface AutomationService
    
    Since:
    
    5.7.3
  - 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
  - putAutomationFilter
```
public void putAutomationFilter(AutomationFilter automationFilter)
```
    Specified by:
    
    putAutomationFilter in interface AutomationService
    
    Since:
    
    5.7.3
  - removeAutomationFilter
```
public void removeAutomationFilter(AutomationFilter automationFilter)
```
    Specified by:
    
    removeAutomationFilter 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

Class OperationServiceImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OperationServiceImpl

Method Detail

run

run

run

run

toParams

putOperationChain

putOperationChain

removeOperationChain

getOperationChain

getOperationChains

flushCompiledChains

putOperation

putOperation

putOperation

putOperation

removeOperation

getOperations

getOperation

hasOperation

compileChain

compileChain

putTypeAdapter

removeTypeAdapter

getTypeAdapter

isTypeAdaptable

getAdaptedValue

getDocumentation

getTypeForPrimitive

putChainException

removeExceptionChain

getChainExceptions

getChainException

hasChainException

putAutomationFilter

removeAutomationFilter

getAutomationFilter

getAutomationFilters