Package org.opencastproject.execute.operation.handler

Class ExecuteOnceWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.execute.operation.handler.ExecuteOnceWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class ExecuteOnceWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

Runs an operation once with using elements within a certain MediaPackage as parameters

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

AbstractWorkflowOperationHandler.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXEC_PROPERTY	Property containing the command to run
protected ExecuteService	executeService	The text analyzer
static final String	EXPECTED_TYPE_PROPERTY	Property containing the expected type of the element generated by this operation
static final String	LOAD_PROPERTY	Property containingn an approximation of the load imposed by running this operation
static final String	OUTPUT_FILENAME_PROPERTY	Property containing the filename of the elements created by this operation
static final String	PARAMS_PROPERTY	Property containing the list of command parameters
static final String	SET_WF_PROPS_PROPERTY	Property to control whether command output will be used to set workflow properties
static final String	TARGET_FLAVOR_PROPERTY	Property containing the flavor that the resulting mediapackage elements will be assigned
static final String	TARGET_FLAVORS_PROPERTY	Property should be empty, but is needed in order to parse optional target-flavors
static final String	TARGET_TAG_PROPERTY	Property should be empty, but will be checked, if target-tags is empty
static final String	TARGET_TAGS_PROPERTY	Property containing the tags that the resulting mediapackage elements will be assigned
protected Workspace	workspace	The workspace service

Fields inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

description, id, serviceRegistry, SOURCE_FLAVOR, SOURCE_FLAVORS, SOURCE_TAG, SOURCE_TAGS, TARGET_FLAVOR, TARGET_FLAVORS, TARGET_TAG, TARGET_TAGS

Constructor Summary

Constructors

Constructor	Description
ExecuteOnceWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
void	destroy(WorkflowInstance workflowInstance, JobContext context)	Clean up after a workflow operation finishes
String	getDescription()	Returns a description of what this handler does.
String	getId()	The identifier used to map a workflow operation to its handler
void	setExecuteService(ExecuteService service)	Sets the service
protected void	setMediaInspectionService(MediaInspectionService mediaInspectionService)	Sets the media inspection service
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
void	setWorkspace(Workspace workspace)	Sets a reference to the workspace service.
WorkflowOperationResult	skip(WorkflowInstance workflowInstance, JobContext context)	Skips the workflow operation on this WorkflowInstance.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

Methods inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

activate, applyTargetTagsToElement, asList, createResult, createResult, createResult, createResult, equals, getCfg, getConfig, getConfig, getConfig, getFileNameFromElements, getOptConfig, getOptConfig, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

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

Field Details

EXEC_PROPERTY

public static final String EXEC_PROPERTY

Property containing the command to run

See Also:

• Constant Field Values

PARAMS_PROPERTY

public static final String PARAMS_PROPERTY

Property containing the list of command parameters

See Also:

• Constant Field Values

LOAD_PROPERTY

public static final String LOAD_PROPERTY

Property containingn an approximation of the load imposed by running this operation

See Also:

• Constant Field Values

OUTPUT_FILENAME_PROPERTY

public static final String OUTPUT_FILENAME_PROPERTY

Property containing the filename of the elements created by this operation

See Also:

• Constant Field Values

EXPECTED_TYPE_PROPERTY

public static final String EXPECTED_TYPE_PROPERTY

Property containing the expected type of the element generated by this operation

See Also:

• Constant Field Values

TARGET_FLAVOR_PROPERTY

public static final String TARGET_FLAVOR_PROPERTY

Property containing the flavor that the resulting mediapackage elements will be assigned

See Also:

• Constant Field Values

TARGET_FLAVORS_PROPERTY

public static final String TARGET_FLAVORS_PROPERTY

Property should be empty, but is needed in order to parse optional target-flavors

See Also:

• Constant Field Values

TARGET_TAGS_PROPERTY

public static final String TARGET_TAGS_PROPERTY

Property containing the tags that the resulting mediapackage elements will be assigned

See Also:

