Package org.opencastproject.workflow.api

Class AbstractWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

AddCatalogWorkflowOperationHandler, AmberscriptAttachTranscriptionOperationHandler, AmberscriptStartTranscriptionOperationHandler, AnalyzeMediapackageWorkflowOperationHandler, AnalyzeTracksWorkflowOperationHandler, AssertWorkflowOperationHandler, AssetManagerDeleteWorkflowOperationHandler, AssetManagerSnapshotWorkflowOperationHandler, AssetManagerStorageMoveOperationHandler, AttachTranscriptionOperationHandler, ChangeTypeWorkflowOperationHandler, CleanupWorkflowOperationHandler, CloneWorkflowOperationHandler, CommentWorkflowOperationHandler, CompositeWorkflowOperationHandler, ConcatWorkflowOperationHandler, ConditionalConfigWorkflowOperationHandler, ConfigurableWorkflowOperationHandlerBase, CopyWorkflowOperationHandler, CoverImageWorkflowOperationHandlerBase, CropWorkflowOperationHandler, CutMarksToSmilWorkflowOperationHandler, DefaultsWorkflowOperationHandler, DemuxWorkflowOperationHandler, DuplicateEventWorkflowOperationHandler, EmailWorkflowOperationHandler, EncodeWorkflowOperationHandler, ExecuteManyWorkflowOperationHandler, ExecuteOnceWorkflowOperationHandler, ExportWorkflowPropertiesWOH, GoogleSpeechAttachTranscriptionOperationHandler, GoogleSpeechStartTranscriptionOperationHandler, HelloWorldWorkflowOperationHandler, HttpNotificationWorkflowOperationHandler, ImageConvertWorkflowOperationHandler, ImageToVideoWorkflowOperationHandler, ImageWorkflowOperationHandler, ImportWorkflowPropertiesWOH, IncidentCreatorWorkflowOperationHandler, IncludeWorkflowOperationHandler, IngestDownloadWorkflowOperationHandler, InspectWorkflowOperationHandler, LoggingWorkflowOperationHandler, MattermostNotificationWorkflowOperationHandler, MediaPackagePostOperationHandler, MetadataToAclWorkflowOperationHandler, MicrosoftAzureAttachTranscriptionOperationHandler, MicrosoftAzureStartTranscriptionOperationHandler, MultiEncodeWorkflowOperationHandler, MuxWorkflowOperationHandler, PartialImportWorkflowOperationHandler, PrepareAVWorkflowOperationHandler, ProbeResolutionWorkflowOperationHandler, ProcessSmilWorkflowOperationHandler, PublicationChannelToWorkspace, PublishEngageWorkflowOperationHandler, PublishOaiPmhWorkflowOperationHandler, PublishYouTubeWorkflowOperationHandler, RenameFilesWorkflowOperationHandler, RepublishOaiPmhWorkflowOperationHandler, ResumableWorkflowOperationHandlerBase, RetractEngageWorkflowOperationHandler, RetractOaiPmhWorkflowOperationHandler, RetractYouTubeWorkflowOperationHandler, SanitizeAdaptiveWorkflowOperationHandler, SegmentPreviewsWorkflowOperationHandler, SelectStreamsWorkflowOperationHandler, SelectVersionWorkflowOperationHandler, SeriesWorkflowOperationHandler, SilenceDetectionWorkflowOperationHandler, SpeechToTextAttachWorkflowOperationHandler, SpeechToTextWorkflowOperationHandler, StartTranscriptionOperationHandler, StartWorkflowWorkflowOperationHandler, StatisticsWriterWorkflowOperationHandler, SubtitleTimeshiftWorkflowOperationHandler, TagEngageWorkflowOperationHandler, TagWorkflowOperationHandler, TextAnalysisWorkflowOperationHandler, ThemeWorkflowOperationHandler, TimelinePreviewsWorkflowOperationHandler, TransferMetadataWorkflowOperationHandler, VideoGridWorkflowOperationHandler, VideoSegmenterWorkflowOperationHandler, WaveformWorkflowOperationHandler, WebvttToCutMarksWorkflowOperationHandler, ZipWorkflowOperationHandler

public abstract class AbstractWorkflowOperationHandler
extends Object
implements WorkflowOperationHandler

