Package org.opencastproject.workflow.handler.workflow

Class DuplicateEventWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.workflow.DuplicateEventWorkflowOperationHandler

All Implemented Interfaces:

WorkflowOperationHandler

public class DuplicateEventWorkflowOperationHandler
extends AbstractWorkflowOperationHandler

This WOH duplicates an input event.

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	COPY_NUMBER_PREFIX_PROPERTY	The prefix to use for the number which is appended to the original title of the event.
protected DistributionService	distributionService	The distribution service
static final int	MAX_NUMBER_DEFAULT	The default maximum number of events to create.
static final String	MAX_NUMBER_PROPERTY	Name of the configuration option that provides the maximum number of events to create
static final String	NO_SUFFIX	Whether to actually use the number suffix (makes sense in conjunction with "set-series-id"
static final String	NUMBER_PROPERTY	Name of the configuration option that provides the number of events to create
static final String	PROPERTY_NAMESPACES_PROPERTY	The namespaces of the asset manager properties to copy.
static final String	SET_SERIES_ID	The series ID that should be set on the copies (if unset, uses the same series)
static final String	SET_START_DATE	The new startDate that should be set on the copies (if unset, uses the old startDate)
static final String	SET_TITLE	The new title that should be set on the copies (if unset, uses the old title (copy-number-prefix))
static final String	SOURCE_FLAVORS_PROPERTY	Name of the configuration option that provides the source flavors we are looking for
static final String	SOURCE_TAGS_PROPERTY	Name of the configuration option that provides the source tags we are looking for
static final String	TARGET_TAGS_PROPERTY	Name of the configuration option that provides the target tags we should apply

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, workspace

Constructor Summary

Constructors

Constructor	Description
DuplicateEventWorkflowOperationHandler()

Method Summary

Modifier and Type	Method	Description
void	setAssetManager(AssetManager assetManager)	Callback for the OSGi declarative services configuration.
void	setAuthorizationService(AuthorizationService authorizationService)	OSGi setter
void	setDistributionService(DistributionService distributionService)	Callback for the OSGi declarative services configuration.
void	setSeriesService(SeriesService seriesService)	OSGi setter
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry.
void	setWorkspace(Workspace workspace)	Callback for the OSGi declarative services configuration.
WorkflowOperationResult	start(WorkflowInstance workflowInstance, JobContext context)	Runs the workflow operation on this WorkflowInstance.

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

activate, applyTargetTagsToElement, asList, createDerivedMediaPackageElementFrom, createResult, createResult, createResult, createResult, describeFailedJobs, destroy, equals, getConfig, getConfig, getConfig, getDescription, getFileNameFromElements, getId, getOptConfig, getOptConfig, getTagsAndFlavors, getTagsAndFlavors, hashCode, setJobBarrierPollingInterval, skip, toString, waitForStatus, waitForStatus

Methods inherited from class java.lang.Object

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

Field Details

SOURCE_FLAVORS_PROPERTY

public static final String SOURCE_FLAVORS_PROPERTY

Name of the configuration option that provides the source flavors we are looking for

See Also:

• Constant Field Values

SOURCE_TAGS_PROPERTY

public static final String SOURCE_TAGS_PROPERTY

Name of the configuration option that provides the source tags we are looking for

See Also:

• Constant Field Values

TARGET_TAGS_PROPERTY

public static final String TARGET_TAGS_PROPERTY

Name of the configuration option that provides the target tags we should apply

See Also:

• Constant Field Values

NUMBER_PROPERTY

public static final String NUMBER_PROPERTY

Name of the configuration option that provides the number of events to create

See Also:

• Constant Field Values

MAX_NUMBER_PROPERTY

public static final String MAX_NUMBER_PROPERTY

Name of the configuration option that provides the maximum number of events to create

See Also:

• Constant Field Values

NO_SUFFIX

public static final String NO_SUFFIX

Whether to actually use the number suffix (makes sense in conjunction with "set-series-id"

See Also:

• Constant Field Values

SET_SERIES_ID

public static final String SET_SERIES_ID

The series ID that should be set on the copies (if unset, uses the same series)

See Also:

• Constant Field Values

SET_TITLE

public static final String SET_TITLE

The new title that should be set on the copies (if unset, uses the old title (copy-number-prefix))

See Also:

• Constant Field Values

SET_START_DATE

public static final String SET_START_DATE

The new startDate that should be set on the copies (if unset, uses the old startDate)

See Also:

• Constant Field Values

MAX_NUMBER_DEFAULT

public static final int MAX_NUMBER_DEFAULT

The default maximum number of events to create. Can be overridden.

See Also:

• Constant Field Values

PROPERTY_NAMESPACES_PROPERTY

public static final String PROPERTY_NAMESPACES_PROPERTY

The namespaces of the asset manager properties to copy.

See Also:

• Constant Field Values

COPY_NUMBER_PREFIX_PROPERTY

public static final String COPY_NUMBER_PREFIX_PROPERTY

The prefix to use for the number which is appended to the original title of the event.

See Also:

• Constant Field Values

distributionService

protected DistributionService distributionService

The distribution service

Constructor Details

DuplicateEventWorkflowOperationHandler

public DuplicateEventWorkflowOperationHandler()

Method Details

setAuthorizationService

public void setAuthorizationService(AuthorizationService authorizationService)

OSGi setter

Parameters:

authorizationService -

setSeriesService

public void setSeriesService(SeriesService seriesService)

OSGi setter

Parameters:

seriesService -

setAssetManager

public void setAssetManager(AssetManager assetManager)

Callback for the OSGi declarative services configuration.

Parameters:

assetManager - the asset manager

setWorkspace

public void setWorkspace(Workspace workspace)

Callback for the OSGi declarative services configuration.

Parameters:

workspace - the workspace

setDistributionService

public void setDistributionService(DistributionService distributionService)

Callback for the OSGi declarative services configuration.

Parameters:

distributionService - the distributionService to set

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)

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