Package org.opencastproject.workflow.handler.coverimage

Class CoverImageWorkflowOperationHandlerBase

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.coverimage.CoverImageWorkflowOperationHandlerBase

All Implemented Interfaces:

WorkflowOperationHandler

Direct Known Subclasses:

CoverImageWorkflowOperationHandler

public abstract class CoverImageWorkflowOperationHandlerBase
extends AbstractWorkflowOperationHandler

Base implementation of the cover image workflow operation handler

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

Method Summary

Modifier and Type	Method	Description
protected void	appendXml(StringBuilder xml, String name, String body)
protected abstract CoverImageService	getCoverImageService()	Returns a cover image service
protected abstract DublinCoreCatalogService	getDublinCoreCatalogService()	Returns a dublin core catalog service
protected int	getIntConfiguration(WorkflowOperationInstance operation, String key)
protected abstract String	getKarafEtc()	Returns value of karaf.etc
protected String	getMetadataXml(MediaPackage mp, WorkflowOperationInstance operation)
protected String	getPosterImageFileUrl(String posterimageUrlOpt)
protected String	getPosterImageFileUrl(MediaPackage mediaPackage, String posterimageFlavor)
protected abstract StaticMetadataService	getStaticMetadataService()	Returns a static metadata service
protected String	getValuesAsString(Map.Entry<EName,List<DublinCoreValue>> entry)
protected abstract Workspace	getWorkspace()	Returns a workspace service
protected String	loadXsl(WorkflowOperationInstance operation)
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

activate, asList, cfgKeyMissing, createResult, createResult, createResult, createResult, destroy, equals, getCfg, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, setServiceRegistry, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

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

Constructor Details

CoverImageWorkflowOperationHandlerBase

public CoverImageWorkflowOperationHandlerBase()

Method Details

getCoverImageService

protected abstract CoverImageService getCoverImageService()

Returns a cover image service

getWorkspace

protected abstract Workspace getWorkspace()

Returns a workspace service

getStaticMetadataService

protected abstract StaticMetadataService getStaticMetadataService()

Returns a static metadata service

getDublinCoreCatalogService

protected abstract DublinCoreCatalogService getDublinCoreCatalogService()

Returns a dublin core catalog service

getKarafEtc

protected abstract String getKarafEtc()

Returns value of karaf.etc

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)

getPosterImageFileUrl

protected String getPosterImageFileUrl(MediaPackage mediaPackage,
 String posterimageFlavor)
                                throws WorkflowOperationException

Throws:

WorkflowOperationException

getPosterImageFileUrl

protected String getPosterImageFileUrl(String posterimageUrlOpt)

getIntConfiguration

protected int getIntConfiguration(WorkflowOperationInstance operation,
 String key)
                           throws WorkflowOperationException

Throws:

WorkflowOperationException

loadXsl

protected String loadXsl(WorkflowOperationInstance operation)
                  throws WorkflowOperationException

Throws:

WorkflowOperationException

getMetadataXml

protected String getMetadataXml(MediaPackage mp,
 WorkflowOperationInstance operation)

getValuesAsString

protected String getValuesAsString(Map.Entry<EName,List<DublinCoreValue>> entry)

appendXml

protected void appendXml(StringBuilder xml,
 String name,
 String body)