Package org.opencastproject.ingest.impl

Class IngestServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.ingest.impl.IngestServiceImpl

All Implemented Interfaces:

IngestService, JobProducer, org.osgi.service.cm.ManagedService

public class IngestServiceImpl
extends AbstractJobProducer
implements IngestService, org.osgi.service.cm.ManagedService

Creates and augments Opencast MediaPackages. Stores media into the Working File Repository.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ONLY_NEW_FLAVORS_KEY	Managed Property key to allow new flavors of ingested attachments and catalogs to be added to the existing Opencast mediapackage.
static final boolean	DEFAULT_ALLOW_ONLY_NEW_FLAVORS	The default is to preserve existing Opencast flavors during ingest.
static final boolean	DEFAULT_ALLOW_SERIES_MODIFICATIONS	By default, do not allow event ingest to modify existing series metadata
static final boolean	DEFAULT_DOWNLOAD_AUTH_FORCE_BASIC	The default for force basic authentication even if download host does not ask for it
static final float	DEFAULT_INGEST_FILE_JOB_LOAD	The approximate load placed on the system by ingesting a file
static final float	DEFAULT_INGEST_ZIP_JOB_LOAD	The approximate load placed on the system by ingesting a zip file
static final boolean	DEFAULT_SKIP	The default is not to automatically skip attachments and catalogs from capture agent
protected String	defaultWorkflowDefinionId	The default workflow identifier, if one is configured
static final String	DOWNLOAD_AUTH_FORCE_BASIC	Force basic authentication even if download host does not ask for it
static final String	DOWNLOAD_AUTH_METHOD	The authentication method for download from external sources
static final String	DOWNLOAD_PASSWORD	The password for download from external sources
static final String	DOWNLOAD_SOURCE	The source to download from
static final String	DOWNLOAD_USER	The user for download from external sources
static final String	FILE_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_INGEST_FILE_JOB_LOAD
static final int	FILENAME_LENGTH_MAX	The maximum length of filenames ingested by Opencast
static final String	INGEST_ATTACHMENT	Methods that ingest attachments directly create jobs with this operation type
static final String	INGEST_ATTACHMENT_FROM_URI	Methods that ingest attachments from a URI create jobs with this operation type
static final String	INGEST_CATALOG	Methods that ingest catalogs directly create jobs with this operation type
static final String	INGEST_CATALOG_FROM_URI	Methods that ingest catalogs from a URI create jobs with this operation type
static final String	INGEST_TRACK	Methods that ingest tracks directly create jobs with this operation type
static final String	INGEST_TRACK_FROM_URI	Methods that ingest tracks from a URI create jobs with this operation type
static final String	INGEST_ZIP	Methods that ingest zips create jobs with this operation type
protected boolean	isAddOnlyNew	Option to overwrite matching flavors (e.g. series and episode metadata) on ingest, tracks are always taken on ingest
protected boolean	isAllowModifySeries
static final String	JOB_TYPE
static final String	LEGACY_MEDIAPACKAGE_ID_KEY	The key for the legacy mediapackage identifier
static final String	MODIFY_OPENCAST_SERIES_KEY	Deprecated.
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
static final String	SKIP_ATTACHMENTS_KEY	Control if attachments sent by capture agents for scheduled events are skipped.
static final String	SKIP_CATALOGS_KEY	Control if catalogs sent by capture agents for scheduled events are skipped.
protected boolean	testMode
protected UserDirectoryService	userDirectoryService	The user directory service
protected static final String	WORKFLOW_CONFIGURATION_PREFIX	The workflow configuration property prefix
protected static final String	WORKFLOW_DEFINITION_DEFAULT	The configuration key that defines the default workflow definition
static final String	ZIP_JOB_LOAD_KEY	The key to look for in the service configuration file to override the DEFAULT_INGEST_ZIP_JOB_LOAD

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Fields inherited from interface org.opencastproject.ingest.api.IngestService

