Package org.opencastproject.workflow.handler.inspection

Class InspectWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.inspection.InspectWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class InspectWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

Workflow operation used to inspect all tracks of a media package.

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

description, id, serviceRegistry, SOURCE_FLAVOR, SOURCE_FLAVORS, SOURCE_TAG, SOURCE_TAGS, TARGET_FLAVOR, TARGET_FLAVORS, TARGET_TAG, TARGET_TAGS

Constructor Summary

Constructors

Constructor	Description
InspectWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
protected DublinCoreCatalog	loadDublinCoreCatalog(Catalog catalog)	Loads a dublin core catalog from a mediapackage's catalog reference
void	setDublincoreService(DublinCoreCatalogService dcService)
protected void	setInspectionService(MediaInspectionService inspectionService)	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 workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.
protected void	updateDublinCore(MediaPackage mediaPackage)	Updates those dublin core fields that can be gathered from the technical metadata.

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

Constructor Details

InspectWorkflowOperationHandler

public InspectWorkflowOperationHandler()

Method Details

setDublincoreService

public void setDublincoreService(DublinCoreCatalogService dcService)

setInspectionService

protected void setInspectionService(MediaInspectionService inspectionService)

Callback for the OSGi declarative services configuration.

Parameters:

inspectionService - the inspection 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 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

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)

updateDublinCore

protected void updateDublinCore(MediaPackage mediaPackage)
                         throws Exception

Updates those dublin core fields that can be gathered from the technical metadata.

Parameters:

mediaPackage - the media package

Throws:

Exception

loadDublinCoreCatalog

protected DublinCoreCatalog loadDublinCoreCatalog(Catalog catalog)
                                           throws IOException

Loads a dublin core catalog from a mediapackage's catalog reference

Parameters:

catalog - the mediapackage's reference to this catalog

Returns:

the dublin core

Throws:

IOException - if there is a problem loading or parsing the dublin core object

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