Package org.opencastproject.workflow.handler.hello

Class HelloWorldWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.hello.HelloWorldWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class HelloWorldWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

The HelloWorldWorkflowOperationHandler provides a very simple example of how a workflow operation works and can be a starting point for new developments. Like the other hello-world modules, this is intentionally not included in the Opencast distributions and thus not listed in the documentation since people cannot actually use it.

Nested Class Summary

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

AbstractWorkflowOperationHandler.Configuration

Field Summary

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
HelloWorldWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
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, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

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

Constructor Details

HelloWorldWorkflowOperationHandler

public HelloWorldWorkflowOperationHandler()

Method Details

start

public WorkflowOperationResult start(WorkflowInstance workflowInstance,
 JobContext context)

Description copied from class: AbstractWorkflowOperationHandler

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.

See Also:

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