START_DATE_KEY, UTC_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
IngestServiceImpl()	Creates a new ingest service instance.

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI callback for activating this component
MediaPackage	addAttachment(InputStream in, String fileName, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add an attachment to an existing MediaPackage in the repository
MediaPackage	addAttachment(InputStream in, String fileName, MediaPackageElementFlavor flavor, MediaPackage mediaPackage)	Add an attachment to an existing MediaPackage in the repository
MediaPackage	addAttachment(URI uri, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add an attachment to an existing MediaPackage in the repository
MediaPackage	addCatalog(InputStream in, String fileName, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add a [metadata catalog] to an existing MediaPackage in the repository
MediaPackage	addCatalog(InputStream in, String fileName, MediaPackageElementFlavor flavor, MediaPackage mediaPackage)	Add a [metadata catalog] to an existing MediaPackage in the repository
MediaPackage	addCatalog(URI uri, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add a [metadata catalog] to an existing MediaPackage in the repository
protected URI	addContentToRepo(MediaPackage mp, String elementId, URI uri)
MediaPackage	addPartialTrack(InputStream in, String fileName, MediaPackageElementFlavor flavor, long startTime, MediaPackage mediaPackage)	Adds a partial media track to the existing MediaPackage in the repository
MediaPackage	addPartialTrack(URI uri, MediaPackageElementFlavor flavor, long startTime, MediaPackage mediaPackage)	Adds a partial media track to the existing MediaPackage in the repository
MediaPackage	addTrack(InputStream in, String fileName, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add a media track to an existing MediaPackage in the repository
MediaPackage	addTrack(InputStream in, String fileName, MediaPackageElementFlavor flavor, MediaPackage mediaPackage)	Add a media track to an existing MediaPackage in the repository
MediaPackage	addTrack(URI uri, MediaPackageElementFlavor flavor, String[] tags, MediaPackage mediaPackage)	Add a media track to an existing MediaPackage in the repository
WorkflowInstance	addZippedMediaPackage(InputStream zipStream)
WorkflowInstance	addZippedMediaPackage(InputStream zipStream, String wd, Map<String,String> workflowConfig)	Ingests the compressed mediapackage and starts the workflow as defined by workflowDefinitionID.
WorkflowInstance	addZippedMediaPackage(InputStream zipStream, String workflowDefinitionId, Map<String,String> workflowConfig, Long workflowInstanceId)	Ingests the compressed mediapackage and starts the workflow as defined by workflowDefinitionID.
MediaPackage	createMediaPackage()	Create a new MediaPackage in the repository.
MediaPackage	createMediaPackage(String mediaPackageId)	Create a new MediaPackage in the repository.
void	deactivate()	Callback from OSGi on service deactivation.
void	discardMediaPackage(MediaPackage mp)	Delete an existing MediaPackage and any linked files from the temporary ingest filestore.
protected org.apache.http.impl.client.CloseableHttpClient	getAuthedHttpClient()
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
WorkflowInstance	ingest(MediaPackage mp)	Ingests the mediapackage and starts the default workflow as defined by the org.opencastproject.workflow.default.definition key, found in the system configuration.
WorkflowInstance	ingest(MediaPackage mp, String wd, Map<String,String> properties)	Ingests the mediapackage and starts the workflow as defined by workflowDefinitionID.
WorkflowInstance	ingest(MediaPackage mp, String workflowDefinitionId, Map<String,String> properties, Long workflowInstanceId)	Ingests the mediapackage and starts the workflow as defined by workflowDefinitionID.
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	schedule(MediaPackage mediaPackage, String workflowDefinitionID, Map<String,String> properties)	Schedule an event with a given media package.
void	setDublinCoreService(DublinCoreCatalogService dublinCoreService)
void	setHttpClient(TrustedHttpClient httpClient)	Sets the trusted http client
void	setMediaInspectionService(MediaInspectionService mediaInspectionService)	Sets the media inspection service
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setSchedulerService(SchedulerService schedulerService)	Callback for setting the scheduler service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setSeriesService(SeriesService seriesService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the service registry
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
void	setWorkflowService(WorkflowService workflowService)
void	setWorkingFileRepository(WorkingFileRepository workingFileRepository)
void	unsetSchedulerService(SchedulerService schedulerService)
void	updated(Dictionary<String,?> properties)
protected boolean	updateSeries(MediaPackage mediaPackage)	Updates the persistent representation of a series based on a potentially modified dublin core document.

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opencastproject.job.api.JobProducer

acceptJob, countJobs, getJobType, isReadyToAccept, isReadyToAcceptJobs

Field Details

WORKFLOW_DEFINITION_DEFAULT

protected static final String WORKFLOW_DEFINITION_DEFAULT

The configuration key that defines the default workflow definition

See Also:

• Constant Field Values

WORKFLOW_CONFIGURATION_PREFIX

protected static final String WORKFLOW_CONFIGURATION_PREFIX

The workflow configuration property prefix

See Also:

• Constant Field Values

LEGACY_MEDIAPACKAGE_ID_KEY

public static final String LEGACY_MEDIAPACKAGE_ID_KEY

The key for the legacy mediapackage identifier

See Also:

• Constant Field Values

JOB_TYPE

public static final String JOB_TYPE

See Also:

• Constant Field Values

INGEST_ZIP

public static final String INGEST_ZIP

Methods that ingest zips create jobs with this operation type

See Also:

• Constant Field Values

INGEST_TRACK

public static final String INGEST_TRACK

Methods that ingest tracks directly create jobs with this operation type

See Also:

• Constant Field Values

INGEST_TRACK_FROM_URI

public static final String INGEST_TRACK_FROM_URI

Methods that ingest tracks from a URI create jobs with this operation type

See Also:

• Constant Field Values

INGEST_ATTACHMENT

public static final String INGEST_ATTACHMENT

Methods that ingest attachments directly create jobs with this operation type

See Also:

• Constant Field Values

INGEST_ATTACHMENT_FROM_URI

public static final String INGEST_ATTACHMENT_FROM_URI

Methods that ingest attachments from a URI create jobs with this operation type

See Also:

• Constant Field Values

INGEST_CATALOG

public static final String INGEST_CATALOG

Methods that ingest catalogs directly create jobs with this operation type

See Also:

• Constant Field Values

INGEST_CATALOG_FROM_URI

public static final String INGEST_CATALOG_FROM_URI

Methods that ingest catalogs from a URI create jobs with this operation type

See Also:

• Constant Field Values

DEFAULT_INGEST_FILE_JOB_LOAD

public static final float DEFAULT_INGEST_FILE_JOB_LOAD

The approximate load placed on the system by ingesting a file

See Also:

• Constant Field Values

DEFAULT_INGEST_ZIP_JOB_LOAD

public static final float DEFAULT_INGEST_ZIP_JOB_LOAD

The approximate load placed on the system by ingesting a zip file

See Also:

• Constant Field Values

FILE_JOB_LOAD_KEY

public static final String FILE_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_INGEST_FILE_JOB_LOAD

See Also:

• Constant Field Values

ZIP_JOB_LOAD_KEY

public static final String ZIP_JOB_LOAD_KEY

The key to look for in the service configuration file to override the DEFAULT_INGEST_ZIP_JOB_LOAD

See Also:

• Constant Field Values

DOWNLOAD_SOURCE

public static final String DOWNLOAD_SOURCE

The source to download from

See Also:

• Constant Field Values

DOWNLOAD_USER

public static final String DOWNLOAD_USER

The user for download from external sources

See Also:

• Constant Field Values

DOWNLOAD_PASSWORD

public static final String DOWNLOAD_PASSWORD

The password for download from external sources

See Also:

• Constant Field Values

DOWNLOAD_AUTH_METHOD

public static final String DOWNLOAD_AUTH_METHOD

The authentication method for download from external sources

See Also:

• Constant Field Values

DOWNLOAD_AUTH_FORCE_BASIC

public static final String DOWNLOAD_AUTH_FORCE_BASIC

Force basic authentication even if download host does not ask for it

See Also:

• Constant Field Values

DEFAULT_ALLOW_SERIES_MODIFICATIONS

public static final boolean DEFAULT_ALLOW_SERIES_MODIFICATIONS

By default, do not allow event ingest to modify existing series metadata

See Also:

• Constant Field Values

DEFAULT_ALLOW_ONLY_NEW_FLAVORS

public static final boolean DEFAULT_ALLOW_ONLY_NEW_FLAVORS

The default is to preserve existing Opencast flavors during ingest.

See Also:

• Constant Field Values

DEFAULT_SKIP

public static final boolean DEFAULT_SKIP

The default is not to automatically skip attachments and catalogs from capture agent

See Also:

• Constant Field Values

DEFAULT_DOWNLOAD_AUTH_FORCE_BASIC

public static final boolean DEFAULT_DOWNLOAD_AUTH_FORCE_BASIC

The default for force basic authentication even if download host does not ask for it

See Also:

• Constant Field Values

FILENAME_LENGTH_MAX

public static final int FILENAME_LENGTH_MAX

The maximum length of filenames ingested by Opencast

See Also:

• Constant Field Values

MODIFY_OPENCAST_SERIES_KEY

@Deprecated
public static final String MODIFY_OPENCAST_SERIES_KEY

Deprecated.

Managed Property key to allow Opencast series modification during ingest Deprecated, the param potentially causes an update chain reaction for all events associated to that series, for each ingest

See Also:

• Constant Field Values

ADD_ONLY_NEW_FLAVORS_KEY

public static final String ADD_ONLY_NEW_FLAVORS_KEY

Managed Property key to allow new flavors of ingested attachments and catalogs to be added to the existing Opencast mediapackage. But, not catalogs and attachments that would overwrite existing ones in Opencast.

See Also:

• Constant Field Values

SKIP_CATALOGS_KEY

public static final String SKIP_CATALOGS_KEY

Control if catalogs sent by capture agents for scheduled events are skipped.

See Also:

• Constant Field Values

SKIP_ATTACHMENTS_KEY

public static final String SKIP_ATTACHMENTS_KEY

Control if attachments sent by capture agents for scheduled events are skipped.

See Also:

• Constant Field Values

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

defaultWorkflowDefinionId

protected String defaultWorkflowDefinionId

The default workflow identifier, if one is configured

isAddOnlyNew

protected boolean isAddOnlyNew

Option to overwrite matching flavors (e.g. series and episode metadata) on ingest, tracks are always taken on ingest

isAllowModifySeries

protected boolean isAllowModifySeries

testMode

protected boolean testMode

Constructor Details

IngestServiceImpl

public IngestServiceImpl()

Creates a new ingest service instance.

Method Details

activate

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

OSGI callback for activating this component

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - the osgi component context

deactivate

public void deactivate()

Callback from OSGi on service deactivation.

updated

public void updated(Dictionary<String,?> properties)
             throws ConfigurationException

Specified by:

updated in interface org.osgi.service.cm.ManagedService

Throws:

ConfigurationException

See Also:

• Retrieve ManagedService configuration, including option to overwrite series

setHttpClient

public void setHttpClient(TrustedHttpClient httpClient)

Sets the trusted http client

Parameters:

httpClient - the http client

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the service registry

Parameters:

serviceRegistry - the serviceRegistry to set

setMediaInspectionService

public void setMediaInspectionService(MediaInspectionService mediaInspectionService)

Sets the media inspection service

Parameters:

mediaInspectionService - the media inspection service to set

addZippedMediaPackage

public WorkflowInstance addZippedMediaPackage(InputStream zipStream)
                                       throws IngestException,
IOException,
MediaPackageException

Throws:

IngestException

IOException

MediaPackageException

addZippedMediaPackage

public WorkflowInstance addZippedMediaPackage(InputStream zipStream,
 String wd,
 Map<String,String> workflowConfig)
                                       throws MediaPackageException,
IOException,
IngestException,
NotFoundException

Description copied from interface: IngestService

Ingests the compressed mediapackage and starts the workflow as defined by workflowDefinitionID. The properties specified in properties will be submitted as configuration data to the workflow.

Specified by:

addZippedMediaPackage in interface IngestService

Parameters:

zipStream - A zipped file containing manifest, tracks, catalogs and attachments

wd - workflow to be used with this media package

workflowConfig - configuration parameters for the workflow

Returns:

Workflow instance.

Throws:

MediaPackageException - if the mediapackage contained in the zip stream is invalid

IOException - if reading from the input stream fails

IngestException - if an unexpected error occurs

NotFoundException - if the workflow definition was not found

addZippedMediaPackage

public WorkflowInstance addZippedMediaPackage(InputStream zipStream,
 String workflowDefinitionId,
 Map<String,String> workflowConfig,
 Long workflowInstanceId)
                                       throws MediaPackageException,
IOException,
IngestException,
NotFoundException,
UnauthorizedException

Ingests the compressed mediapackage and starts the workflow as defined by workflowDefinitionID. The properties specified in properties will be submitted as configuration data to the workflow.

The steps defined in that workflow will be appended to the already running workflow instance workflowId. If that workflow can't be found, a NotFoundException will be thrown. If the workflowId is null, a new WorkflowInstance is created.

Specified by:

addZippedMediaPackage in interface IngestService

Parameters:

zipStream - A zipped file containing manifest, tracks, catalogs and attachments

workflowDefinitionId - workflow to be used with this media package

workflowConfig - configuration parameters for the workflow

workflowInstanceId - the workflow instance

Returns:

Workflow instance.

Throws:

MediaPackageException - if the mediapackage contained in the zip stream is invalid

IOException - if reading from the input stream fails

IngestException - if an unexpected error occurs

NotFoundException - if either one of the workflow definition or workflow instance was not found

UnauthorizedException - if the current user does not have Permissions.Action.READ on the workflow instance's mediapackage.

See Also:

• IngestService.addZippedMediaPackage(java.io.InputStream, java.lang.String, java.util.Map, java.lang.Long)

createMediaPackage

public MediaPackage createMediaPackage()
                                throws MediaPackageException,
ConfigurationException

Create a new MediaPackage in the repository.

Specified by:

createMediaPackage in interface IngestService

Returns:

The created MediaPackage

Throws:

MediaPackageException

ConfigurationException

See Also:

• IngestService.createMediaPackage()

createMediaPackage

public MediaPackage createMediaPackage(String mediaPackageId)
                                throws MediaPackageException,
ConfigurationException

Create a new MediaPackage in the repository.

Specified by:

createMediaPackage in interface IngestService

Parameters:

mediaPackageId - The Id for the new Mediapackage

Returns:

The created MediaPackage

Throws:

MediaPackageException

ConfigurationException

See Also:

• IngestService.createMediaPackage()

addTrack

public MediaPackage addTrack(URI uri,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                      throws IOException,
IngestException

Add a media track to an existing MediaPackage in the repository

Specified by:

addTrack in interface IngestService

Parameters:

uri - The URL of the file to add

flavor - The flavor of the media that is being added

tags - Tags to add to the Track

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackageManifest The manifest of a specific Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addTrack(java.net.URI, org.opencastproject.mediapackage.MediaPackageElementFlavor, String[], org.opencastproject.mediapackage.MediaPackage)

addTrack

public MediaPackage addTrack(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 MediaPackage mediaPackage)
                      throws IOException,
IngestException

Add a media track to an existing MediaPackage in the repository

Specified by:

addTrack in interface IngestService

Parameters:

in - The media file to add

flavor - The flavor of the media that is being added

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addTrack(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

addTrack

public MediaPackage addTrack(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                      throws IOException,
IngestException

Add a media track to an existing MediaPackage in the repository

Specified by:

addTrack in interface IngestService

Parameters:

in - The media file to add

flavor - The flavor of the media that is being added

tags - Tags to Add to the Track

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addTrack(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

addPartialTrack

public MediaPackage addPartialTrack(URI uri,
 MediaPackageElementFlavor flavor,
 long startTime,
 MediaPackage mediaPackage)
                             throws IOException,
IngestException

Description copied from interface: IngestService

Adds a partial media track to the existing MediaPackage in the repository

Specified by:

addPartialTrack in interface IngestService

Parameters:

uri - the URL of the file to add

flavor - the flavor of the media that is being added

startTime - the start time

mediaPackage - the mediapackage

Returns:

the updated mediapackage

Throws:

IOException - if reading or writing of the partial track fails

IngestException - if an unexpected error occurs

addPartialTrack

public MediaPackage addPartialTrack(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 long startTime,
 MediaPackage mediaPackage)
                             throws IOException,
IngestException

Description copied from interface: IngestService

Adds a partial media track to the existing MediaPackage in the repository

Specified by:

addPartialTrack in interface IngestService

Parameters:

in - the media file to add

fileName - the file name

flavor - the flavor of the media that is being added

startTime - the start time

mediaPackage - the mediapackage

Returns:

the updated mediapackage

Throws:

IOException - if reading or writing of the partial track fails

IngestException - if an unexpected error occurs

addCatalog

public MediaPackage addCatalog(URI uri,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                        throws IOException,
IngestException

Add a [metadata catalog] to an existing MediaPackage in the repository

Specified by:

addCatalog in interface IngestService

Parameters:

uri - The URL of the file to add

flavor - The flavor of the media that is being added

tags - Tags to add to the catalog

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addCatalog(java.net.URI, org.opencastproject.mediapackage.MediaPackageElementFlavor, String[], org.opencastproject.mediapackage.MediaPackage)

updateSeries

protected boolean updateSeries(MediaPackage mediaPackage)
                        throws IOException,
IngestException

Updates the persistent representation of a series based on a potentially modified dublin core document.

Parameters:

mediaPackage - the media package containing series metadata and ACLs.

Returns:

true, if the series is created or overwritten, false if the existing series remains intact.

Throws:

IOException - if the series catalog was not found

IngestException - if any other exception was encountered

addCatalog

public MediaPackage addCatalog(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 MediaPackage mediaPackage)
                        throws IOException,
IngestException

Add a [metadata catalog] to an existing MediaPackage in the repository

Specified by:

addCatalog in interface IngestService

Parameters:

in - The catalog file to add

flavor - The flavor of the media that is being added

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addCatalog(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

addCatalog

public MediaPackage addCatalog(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                        throws IOException,
IngestException,
IllegalArgumentException

Add a [metadata catalog] to an existing MediaPackage in the repository

Specified by:

addCatalog in interface IngestService

Parameters:

in - The catalog file to add

flavor - The flavor of the media that is being added

tags - The tags for the media that is being added:

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

IllegalArgumentException - if the data passed to this method are not valid

See Also:

• IngestService.addCatalog(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

addAttachment

public MediaPackage addAttachment(URI uri,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                           throws IOException,
IngestException

Add an attachment to an existing MediaPackage in the repository

Specified by:

addAttachment in interface IngestService

Parameters:

uri - The URL of the file to add

flavor - The flavor of the media that is being added

tags - Tags to add to the attachment

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addAttachment(java.net.URI, org.opencastproject.mediapackage.MediaPackageElementFlavor, String[], org.opencastproject.mediapackage.MediaPackage)

addAttachment

public MediaPackage addAttachment(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 String[] tags,
 MediaPackage mediaPackage)
                           throws IOException,
IngestException

Add an attachment to an existing MediaPackage in the repository

Specified by:

addAttachment in interface IngestService

Parameters:

in - The file to add

flavor - The flavor of the media that is being added

tags - The tags of the media thas is being added

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addAttachment(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

addAttachment

public MediaPackage addAttachment(InputStream in,
 String fileName,
 MediaPackageElementFlavor flavor,
 MediaPackage mediaPackage)
                           throws IOException,
IngestException

Add an attachment to an existing MediaPackage in the repository

Specified by:

addAttachment in interface IngestService

Parameters:

in - The file to add

flavor - The flavor of the media that is being added

mediaPackage - The specific Opencast MediaPackage to which Media is being added

Returns:

MediaPackage The updated Opencast MediaPackage element

Throws:

IOException

IngestException - if an unexpected error occurs

See Also:

• IngestService.addAttachment(java.io.InputStream, java.lang.String, org.opencastproject.mediapackage.MediaPackageElementFlavor, org.opencastproject.mediapackage.MediaPackage)

ingest

public WorkflowInstance ingest(MediaPackage mp)
                        throws IngestException

Ingests the mediapackage and starts the default workflow as defined by the org.opencastproject.workflow.default.definition key, found in the system configuration.

Specified by:

ingest in interface IngestService

Parameters:

mp - The specific Opencast MediaPackage being ingested

Returns:

Workflow instance id.

Throws:

IngestException - if an unexpected error occurs

See Also:

• IngestService.ingest(org.opencastproject.mediapackage.MediaPackage)

ingest

public WorkflowInstance ingest(MediaPackage mp,
 String wd,
 Map<String,String> properties)
                        throws IngestException,
NotFoundException

Ingests the mediapackage and starts the workflow as defined by workflowDefinitionID. The properties specified in properties will be submitted as configuration data to the workflow.

Specified by:

ingest in interface IngestService

Parameters:

mp - The specific Opencast MediaPackage being ingested

wd - workflow to be used with this media package

properties - configuration properties for the workflow

Returns:

Workflow instance id.

Throws:

IngestException - if an unexpected error occurs

NotFoundException - if the workflow defintion can't be found

See Also:

• IngestService.ingest(org.opencastproject.mediapackage.MediaPackage, java.lang.String, java.util.Map)

ingest

public WorkflowInstance ingest(MediaPackage mp,
 String workflowDefinitionId,
 Map<String,String> properties,
 Long workflowInstanceId)
                        throws IngestException,
NotFoundException,
UnauthorizedException

Ingests the mediapackage and starts the workflow as defined by workflowDefinitionID. The properties specified in properties will be submitted as configuration data to the workflow.

The steps defined in that workflow will be appended to the already running workflow instance workflowId. If that workflow can't be found, a NotFoundException will be thrown. If the workflowId is null, a new WorkflowInstance is created.

Specified by:

ingest in interface IngestService

Parameters:

mp - The specific Opencast MediaPackage being ingested

workflowDefinitionId - workflow to be used with this media package

properties - configuration properties for the workflow

workflowInstanceId - the workflow identifier

Returns:

Workflow instance id.

Throws:

IngestException - if an unexpected error occurs

NotFoundException - if either one of the workflow definition or workflow instance was not found

UnauthorizedException - if the current user does not have Permissions.Action.READ on the workflow instance's mediapackage.

See Also:

• IngestService.ingest(org.opencastproject.mediapackage.MediaPackage, java.lang.String, java.util.Map, java.lang.Long)

schedule

public void schedule(MediaPackage mediaPackage,
 String workflowDefinitionID,
 Map<String,String> properties)
              throws IllegalStateException,
IngestException,
NotFoundException,
UnauthorizedException,
SchedulerException

Description copied from interface: IngestService

Schedule an event with a given media package.

Specified by:

schedule in interface IngestService

Parameters:

mediaPackage - The specific Opencast MediaPackage being ingested

workflowDefinitionID - workflow to be used with this media package

properties - configuration properties for the workflow

Throws:

IngestException - if an unexpected error occurs

NotFoundException - if the workflow defintion can't be found

IllegalStateException

UnauthorizedException

SchedulerException

discardMediaPackage

public void discardMediaPackage(MediaPackage mp)
                         throws IOException

Delete an existing MediaPackage and any linked files from the temporary ingest filestore.

Specified by:

discardMediaPackage in interface IngestService

Parameters:

mp - The specific Opencast MediaPackage

Throws:

IOException

See Also:

• IngestService.discardMediaPackage(org.opencastproject.mediapackage.MediaPackage)

addContentToRepo

protected URI addContentToRepo(MediaPackage mp,
 String elementId,
 URI uri)
                        throws IOException

Throws:

IOException

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

setWorkingFileRepository

public void setWorkingFileRepository(WorkingFileRepository workingFileRepository)

setSeriesService

public void setSeriesService(SeriesService seriesService)

setDublinCoreService

public void setDublinCoreService(DublinCoreCatalogService dublinCoreService)

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

See Also:

• AbstractJobProducer.getServiceRegistry()

process

protected String process(Job job)
                  throws Exception

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

See Also:

• AbstractJobProducer.process(org.opencastproject.job.api.Job)

setSecurityService

public void setSecurityService(SecurityService securityService)

Callback for setting the security service.

Parameters:

securityService - the securityService to set

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

Callback for setting the user directory service.

Parameters:

userDirectoryService - the userDirectoryService to set

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

Callback for setting the scheduler service.

Parameters:

schedulerService - the scheduler service to set

unsetSchedulerService

public void unsetSchedulerService(SchedulerService schedulerService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

getSecurityService

protected SecurityService getSecurityService()

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

See Also:

• AbstractJobProducer.getSecurityService()

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

See Also:

• AbstractJobProducer.getUserDirectoryService()

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

See Also:

• AbstractJobProducer.getOrganizationDirectoryService()

getAuthedHttpClient

protected org.apache.http.impl.client.CloseableHttpClient getAuthedHttpClient()