Package org.opencastproject.workflow.handler.composer

Class ImageWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class ImageWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

The workflow definition for handling "image" operations

Nested Class Summary

Nested classes/interfaces inherited from class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

AbstractWorkflowOperationHandler.Configuration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPT_END_MARGIN
static final String	OPT_POSITIONS
static final String	OPT_PROFILES
static final String	OPT_TARGET_BASE_NAME_FORMAT_PERCENT
static final String	OPT_TARGET_BASE_NAME_FORMAT_SECOND
static final double	SINGLE_FRAME_POS

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

Method Summary

Modifier and Type	Method	Description
protected void	adjustMetadata(org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Extraction extraction, Attachment image, org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)	Adjust flavor, tags, mime type of image according to the configuration and the extraction.
protected String	createFileName(String suffix, URI trackUri, org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.MediaPosition pos, org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)	Create a file name for the extracted image.
protected Job	extractImages(ImageWorkflowOperationHandler handler, Track track, EncodingProfile profile, List<org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.MediaPosition> positions, org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)	Start a composer job to extract images from a track at the given positions.
static EncodingProfile	fetchProfile(ComposerService composerService, String profileName)	Fetch a profile from the composer service.
protected void	moveToWorkspace(ImageWorkflowOperationHandler handler, MediaPackage mp, Attachment image, String fileName)	Move the extracted image to its final location in the workspace and rename it to fileName.
protected void	setComposerService(ComposerService composerService)	Callback for the OSGi declarative services configuration.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
void	setWorkspace(Workspace workspace)	Callback for declarative services configuration that will introduce us to the local workspace service.
WorkflowOperationResult	start(WorkflowInstance wi, JobContext ctx)	Runs the workflow operation on this WorkflowInstance.

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

OPT_PROFILES

public static final String OPT_PROFILES

See Also:

• Constant Field Values

OPT_POSITIONS

public static final String OPT_POSITIONS

See Also:

• Constant Field Values

OPT_TARGET_BASE_NAME_FORMAT_SECOND

public static final String OPT_TARGET_BASE_NAME_FORMAT_SECOND

See Also:

• Constant Field Values

OPT_TARGET_BASE_NAME_FORMAT_PERCENT

public static final String OPT_TARGET_BASE_NAME_FORMAT_PERCENT

See Also:

• Constant Field Values

OPT_END_MARGIN

public static final String OPT_END_MARGIN

See Also:

• Constant Field Values

SINGLE_FRAME_POS

public static final double SINGLE_FRAME_POS

See Also:

• Constant Field Values

Constructor Details

ImageWorkflowOperationHandler

public ImageWorkflowOperationHandler()

Method Details

setComposerService

protected void setComposerService(ComposerService composerService)

Callback for the OSGi declarative services configuration.

Parameters:

composerService - the composer service

setWorkspace

public void setWorkspace(Workspace workspace)

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

Parameters:

workspace - an instance of the workspace

start

public WorkflowOperationResult start(WorkflowInstance wi,
 JobContext ctx)
                              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:

wi - the workflow instance

ctx - 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)

adjustMetadata

protected void adjustMetadata(org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Extraction extraction,
 Attachment image,
 org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)

Adjust flavor, tags, mime type of image according to the configuration and the extraction.

createFileName

protected String createFileName(String suffix,
 URI trackUri,
 org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.MediaPosition pos,
 org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)
                         throws WorkflowOperationException

Create a file name for the extracted image.

Throws:

WorkflowOperationException

moveToWorkspace

protected void moveToWorkspace(ImageWorkflowOperationHandler handler,
 MediaPackage mp,
 Attachment image,
 String fileName)
                        throws WorkflowOperationException

Move the extracted image to its final location in the workspace and rename it to fileName.

Throws:

WorkflowOperationException

extractImages

protected Job extractImages(ImageWorkflowOperationHandler handler,
 Track track,
 EncodingProfile profile,
 List<org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.MediaPosition> positions,
 org.opencastproject.workflow.handler.composer.ImageWorkflowOperationHandler.Cfg cfg)
                     throws WorkflowOperationException

Start a composer job to extract images from a track at the given positions.

Throws:

WorkflowOperationException

fetchProfile

public static EncodingProfile fetchProfile(ComposerService composerService,
 String profileName)
                                    throws WorkflowOperationException

Fetch a profile from the composer service. Throw a WorkflowOperationException in case the profile does not exist.

Throws:

WorkflowOperationException

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