Package org.opencastproject.workflow.handler.workflow

Class ResumableWorkflowOperationHandlerBase

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.workflow.ResumableWorkflowOperationHandlerBase

All Implemented Interfaces:

ResumableWorkflowOperationHandler, WorkflowOperationHandler

Direct Known Subclasses:

ConfigureByDublinCoreTermWOH, ErrorResolutionWorkflowOperationHandler, TagByDublinCoreTermWOH, VideoEditorWorkflowOperationHandler

public class ResumableWorkflowOperationHandlerBase
extends AbstractWorkflowOperationHandler
implements ResumableWorkflowOperationHandler

Abstract base implementation for a resumable operation handler, which implements a simple operations for starting an operation, returning a WorkflowOperationResult with the current mediapackage and WorkflowOperationResult.Action.PAUSE and resuming an operation, returning a WorkflowOperationResult with the current mediapackage and WorkflowOperationResult.Action.CONTINUE.

Nested Class Summary

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

AbstractWorkflowOperationHandler.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected org.osgi.service.component.ComponentContext	componentContext	OSGi component context, obtained during component activation
protected String	holdActionTitle	Title of this hold state
protected StaticResource	staticResource	The static resource representing the hold state ui
protected org.osgi.framework.ServiceRegistration	staticResourceRegistration	Reference to the static resource 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
ResumableWorkflowOperationHandlerBase()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext componentContext)	Activates this component with its properties once all of the collaborating services have been set
void	deactivate()	Callback from the OSGi environment on component shutdown.
String	getHoldActionTitle()	Returns the title for the link to this operations hold state UI.
String	getHoldStateUserInterfaceURL(WorkflowInstance workflowInstance)	Gets the URL for the user interface for resuming the workflow.
boolean	isAlwaysPause()	Whether this operation handler will always pause.
protected String	registerHoldStateUserInterface(String resourcePath)	Registers the resource identified by resourcePath as the ui to be displayed during hold.
WorkflowOperationResult	resume(WorkflowInstance workflowInstance, JobContext context, Map<String,String> properties)	Continues a suspended WorkflowInstance.
protected void	setHoldActionTitle(String title)	Sets the title that is displayed on the hold state ui.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

applyTargetTagsToElement, asList, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.workflow.api.WorkflowOperationHandler

destroy, getDescription, getId, skip

Field Details

componentContext

protected org.osgi.service.component.ComponentContext componentContext

OSGi component context, obtained during component activation

staticResourceRegistration

protected org.osgi.framework.ServiceRegistration staticResourceRegistration

Reference to the static resource service

staticResource

protected StaticResource staticResource

The static resource representing the hold state ui

holdActionTitle

protected String holdActionTitle

Title of this hold state

Constructor Details

ResumableWorkflowOperationHandlerBase

public ResumableWorkflowOperationHandlerBase()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext componentContext)

Activates this component with its properties once all of the collaborating services have been set

Overrides:

activate in class AbstractWorkflowOperationHandler

Parameters:

componentContext - The component's context, containing the properties used for configuration

See Also:

• AbstractWorkflowOperationHandler.activate(org.osgi.service.component.ComponentContext)

deactivate

public void deactivate()

Callback from the OSGi environment on component shutdown. Make sure to call this super implementation when overwriting this class.

getHoldStateUserInterfaceURL

public String getHoldStateUserInterfaceURL(WorkflowInstance workflowInstance)
                                    throws WorkflowOperationException

Gets the URL for the user interface for resuming the workflow.

Specified by:

getHoldStateUserInterfaceURL in interface ResumableWorkflowOperationHandler

Parameters:

workflowInstance - The workflow instance

Returns:

The URL for the user interface

Throws:

WorkflowOperationException - If the url to the hold state ui can't be created

See Also:

• ResumableWorkflowOperationHandler.getHoldStateUserInterfaceURL(org.opencastproject.workflow.api.WorkflowInstance)

setHoldActionTitle

protected void setHoldActionTitle(String title)

Sets the title that is displayed on the hold state ui.

Parameters:

title - the title

getHoldActionTitle

public String getHoldActionTitle()

Returns the title for the link to this operations hold state UI.

Specified by:

getHoldActionTitle in interface ResumableWorkflowOperationHandler

Returns:

title to be displayed

See Also:

• ResumableWorkflowOperationHandler.getHoldActionTitle()

registerHoldStateUserInterface

protected String registerHoldStateUserInterface(String resourcePath)

Registers the resource identified by resourcePath as the ui to be displayed during hold.

Parameters:

resourcePath - the path to the resource

Returns:

the URL that was created when registering the resource

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. This default implementation will put the workflow into the hold state.

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:

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

resume

public WorkflowOperationResult resume(WorkflowInstance workflowInstance,
 JobContext context,
 Map<String,String> properties)
                               throws WorkflowOperationException

Continues a suspended 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. If the workflow instance is not in a suspended state, this method should throw an IllegalStateException.

Specified by:

resume in interface ResumableWorkflowOperationHandler

Parameters:

workflowInstance - The workflow instance

context - the job context

properties - The properties added while the operation was on hold

Returns:

the result of this operation

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly.

See Also:

• ResumableWorkflowOperationHandler.resume(org.opencastproject.workflow.api.WorkflowInstance, JobContext, java.util.Map)

isAlwaysPause

public boolean isAlwaysPause()

Description copied from interface: ResumableWorkflowOperationHandler

Whether this operation handler will always pause. The workflow service may give preferential dispatching to operations that are guaranteed to pause.

Specified by:

isAlwaysPause in interface ResumableWorkflowOperationHandler

Returns:

whether this handler always pauses