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

Class OperationTypeImpl

java.lang.Object

org.nuxeo.ecm.automation.core.impl.OperationTypeImpl

All Implemented Interfaces:

OperationType

public class OperationTypeImpl
extends Object
implements OperationType

Author:

Bogdan Stefanescu, Guillaume Renard

Field Summary

Fields

Modifier and Type	Field	Description
protected String[]	aliases	The operation ID Aliases array.
protected String	contributingComponent
protected boolean	enabled
protected String	id	The operation ID - used for lookups.
protected List<Field>	injectableFields	Fields that should be injected from context
protected String	inputType	The input type of a chain/operation.
protected List<InvokableMethod>	methods	Invocable methods
protected Map<String,Field>	params	Injectable parameters.
protected AutomationService	service	The service that registered the operation
protected Class<?>	type	The operation type
protected List<WidgetDefinition>	widgetDefinitionList

Constructor Summary

Constructors

Constructor	Description
OperationTypeImpl(AutomationService service, Class<?> type)
OperationTypeImpl(AutomationService service, Class<?> type, String contributingComponent)
OperationTypeImpl(AutomationService service, Class<?> type, String contributingComponent, List<WidgetDefinition> widgetDefinitionList)

Method Summary

Modifier and Type	Method	Description
OperationTypeImpl	clone()
boolean	equals(Object obj)
String[]	getAliases()	The operation ID Aliases array.
String	getContributingComponent()	Gets the name of the component that contributed the operation.
OperationDocumentation	getDocumentation()
String	getId()
String	getInputType()	The input type of a chain/operation.
List<InvokableMethod>	getMethods()
InvokableMethod[]	getMethodsMatchingInput(Class<?> in)
protected String	getParamDocumentationType(Class<?> type)
protected String	getParamDocumentationType(Class<?> type, boolean isIterable)
AutomationService	getService()	Gets the service that registered that type.
Class<?>	getType()
int	hashCode()
protected void	initFields()
protected void	initMethods()
void	inject(OperationContext ctx, Map<String,?> args, Object target)
boolean	isEnabled()
void	merge(OperationType other)
Object	newInstance(OperationContext ctx, Map<String,Object> args)
protected Object	resolveObject(OperationContext ctx, String key, Map<String,?> args)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

service

protected AutomationService service

The service that registered the operation

id

protected String id

The operation ID - used for lookups.

aliases

protected String[] aliases

The operation ID Aliases array.

Since:

7.1

type

protected Class<?> type

The operation type

params

protected Map<String,Field> params

Injectable parameters. a map between the parameter name and the Field object

methods

protected List<InvokableMethod> methods

Invocable methods

injectableFields

protected List<Field> injectableFields

Fields that should be injected from context

inputType

protected String inputType

The input type of a chain/operation. If set, the following input types {"document", "documents", "blob", "blobs"} for all 'run method(s)' will handled. Other values will be adapted as java.lang.Object. If not set, Automation will set the input type(s) as the 'run methods(s)' parameter types (by introspection).

Since:

7.4

contributingComponent

protected String contributingComponent

widgetDefinitionList

protected List<WidgetDefinition> widgetDefinitionList

enabled

protected boolean enabled

Since:

2021.17

Constructor Detail

OperationTypeImpl

public OperationTypeImpl(AutomationService service,
                         Class<?> type)

OperationTypeImpl

public OperationTypeImpl(AutomationService service,
                         Class<?> type,
                         String contributingComponent)

OperationTypeImpl

public OperationTypeImpl(AutomationService service,
                         Class<?> type,
                         String contributingComponent,
                         List<WidgetDefinition> widgetDefinitionList)

Since:

5.9.5

Method Detail

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

getInputType

public String getInputType()

Description copied from interface: OperationType

The input type of a chain/operation. If set, the following input types {"document", "documents", "blob", "blobs"} for all 'run method(s)' will handled. Other values will be adapted as java.lang.Object. If not set, Automation will set the input type(s) as the 'run methods(s)' parameter types (by introspection).

Specified by:

getInputType in interface OperationType

initMethods

protected void initMethods()

initFields

protected void initFields()

newInstance

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

Specified by:

newInstance in interface OperationType

Throws:

OperationException

resolveObject

protected Object resolveObject(OperationContext ctx,
                               String key,
                               Map<String,?> args)

Since:

5.9.2

inject

public void inject(OperationContext ctx,
                   Map<String,?> args,
                   Object target)
            throws OperationException

Throws:

OperationException

getMethodsMatchingInput

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

Specified by:

getMethodsMatchingInput in interface OperationType

getDocumentation

public OperationDocumentation getDocumentation()

Specified by:

getDocumentation in interface OperationType

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

getParamDocumentationType

protected String getParamDocumentationType(Class<?> type)

getParamDocumentationType

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

toString

public String toString()

Overrides:

toString in class Object

getMethods

public List<InvokableMethod> getMethods()

Specified by:

getMethods in interface OperationType

Since:

5.7.2

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface OperationType

clone

public OperationTypeImpl clone()

Specified by:

clone in interface OperationType

Overrides:

clone in class Object

merge

public void merge(OperationType other)

Specified by:

merge in interface OperationType

hashCode

public int hashCode()

Specified by:

hashCode in interface OperationType

Overrides:

hashCode in class Object

Since:

2021.17

equals

public boolean equals(Object obj)

Specified by:

equals in interface OperationType

Overrides:

equals in class Object

Since:

2021.17