Package org.opencastproject.workflow.handler.distribution

Class PartialRetractEngageWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.distribution.RetractEngageWorkflowOperationHandler

org.opencastproject.workflow.handler.distribution.PartialRetractEngageWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

PartialRetractEngageAWSS3WorkflowOperationHandler

public class PartialRetractEngageWorkflowOperationHandler
extends RetractEngageWorkflowOperationHandler

Workflow operation for retracting parts of a media package from the engage player.

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.handler.distribution.RetractEngageWorkflowOperationHandler

downloadDistributionService, searchService, streamingDistributionService

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

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
void	setDownloadDistributionService(DownloadDistributionService downloadDistributionService)	Callback for the OSGi declarative services configuration.
void	setSearchService(SearchService searchService)	Callback for declarative services configuration that will introduce us to the search service.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
void	setStreamingDistributionService(StreamingDistributionService streamingDistributionService)	Callback for the OSGi declarative services configuration.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

Methods inherited from class org.opencastproject.workflow.handler.distribution.RetractEngageWorkflowOperationHandler

retractElements

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

PartialRetractEngageWorkflowOperationHandler

public PartialRetractEngageWorkflowOperationHandler()

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 RetractEngageWorkflowOperationHandler

Parameters:

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

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

Overrides:

start in class RetractEngageWorkflowOperationHandler

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(WorkflowInstance, JobContext)

setDownloadDistributionService

public void setDownloadDistributionService(DownloadDistributionService downloadDistributionService)

Description copied from class: RetractEngageWorkflowOperationHandler

Callback for the OSGi declarative services configuration.

Overrides:

setDownloadDistributionService in class RetractEngageWorkflowOperationHandler

Parameters:

downloadDistributionService - the download distribution service

setSearchService

public void setSearchService(SearchService searchService)

Description copied from class: RetractEngageWorkflowOperationHandler

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

Overrides:

setSearchService in class RetractEngageWorkflowOperationHandler

Parameters:

searchService - an instance of the search 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 RetractEngageWorkflowOperationHandler

Parameters:

serviceRegistry - the service registry

setStreamingDistributionService

public void setStreamingDistributionService(StreamingDistributionService streamingDistributionService)

Description copied from class: RetractEngageWorkflowOperationHandler

Callback for the OSGi declarative services configuration.

Overrides:

setStreamingDistributionService in class RetractEngageWorkflowOperationHandler

Parameters:

streamingDistributionService - the streaming distribution service