Package org.opencastproject.workflow.handler.distribution

Class PublishEngageWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.distribution.PublishEngageWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

PublishEngageAWSS3WorkflowOperationHandler

public class PublishEngageWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

The workflow definition for handling "engage publication" 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
PublishEngageWorkflowOperationHandler()

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 MediaPackage	getMediaPackageForSearchIndex(MediaPackage current, List<Job> jobs, MediaPackageElementFlavor downloadSubflavor, String[] downloadTargetTags, Set<String> downloadElementIds, MediaPackageElementFlavor streamingSubflavor, Set<String> streamingElementIds, String[] streamingTargetTags)	Returns a mediapackage that only contains elements that are marked for distribution.
protected MediaPackage	mergePackages(MediaPackage updatedMp, MediaPackage publishedMp, List<MediaPackageElementFlavor> mergeForceFlavors, List<MediaPackageElementFlavor> addForceFlavors)	MH-10216, Copied from the original RepublishWorkflowOperationHandler Merges the updated mediapackage with the one that is currently published in a way where the updated elements replace existing ones in the published mediapackage based on their flavor.
protected void	setDownloadDistributionService(DownloadDistributionService downloadDistributionService)	Callback for the OSGi declarative services configuration.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
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.
void	setWorkspace(Workspace workspace)
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

PublishEngageWorkflowOperationHandler

public PublishEngageWorkflowOperationHandler()

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

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

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

setWorkspace

public void setWorkspace(Workspace workspace)

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

start

public WorkflowOperationResult start(WorkflowInstance workflowInstance,
 JobContext context)
                              throws WorkflowOperationException

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.

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)

getMediaPackageForSearchIndex

protected MediaPackage getMediaPackageForSearchIndex(MediaPackage current,
 List<Job> jobs,
 MediaPackageElementFlavor downloadSubflavor,
 String[] downloadTargetTags,
 Set<String> downloadElementIds,
 MediaPackageElementFlavor streamingSubflavor,
 Set<String> streamingElementIds,
 String[] streamingTargetTags)
                                              throws MediaPackageException,
NotFoundException,
ServiceRegistryException,
WorkflowOperationException

Returns a mediapackage that only contains elements that are marked for distribution.

Parameters:

current - the current mediapackage

jobs - the distribution jobs

downloadSubflavor - flavor to be applied to elements distributed to download

downloadTargetTags - tags to be applied to elements distributed to downloads

downloadElementIds - identifiers for elements that have been distributed to downloads

streamingSubflavor - flavor to be applied to elements distributed to streaming

streamingElementIds - identifiers for elements that have been distributed to streaming

streamingTargetTags - tags to be applied to elements distributed to streaming

Returns:

the new mediapackage

Throws:

MediaPackageException

NotFoundException

ServiceRegistryException

WorkflowOperationException

mergePackages

protected MediaPackage mergePackages(MediaPackage updatedMp,
 MediaPackage publishedMp,
 List<MediaPackageElementFlavor> mergeForceFlavors,
 List<MediaPackageElementFlavor> addForceFlavors)

MH-10216, Copied from the original RepublishWorkflowOperationHandler Merges the updated mediapackage with the one that is currently published in a way where the updated elements replace existing ones in the published mediapackage based on their flavor.

If publishedMp is null, this method returns the updated mediapackage without any modifications.

Parameters:

updatedMp - the updated media package

publishedMp - the mediapackage that is currently published

Returns:

the merged mediapackage