Package org.opencastproject.workflow.api

Interface WorkflowOperationHandler

All Known Subinterfaces:

ResumableWorkflowOperationHandler

All Known Implementing Classes:

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

public interface WorkflowOperationHandler

Handler for workflow operations.

Method Summary

Modifier and Type	Method	Description
void	destroy(WorkflowInstance workflowInstance, JobContext context)	Clean up after a workflow operation finishes
String	getDescription()	Returns a description of what this handler does.
String	getId()	The identifier used to map a workflow operation to its handler
WorkflowOperationResult	skip(WorkflowInstance workflowInstance, JobContext context)	Skips the workflow operation on this WorkflowInstance.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

Method Details

getId

String getId()

The identifier used to map a workflow operation to its handler

Returns:

This handler's identifier

getDescription

String getDescription()

Returns a description of what this handler does.

Returns:

The handler's description

start

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.

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.

skip

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.

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.

destroy

void destroy(WorkflowInstance workflowInstance,
 JobContext context)
      throws WorkflowOperationException

Clean up after a workflow operation finishes

Parameters:

workflowInstance - The workflow instance

context - the job context

Throws:

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