Abstract base implementation for an operation handler, which implements a simple start operation that returns a WorkflowOperationResult with the current mediapackage and WorkflowOperationResult.Action.CONTINUE.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractWorkflowOperationHandler.Configuration	Config for Tag Parsing operation

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	The description of what this handler actually does
protected String	id	The ID of this operation handler
protected ServiceRegistry	serviceRegistry	Optional service registry
static final String	SOURCE_FLAVOR
static final String	SOURCE_FLAVORS
static final String	SOURCE_TAG
static final String	SOURCE_TAGS
static final String	TARGET_FLAVOR
static final String	TARGET_FLAVORS
static final String	TARGET_TAG
static final String	TARGET_TAGS

Constructor Summary

Constructors

Constructor	Description
AbstractWorkflowOperationHandler()

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 <T extends MediaPackageElement> T	applyTargetTagsToElement(ConfiguredTagsAndFlavors.TargetTags targetTags, T element)	Helper function that applies target tags to the given element, based on the type(s) of the tag(s)
protected List<String>	asList(String elements)	Converts a comma separated string into a set of values.
protected WorkflowOperationResult	createResult(MediaPackage mediaPackage, Map<String,String> properties, WorkflowOperationResult.Action action, long timeInQueue)	Creates a result for the execution of this workflow operation handler.
protected WorkflowOperationResult	createResult(MediaPackage mediaPackage, WorkflowOperationResult.Action action)	Creates a result for the execution of this workflow operation handler.
protected WorkflowOperationResult	createResult(MediaPackage mediaPackage, WorkflowOperationResult.Action action, long timeInQueue)	Creates a result for the execution of this workflow operation handler.
protected WorkflowOperationResult	createResult(WorkflowOperationResult.Action action)	Creates a result for the execution of this workflow operation handler.
void	destroy(WorkflowInstance workflowInstance, JobContext context)	Clean up after a workflow operation finishes
boolean	equals(Object obj)
protected Optional<String>	getCfg(WorkflowInstance wi, String key)	Deprecated. use getConfig(WorkflowInstance, String) or getOptConfig(org.opencastproject.workflow.api.WorkflowInstance, String)
protected String	getConfig(WorkflowInstance wi, String key)	Get a mandatory configuration key.
protected String	getConfig(WorkflowInstance w, String key, String defaultValue)	Get a configuration key.
protected String	getConfig(WorkflowOperationInstance woi, String key)	Get a mandatory configuration key.
String	getDescription()	Returns a description of what this handler does.
protected String	getFileNameFromElements(MediaPackageElement source, MediaPackageElement derived)	Generates a filename using the base name of a source element and the extension of a derived element.
String	getId()	The identifier used to map a workflow operation to its handler
protected Optional<String>	getOptConfig(WorkflowInstance wi, String key)	Get an optional configuration key.
protected Optional<String>	getOptConfig(WorkflowOperationInstance woi, String key)	Get an optional configuration key.
protected ConfiguredTagsAndFlavors	getTagsAndFlavors(WorkflowInstance workflow, AbstractWorkflowOperationHandler.Configuration srcTags, AbstractWorkflowOperationHandler.Configuration srcFlavors, AbstractWorkflowOperationHandler.Configuration targetTags, AbstractWorkflowOperationHandler.Configuration targetFlavors)	Returns a ConfiguredTagsAndFlavors instance, which includes all specified source/target tags and flavors if they are valid Lists can be empty, if no values were specified!
int	hashCode()
void	setJobBarrierPollingInterval(long interval)	Set the @link org.opencastproject.job.api.JobBarrier polling interval.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
WorkflowOperationResult	skip(WorkflowInstance workflowInstance, JobContext context)	Skips the workflow operation on this WorkflowInstance.
abstract WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.
String	toString()
protected JobBarrier.Result	waitForStatus(long timeout, Job... jobs)	Waits until all of the jobs have reached either one of these statuses: Job.Status.FINISHED Job.Status.FAILED Job.Status.DELETED After that, the method returns with the actual outcomes of the jobs.
protected JobBarrier.Result	waitForStatus(Job... jobs)	Waits until all of the jobs have reached either one of these statuses: Job.Status.FINISHED Job.Status.FAILED Job.Status.DELETED After that, the method returns with the actual outcomes of the jobs.

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

The ID of this operation handler

description

protected String description

The description of what this handler actually does

serviceRegistry

protected ServiceRegistry serviceRegistry

Optional service registry

TARGET_FLAVORS

public static final String TARGET_FLAVORS

