Package org.opencastproject.workflow.handler.distribution

Class RetractEngageWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.distribution.RetractEngageWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

PartialRetractEngageWorkflowOperationHandler, RetractEngageAWSS3WorkflowOperationHandler

public class RetractEngageWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

Workflow operation for retracting 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

Modifier and Type	Field	Description
protected DownloadDistributionService	downloadDistributionService	The download distribution service
protected SearchService	searchService	The search service
protected StreamingDistributionService	streamingDistributionService	The streaming distribution service

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

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext cc)	Activates this component with its properties once all of the collaborating services have been set
protected List<Job>	retractElements(Set<String> retractElementIds, MediaPackage searchMediaPackage)	Generate the jobs retracted the selected elements
protected void	setDownloadDistributionService(DownloadDistributionService downloadDistributionService)	Callback for the OSGi declarative services configuration.
protected 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.
protected 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.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

Field Details

streamingDistributionService

protected StreamingDistributionService streamingDistributionService

The streaming distribution service

downloadDistributionService

protected DownloadDistributionService downloadDistributionService

The download distribution service

searchService

protected SearchService searchService

The search service

Constructor Details

RetractEngageWorkflowOperationHandler

public RetractEngageWorkflowOperationHandler()

Method Details

setStreamingDistributionService

protected void setStreamingDistributionService(StreamingDistributionService streamingDistributionService)

Callback for the OSGi declarative services configuration.

Parameters:

streamingDistributionService - the streaming distribution service

setDownloadDistributionService

protected void setDownloadDistributionService(DownloadDistributionService downloadDistributionService)

Callback for the OSGi declarative services configuration.

Parameters:

downloadDistributionService - the download distribution service

setSearchService

protected void setSearchService(SearchService searchService)

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

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 AbstractWorkflowOperationHandler

Parameters:

serviceRegistry - the service registry

activate

protected 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

retractElements

protected List<Job> retractElements(Set<String> retractElementIds,
 MediaPackage searchMediaPackage)
                             throws DistributionException

Generate the jobs retracted the selected elements

Parameters:

retractElementIds - The list of element ids to retract

searchMediaPackage - The mediapackage from the search service

Returns:

Throws:

DistributionException

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