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

Class ChainTypeImpl

java.lang.Object

org.nuxeo.ecm.automation.core.impl.ChainTypeImpl

All Implemented Interfaces:

OperationType

public class ChainTypeImpl
extends Object
implements OperationType

Since:

5.7.2 Operation Type Implementation for a chain

Field Summary

Fields

Modifier and Type	Field	Description
protected OperationChain	chain
protected String	contributingComponent	The contribution fragment name.
protected OperationChainContribution	contribution	The operation chain XMAP contribution
protected InvokableMethod[]	methods	Invocable methods.
protected static final Method	runMethod
protected AutomationService	service	The service that registered the operation.

Constructor Summary

Constructors

Constructor	Description
ChainTypeImpl(AutomationService service, OperationChain chain, OperationChainContribution contribution)	Deprecated. since 11.1, see other constructor
ChainTypeImpl(AutomationService service, OperationChain chain, OperationChainContribution contribution, String contributingComponent)

Method Summary

Modifier and Type	Method	Description
ChainTypeImpl	clone()
boolean	equals(Object obj)
String[]	getAliases()	The operation ID Aliases array.
OperationChain	getChain()
protected Class<?>	getChainOutput(Class<?> chainInput, OperationChainContribution.Operation[] operations)
Map<String,Object>	getChainParameters()
String	getContributingComponent()	Gets the name of the component that contributed the operation.
OperationChainContribution	getContribution()
OperationDocumentation	getDocumentation()
String	getId()
List<InvokableMethod>	getMethods()
InvokableMethod[]	getMethodsMatchingInput(Class<?> in)
Class<?>	getOperationOutput(Class<?> input, OperationType operationType)
protected String	getParamDocumentationType(Class<?> type)
protected String	getParamDocumentationType(Class<?> type, boolean isIterable)
AutomationService	getService()	Gets the service that registered that type.
protected ArrayList<String>	getSignature(OperationChainContribution.Operation[] operations)
protected InvokableMethod	getTopMethod(InvokableMethod[] methods)
Class<?>	getType()
int	hashCode()
boolean	isEnabled()
protected static Method	loadRunMethod()
void	merge(OperationType other)
Object	newInstance(OperationContext ctx, Map<String,Object> args)
String	toString()
static ChainTypeImpl	typeof(OperationChain chain, boolean replace)

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.automation.OperationType

getInputType

Field Details

chain

protected OperationChain chain

service

protected AutomationService service

The service that registered the operation.

methods

protected InvokableMethod[] methods

Invocable methods.

contributingComponent

protected String contributingComponent

The contribution fragment name.

contribution

protected OperationChainContribution contribution

The operation chain XMAP contribution

runMethod

protected static final Method runMethod

Constructor Details

ChainTypeImpl

@Deprecated
public ChainTypeImpl(AutomationService service,
 OperationChain chain,
 OperationChainContribution contribution)

Deprecated.

since 11.1, see other constructor

ChainTypeImpl

public ChainTypeImpl(AutomationService service,
 OperationChain chain,
 OperationChainContribution contribution,
 String contributingComponent)

Since:

11.1

Method Details

getChain

public OperationChain getChain()

getChainParameters

public Map<String,Object> getChainParameters()

newInstance

public Object newInstance(OperationContext ctx,
 Map<String,Object> args)
                   throws OperationException

Specified by:

newInstance in interface OperationType

Throws:

OperationException

getService

public AutomationService getService()

Description copied from interface: OperationType

Gets the service that registered that type.

Specified by:

getService in interface OperationType

getId

public String getId()

Specified by:

getId in interface OperationType

getAliases

public String[] getAliases()

Description copied from interface: OperationType

The operation ID Aliases array.

Specified by:

getAliases in interface OperationType

getType

public Class<?> getType()

Specified by:

getType in interface OperationType

getDocumentation

public OperationDocumentation getDocumentation()
                                        throws OperationException

Specified by:

getDocumentation in interface OperationType

Throws:

OperationException

getSignature

protected ArrayList<String> getSignature(OperationChainContribution.Operation[] operations)
                                  throws OperationException

Parameters:

operations - operations listing that chain contains.

Returns:

the chain signature.

Throws:

OperationException

Since:

5.7.2

getChainOutput

protected Class<?> getChainOutput(Class<?> chainInput,
 OperationChainContribution.Operation[] operations)
                           throws OperationException

Throws:

OperationException

Since:

5.7.2

getOperationOutput

public Class<?> getOperationOutput(Class<?> input,
 OperationType operationType)

Since:

5.7.2

getTopMethod

protected InvokableMethod getTopMethod(InvokableMethod[] methods)

Since:

5.7.2 Define the top priority method to take into account for chain operations signature.

getContributingComponent

public String getContributingComponent()

Description copied from interface: OperationType

Gets the name of the component that contributed the operation.

Specified by:

getContributingComponent in interface OperationType

getMethodsMatchingInput

public InvokableMethod[] getMethodsMatchingInput(Class<?> in)

Specified by:

getMethodsMatchingInput in interface OperationType

loadRunMethod

protected static Method loadRunMethod()

getParamDocumentationType

protected String getParamDocumentationType(Class<?> type)

Since:

5.7.2

getParamDocumentationType

protected String getParamDocumentationType(Class<?> type,
 boolean isIterable)

Since:

5.7.2

toString

public String toString()

Overrides:

toString in class Object

getContribution

public OperationChainContribution getContribution()

getMethods

public List<InvokableMethod> getMethods()

Specified by:

getMethods in interface OperationType

Since:

5.7.2

hashCode

public int hashCode()

Specified by:

hashCode in interface OperationType

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface OperationType

Overrides:

equals in class Object

typeof

public static ChainTypeImpl typeof(OperationChain chain,
 boolean replace)

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface OperationType

clone

public ChainTypeImpl clone()

Specified by:

clone in interface OperationType

Overrides:

clone in class Object

merge

public void merge(OperationType other)

Specified by:

merge in interface OperationType