• Constant Field Values

TARGET_TAG_PROPERTY

public static final String TARGET_TAG_PROPERTY

Property should be empty, but will be checked, if target-tags is empty

See Also:

• Constant Field Values

SET_WF_PROPS_PROPERTY

public static final String SET_WF_PROPS_PROPERTY

Property to control whether command output will be used to set workflow properties

See Also:

• Constant Field Values

executeService

protected ExecuteService executeService

The text analyzer

workspace

protected Workspace workspace

The workspace service

Constructor Details

ExecuteOnceWorkflowOperationHandler

public ExecuteOnceWorkflowOperationHandler()

Method Details

start

public WorkflowOperationResult start(WorkflowInstance workflowInstance,
 JobContext context)
                              throws WorkflowOperationException

Runs the workflow operation on this WorkflowInstance. If the execution fails for some reason, this must throw a WorkflowOperationException in order to handle the problem gracefully. Runtime exceptions will cause the entire workflow instance to fail.

Specified by:

start in interface WorkflowOperationHandler

Specified by:

start in class AbstractWorkflowOperationHandler

Parameters:

workflowInstance - the workflow instance

context - the job context

Returns:

the WorkflowOperationResult containing a potentially modified MediaPackage and whether to put the workflow instance into a wait state.

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly, and the default error handling should be invoked.

See Also:

• WorkflowOperationHandler.start(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

skip

public WorkflowOperationResult skip(WorkflowInstance workflowInstance,
 JobContext context)
                             throws WorkflowOperationException

Skips the workflow operation on this WorkflowInstance. If the execution fails for some reason, this must throw a WorkflowOperationException in order to handle the problem gracefully. Runtime exceptions will cause the entire workflow instance to fail.

Specified by:

skip in interface WorkflowOperationHandler

Overrides:

skip in class AbstractWorkflowOperationHandler

Parameters:

workflowInstance - the workflow instance

context - the job context

Returns:

TODO

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly, and the default error handling should be invoked.

See Also:

• WorkflowOperationHandler.skip(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

getId

public String getId()

Description copied from class: AbstractWorkflowOperationHandler

The identifier used to map a workflow operation to its handler

Specified by:

getId in interface WorkflowOperationHandler

Overrides:

getId in class AbstractWorkflowOperationHandler

Returns:

This handler's identifier

See Also:

• WorkflowOperationHandler.getId()

getDescription

public String getDescription()

Description copied from class: AbstractWorkflowOperationHandler

Returns a description of what this handler does.

Specified by:

getDescription in interface WorkflowOperationHandler

Overrides:

getDescription in class AbstractWorkflowOperationHandler

Returns:

The handler's description

See Also:

• WorkflowOperationHandler.getDescription()

destroy

public void destroy(WorkflowInstance workflowInstance,
 JobContext context)
             throws WorkflowOperationException

Description copied from class: AbstractWorkflowOperationHandler

Clean up after a workflow operation finishes

Specified by:

destroy in interface WorkflowOperationHandler

Overrides:

destroy in class AbstractWorkflowOperationHandler

Parameters:

workflowInstance - The workflow instance

context - the job context

Throws:

WorkflowOperationException - If the workflow operation fails to clean up properly.

See Also:

• WorkflowOperationHandler.destroy(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

setExecuteService

public void setExecuteService(ExecuteService service)

Sets the service

Parameters:

service -

setWorkspace

public void setWorkspace(Workspace workspace)

Sets a reference to the workspace service.

Parameters:

workspace -

setMediaInspectionService

protected void setMediaInspectionService(MediaInspectionService mediaInspectionService)

Sets the media inspection service

Parameters:

mediaInspectionService - an instance of the media inspection service

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Description copied from class: AbstractWorkflowOperationHandler

Sets the service registry. This method is here as a convenience for developers that need the registry to do job waiting.

Overrides:

setServiceRegistry in class AbstractWorkflowOperationHandler

Parameters:

serviceRegistry - the service registry