See Also:

• Constant Field Values

TARGET_FLAVOR

public static final String TARGET_FLAVOR

See Also:

• Constant Field Values

TARGET_TAGS

public static final String TARGET_TAGS

See Also:

• Constant Field Values

TARGET_TAG

public static final String TARGET_TAG

See Also:

• Constant Field Values

SOURCE_FLAVORS

public static final String SOURCE_FLAVORS

See Also:

• Constant Field Values

SOURCE_FLAVOR

public static final String SOURCE_FLAVOR

See Also:

• Constant Field Values

SOURCE_TAG

public static final String SOURCE_TAG

See Also:

• Constant Field Values

SOURCE_TAGS

public static final String SOURCE_TAGS

See Also:

• Constant Field Values

Constructor Details

AbstractWorkflowOperationHandler

public AbstractWorkflowOperationHandler()

Method Details

activate

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

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

Parameters:

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

start

public abstract 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

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)

skip

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

Skips 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:

skip in interface WorkflowOperationHandler

Parameters:

workflowInstance - the workflow instance

context - the job context

Returns:

TODO

Throws:

WorkflowOperationException - If the workflow operation fails to execute properly, and the default error handling should be invoked.

See Also:

• WorkflowOperationHandler.skip(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

destroy

public void destroy(WorkflowInstance workflowInstance,
 JobContext context)
             throws WorkflowOperationException

Clean up after a workflow operation finishes

Specified by:

destroy in interface WorkflowOperationHandler

Parameters:

workflowInstance - The workflow instance

context - the job context

Throws:

WorkflowOperationException - If the workflow operation fails to clean up properly.

See Also:

• WorkflowOperationHandler.destroy(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

asList

protected List<String> asList(String elements)

Converts a comma separated string into a set of values. Useful for converting operation configuration strings into multi-valued sets.

Parameters:

elements - The comma space separated string

Returns:

the set of values

getFileNameFromElements

protected String getFileNameFromElements(MediaPackageElement source,
 MediaPackageElement derived)

Generates a filename using the base name of a source element and the extension of a derived element.

Parameters:

source - the source media package element

derived - the derived media package element

Returns:

the filename

getId

public String getId()

The identifier used to map a workflow operation to its handler

Specified by:

getId in interface WorkflowOperationHandler

Returns:

This handler's identifier

See Also:

• WorkflowOperationHandler.getId()

getDescription

public String getDescription()

Returns a description of what this handler does.

Specified by:

getDescription in interface WorkflowOperationHandler

Returns:

The handler's description

See Also:

• WorkflowOperationHandler.getDescription()

createResult

protected WorkflowOperationResult createResult(WorkflowOperationResult.Action action)

Creates a result for the execution of this workflow operation handler.

Parameters:

action - the action to take

Returns:

the result

createResult

protected WorkflowOperationResult createResult(MediaPackage mediaPackage,
 WorkflowOperationResult.Action action)

Creates a result for the execution of this workflow operation handler.

Parameters:

mediaPackage - the modified mediapackage

action - the action to take

Returns:

the result

createResult

protected WorkflowOperationResult createResult(MediaPackage mediaPackage,
 WorkflowOperationResult.Action action,
 long timeInQueue)

Creates a result for the execution of this workflow operation handler.

Since there is no way for the workflow service to determine the queuing time (e. g. waiting on services), it needs to be provided by the handler.

Parameters:

mediaPackage - the modified mediapackage

action - the action to take

timeInQueue - the amount of time this handle spent waiting for services

Returns:

the result

createResult

protected WorkflowOperationResult createResult(MediaPackage mediaPackage,
 Map<String,String> properties,
 WorkflowOperationResult.Action action,
 long timeInQueue)

Creates a result for the execution of this workflow operation handler.

Since there is no way for the workflow service to determine the queuing time (e. g. waiting on services), it needs to be provided by the handler.

Parameters:

mediaPackage - the modified mediapackage

properties - the properties to add to the workflow instance

action - the action to take

timeInQueue - the amount of time this handle spent waiting for services

Returns:

the result

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the service registry. This method is here as a convenience for developers that need the registry to do job waiting.

Parameters:

serviceRegistry - the service registry

waitForStatus

protected JobBarrier.Result waitForStatus(Job... jobs)
                                   throws IllegalStateException,
IllegalArgumentException

Waits until all of the jobs have reached either one of these statuses:

• Job.Status.FINISHED
• Job.Status.FAILED
• Job.Status.DELETED

After that, the method returns with the actual outcomes of the jobs.

Parameters:

jobs - the jobs

Returns:

the jobs and their outcomes

Throws:

IllegalStateException - if the service registry has not been set

IllegalArgumentException - if the jobs collecion is either null or empty

waitForStatus

protected JobBarrier.Result waitForStatus(long timeout,
 Job... jobs)
                                   throws IllegalStateException,
IllegalArgumentException

Waits until all of the jobs have reached either one of these statuses:

• Job.Status.FINISHED
• Job.Status.FAILED
• Job.Status.DELETED

After that, the method returns with the actual outcomes of the jobs.

Parameters:

timeout - the maximum amount of time in milliseconds to wait

jobs - the jobs

Returns:

the jobs and their outcomes

Throws:

IllegalStateException - if the service registry has not been set

IllegalArgumentException - if the jobs collection is either null or empty

getCfg

protected Optional<String> getCfg(WorkflowInstance wi,
 String key)

Deprecated.

use getConfig(WorkflowInstance, String) or getOptConfig(org.opencastproject.workflow.api.WorkflowInstance, String)

Get a configuration option.

getConfig

protected String getConfig(WorkflowInstance wi,
 String key)
                    throws WorkflowOperationException

Get a mandatory configuration key. Values are returned trimmed.

Throws:

WorkflowOperationException - if the configuration key is either missing or empty

getConfig

protected String getConfig(WorkflowInstance w,
 String key,
 String defaultValue)

Get a configuration key. Values are returned trimmed.

Parameters:

w - WorkflowInstance with current operation

key - Configuration key to check for

defaultValue - Value to return if key does not exists

getConfig

protected String getConfig(WorkflowOperationInstance woi,
 String key)
                    throws WorkflowOperationException

Get a mandatory configuration key. Values are returned trimmed.

Throws:

WorkflowOperationException - if the configuration key is either missing or empty

getOptConfig

protected Optional<String> getOptConfig(WorkflowInstance wi,
 String key)

Get an optional configuration key. Values are returned trimmed.

getOptConfig

protected Optional<String> getOptConfig(WorkflowOperationInstance woi,
 String key)

Get an optional configuration key. Values are returned trimmed.

getTagsAndFlavors

protected ConfiguredTagsAndFlavors getTagsAndFlavors(WorkflowInstance workflow,
 AbstractWorkflowOperationHandler.Configuration srcTags,
 AbstractWorkflowOperationHandler.Configuration srcFlavors,
 AbstractWorkflowOperationHandler.Configuration targetTags,
 AbstractWorkflowOperationHandler.Configuration targetFlavors)
                                              throws WorkflowOperationException

Returns a ConfiguredTagsAndFlavors instance, which includes all specified source/target tags and flavors if they are valid Lists can be empty, if no values were specified! This is to enable WOHs to individually check if a given tag/flavor was set. This also means that you should use Configuration.many as parameter, if a tag/flavor is optional.

Parameters:

srcTags - none, one or many

srcFlavors - none, one or many

targetTags - none, one or many

targetFlavors - none, one or many

Returns:

ConfiguredTagsAndFlavors object including lists for the configured tags/flavors

Throws:

WorkflowOperationException

applyTargetTagsToElement

protected <T extends MediaPackageElement> T applyTargetTagsToElement(ConfiguredTagsAndFlavors.TargetTags targetTags,
 T element)

Helper function that applies target tags to the given element, based on the type(s) of the tag(s)

Parameters:

targetTags - The target tags to apply to the element

element - The element the target tags are applied to

Returns:

The element with the applied target tags

setJobBarrierPollingInterval

public void setJobBarrierPollingInterval(long interval)

Set the @link org.opencastproject.job.api.JobBarrier polling interval.

While waiting for other jobs to finish, the barrier will poll the status of these jobs until they are finished. To reduce load on the system, the polling is done only every x milliseconds. This interval defines the sleep time between these polls.

If most cases you want to leave this at its default value. It will make sense, though, to adjust this time if you know that your job will be exceptionally short. An example of this might be the unit tests where other jobs are usually mocked. But this setting is not limited to tests and may be a sensible options for other jobs as well.

Parameters:

interval - the time in miliseconds between two polling operations

See Also:

• JobBarrier.DEFAULT_POLLING_INTERVAL

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()