Package org.opencastproject.workflow.handler.distribution

Class ConfigurablePublishWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.distribution.ConfigurableWorkflowOperationHandlerBase

org.opencastproject.workflow.handler.distribution.ConfigurablePublishWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

ConfigurableAWSS3PublishWorkflowOperationHandler

public class ConfigurablePublishWorkflowOperationHandler
extends ConfigurableWorkflowOperationHandlerBase

WOH that distributes selected elements to an internal distribution channel and adds reflective publication elements to the media package.

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 static final String	EVENT_ID_TEMPLATE_KEY	The template key for adding the mediapackage / event id to the publication path.
protected static final String	ORG_TEMPLATE_KEY_PREFIX	The template key name prefix for organization keys
protected static final String	PLAYER_PATH_TEMPLATE_KEY	The template key for adding the player location path to the publication path.
protected static final String	PLAYER_PROPERTY	The configuration property value for the player location.
protected static final String	PUBLICATION_ID_TEMPLATE_KEY	The template key for adding the publication id to the publication path.
protected static final String	SERIES_ID_TEMPLATE_KEY	The template key for adding the series id to the publication path.

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

Method Summary

Modifier and Type	Method	Description
protected DownloadDistributionService	getDownloadDistributionService()
protected StreamingDistributionService	getStreamingDistributionService()
URI	populateUrlWithVariables(String urlPattern, MediaPackage mp, String pubUUID)	Replace possible variables in the url-pattern configuration for this workflow operation handler.
protected void	setSecurityService(SecurityService securityService)	OSGi DI
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

getPublications, retract

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

activate, applyTargetTagsToElement, asList, 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

EVENT_ID_TEMPLATE_KEY

protected static final String EVENT_ID_TEMPLATE_KEY

The template key for adding the mediapackage / event id to the publication path.

See Also:

• Constant Field Values

PLAYER_PATH_TEMPLATE_KEY

protected static final String PLAYER_PATH_TEMPLATE_KEY

The template key for adding the player location path to the publication path.

See Also:

• Constant Field Values

PUBLICATION_ID_TEMPLATE_KEY

protected static final String PUBLICATION_ID_TEMPLATE_KEY

The template key for adding the publication id to the publication path.

See Also:

• Constant Field Values

SERIES_ID_TEMPLATE_KEY

protected static final String SERIES_ID_TEMPLATE_KEY

The template key for adding the series id to the publication path.

See Also:

• Constant Field Values

PLAYER_PROPERTY

protected static final String PLAYER_PROPERTY

The configuration property value for the player location.

See Also:

• Constant Field Values

ORG_TEMPLATE_KEY_PREFIX

protected static final String ORG_TEMPLATE_KEY_PREFIX

The template key name prefix for organization keys

See Also:

• Constant Field Values

Constructor Details

ConfigurablePublishWorkflowOperationHandler

public ConfigurablePublishWorkflowOperationHandler()

Method Details

setSecurityService

protected void setSecurityService(SecurityService securityService)

OSGi DI

getDownloadDistributionService

protected DownloadDistributionService getDownloadDistributionService()

getStreamingDistributionService

protected StreamingDistributionService getStreamingDistributionService()

populateUrlWithVariables

public URI populateUrlWithVariables(String urlPattern,
 MediaPackage mp,
 String pubUUID)
                             throws WorkflowOperationException

Replace possible variables in the url-pattern configuration for this workflow operation handler.

Parameters:

urlPattern - The operation's template for replacing the variables.

mp - The MediaPackage used to get the event / mediapackage id.

pubUUID - The UUID for the published element.

Returns:

The URI of the published element with the variables replaced.

Throws:

WorkflowOperationException - Thrown if the URI is malformed after replacing the variables.

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)

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