org.opencastproject.workflow.handler.workflow

Class ZipWorkflowOperationHandler

java.lang.Object

org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

org.opencastproject.workflow.handler.workflow.ZipWorkflowOperationHandler

All Implemented Interfaces:

org.opencastproject.workflow.api.WorkflowOperationHandler

public class ZipWorkflowOperationHandler
extends org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

Produces a zipped archive of a mediapackage, places it in the archive collection, and removes the rest of the mediapackage elements from both the mediapackage xml and if possible, from storage altogether.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPRESS_PROPERTY The property indicating whether to apply compression to the archive
protected SortedMap<String,String>	configurationOptions The configuration properties
static org.opencastproject.mediapackage.MediaPackageElementFlavor	DEFAULT_ARCHIVE_FLAVOR The default flavor to use for a mediapackage archive
static String	DEFAULT_ZIP_ARCHIVE_TEMP_DIR The default location to use when building an zip archive relative to the storage directory
static String	DEFAULT_ZIP_COLLECTION The default collection in the working file repository to store archives
static String	INCLUDE_FLAVORS_PROPERTY The element flavors to include in the zip file
static String	TARGET_FLAVOR_PROPERTY The zip archive's target element flavor
static String	TARGET_TAGS_PROPERTY The zip archive's target tags
protected File	tempStorageDir The temporary storage location
protected org.opencastproject.workspace.api.Workspace	workspace The workspace to use in retrieving and storing files.
static String	ZIP_ARCHIVE_TEMP_DIR_CFG_KEY Key for configuring the location of the archive-temp folder
static String	ZIP_COLLECTION_PROPERTY The workflow operation's property to consult to determine the collection to use to store an archive

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

asList, description, id, options, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
ZipWorkflowOperationHandler() The default no-arg constructor builds the configuration options set

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext cc) Activate the component, generating the temporary storage directory for building zip archives if necessary.
SortedMap<String,String>	getConfigurationOptions()
void	setWorkspace(org.opencastproject.workspace.api.Workspace workspace) Sets the workspace to use.
org.opencastproject.workflow.api.WorkflowOperationResult	start(org.opencastproject.workflow.api.WorkflowInstance workflowInstance, org.opencastproject.job.api.JobContext context)
protected File	zip(org.opencastproject.mediapackage.MediaPackage mediaPackage, List<org.opencastproject.mediapackage.MediaPackageElementFlavor> flavorsToZip, boolean compress) Creates a zip archive of all elements in a mediapackage.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

ZIP_COLLECTION_PROPERTY

public static final String ZIP_COLLECTION_PROPERTY

The workflow operation's property to consult to determine the collection to use to store an archive

See Also:

Constant Field Values

INCLUDE_FLAVORS_PROPERTY

public static final String INCLUDE_FLAVORS_PROPERTY

The element flavors to include in the zip file

See Also:

Constant Field Values

TARGET_FLAVOR_PROPERTY

public static final String TARGET_FLAVOR_PROPERTY

The zip archive's target element flavor

See Also:

Constant Field Values

TARGET_TAGS_PROPERTY

public static final String TARGET_TAGS_PROPERTY

The zip archive's target tags

See Also:

Constant Field Values

COMPRESS_PROPERTY

public static final String COMPRESS_PROPERTY

The property indicating whether to apply compression to the archive

See Also:

Constant Field Values

DEFAULT_ZIP_COLLECTION

public static final String DEFAULT_ZIP_COLLECTION

The default collection in the working file repository to store archives

See Also:

Constant Field Values

DEFAULT_ZIP_ARCHIVE_TEMP_DIR

public static final String DEFAULT_ZIP_ARCHIVE_TEMP_DIR

The default location to use when building an zip archive relative to the storage directory

See Also:

Constant Field Values

ZIP_ARCHIVE_TEMP_DIR_CFG_KEY

public static final String ZIP_ARCHIVE_TEMP_DIR_CFG_KEY

Key for configuring the location of the archive-temp folder

See Also:

Constant Field Values

DEFAULT_ARCHIVE_FLAVOR

public static final org.opencastproject.mediapackage.MediaPackageElementFlavor DEFAULT_ARCHIVE_FLAVOR

The default flavor to use for a mediapackage archive

tempStorageDir

protected File tempStorageDir

The temporary storage location

configurationOptions

protected SortedMap<String,String> configurationOptions

The configuration properties

workspace

protected org.opencastproject.workspace.api.Workspace workspace

The workspace to use in retrieving and storing files.

Constructor Detail

ZipWorkflowOperationHandler

public ZipWorkflowOperationHandler()

The default no-arg constructor builds the configuration options set

Method Detail

setWorkspace

public void setWorkspace(org.opencastproject.workspace.api.Workspace workspace)

Sets the workspace to use.

Parameters:

workspace - the workspace

activate

protected void activate(org.osgi.service.component.ComponentContext cc)

Activate the component, generating the temporary storage directory for building zip archives if necessary.

Overrides:

activate in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

See Also:

AbstractWorkflowOperationHandler.activate(org.osgi.service.component.ComponentContext)

start

public org.opencastproject.workflow.api.WorkflowOperationResult start(org.opencastproject.workflow.api.WorkflowInstance workflowInstance,
                                                                      org.opencastproject.job.api.JobContext context)
                                                               throws org.opencastproject.workflow.api.WorkflowOperationException

Specified by:

start in interface org.opencastproject.workflow.api.WorkflowOperationHandler

Specified by:

start in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

Throws:

org.opencastproject.workflow.api.WorkflowOperationException

See Also:

AbstractWorkflowOperationHandler.start(org.opencastproject.workflow.api.WorkflowInstance, JobContext)

zip

protected File zip(org.opencastproject.mediapackage.MediaPackage mediaPackage,
                   List<org.opencastproject.mediapackage.MediaPackageElementFlavor> flavorsToZip,
                   boolean compress)
            throws IOException,
                   org.opencastproject.util.NotFoundException,
                   org.opencastproject.mediapackage.MediaPackageException,
                   org.opencastproject.workflow.api.WorkflowOperationException

Creates a zip archive of all elements in a mediapackage.

Parameters:

mediaPackage - the mediapackage to zip

Returns:

the zip file

Throws:

IOException - If an IO exception occurs

org.opencastproject.util.NotFoundException - If a file referenced in the mediapackage can not be found

org.opencastproject.mediapackage.MediaPackageException - If the mediapackage can not be serialized to xml

org.opencastproject.workflow.api.WorkflowOperationException - If the mediapackage is invalid

getConfigurationOptions

public SortedMap<String,String> getConfigurationOptions()

Specified by:

getConfigurationOptions in interface org.opencastproject.workflow.api.WorkflowOperationHandler

Overrides:

getConfigurationOptions in class org.opencastproject.workflow.api.AbstractWorkflowOperationHandler

See Also:

WorkflowOperationHandler.getConfigurationOptions()