Package org.opencastproject.ingestdownloadservice.impl

Class IngestDownloadServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.ingestdownloadservice.impl.IngestDownloadServiceImpl

All Implemented Interfaces:

IngestDownloadService, JobProducer

public class IngestDownloadServiceImpl
extends AbstractJobProducer
implements IngestDownloadService

A simple tutorial class to learn about Opencast Services

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IngestDownloadServiceImpl.Operation

Field Summary

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.ingestdownloadservice.api.IngestDownloadService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
IngestDownloadServiceImpl()	Creates a new abstract job producer for jobs of the given type.

Method Summary

Modifier and Type	Method	Description
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
Job	ingestDownload(MediaPackage mediaPackage, String sourceFlavors, String sourceTags, boolean deleteExternal, boolean tagsAndFlavor)
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)	Sets a reference to the organization directory service.
void	setSecurityService(SecurityService securityService)	Callback for setting the security service.
void	setServiceRegistry(ServiceRegistry serviceRegistry)	Sets the receipt service
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	Callback for setting the user directory service.
void	setWorkspace(Workspace workspace)	Sets the workspace to use.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

IngestDownloadServiceImpl

public IngestDownloadServiceImpl()

Creates a new abstract job producer for jobs of the given type.

Method Details

setWorkspace

public void setWorkspace(Workspace workspace)

Sets the workspace to use.

Parameters:

workspace - the workspace

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Sets the receipt service

Parameters:

serviceRegistry - the service registry

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

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

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

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

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectory)

Sets a reference to the organization directory service.

Parameters:

organizationDirectory - the organization directory

ingestDownload

public Job ingestDownload(MediaPackage mediaPackage,
 String sourceFlavors,
 String sourceTags,
 boolean deleteExternal,
 boolean tagsAndFlavor)
                   throws ServiceRegistryException

Specified by:

ingestDownload in interface IngestDownloadService

Parameters:

mediaPackage - The media package to download elements from

sourceFlavors - Flavors identifying elements to download

sourceTags - Tags identifying elements to download

deleteExternal - If the service should try to delete external elements after downloading

tagsAndFlavor - If elements are selected based on a union or an interjection of the sets selected by tags and flavors

Returns:

The launched job

Throws:

ServiceRegistryException - If starting the job failed

process

protected String process(Job job)
                  throws MediaPackageException,
IOException

Description copied from class: AbstractJobProducer

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:

MediaPackageException

IOException