Package org.opencastproject.workflow.handler.composer

Class ProcessSmilWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.composer.ProcessSmilWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class ProcessSmilWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

The workflow definition for handling "compose" operations

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

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

Constructor Summary

Constructors

Constructor	Description
ProcessSmilWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	Activates this component with its properties once all of the collaborating services have been set
protected void	setComposerService(ComposerService composerService)	Callback for the OSGi declarative services configuration.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
protected void	setSmilService(SmilService smilService)	Callback for the OSGi declarative services configuration.
void	setWorkspace(Workspace workspace)	Callback for declarative services configuration that will introduce us to the local workspace service.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessSmilWorkflowOperationHandler

public ProcessSmilWorkflowOperationHandler()

Method Details

activate

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

Description copied from class: AbstractWorkflowOperationHandler

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

Overrides:

activate in class AbstractWorkflowOperationHandler

Parameters:

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

setComposerService

protected void setComposerService(ComposerService composerService)

Callback for the OSGi declarative services configuration.

Parameters:

composerService - the local composer service

setSmilService

protected void setSmilService(SmilService smilService)

Callback for the OSGi declarative services configuration.

Parameters:

smilService -

setWorkspace

public void setWorkspace(Workspace workspace)

Callback for declarative services configuration that will introduce us to the local workspace service. Implementation assumes that the reference is configured as being static.

Parameters:

workspace - an instance of the workspace

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

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)