Package org.opencastproject.publication.configurable

Class ConfigurablePublicationServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.publication.configurable.ConfigurablePublicationServiceImpl

All Implemented Interfaces:

JobProducer, ConfigurablePublicationService

public class ConfigurablePublicationServiceImpl
extends AbstractJobProducer
implements ConfigurablePublicationService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConfigurablePublicationServiceImpl.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.publication.api.ConfigurablePublicationService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
ConfigurablePublicationServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
String	getJobType()	The type of jobs that this producer creates.
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
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
Job	replace(MediaPackage mediaPackage, String channelId, Collection<? extends MediaPackageElement> addElements, Set<String> retractElementIds)	Replaces media package elements.
Publication	replaceSync(MediaPackage mediaPackage, String channelId, Collection<? extends MediaPackageElement> addElements, Set<String> retractElementIds)	Synchronously replaces media package elements.
void	setDownloadDistributionService(DownloadDistributionService downloadDistributionService)
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
void	setSecurityService(SecurityService securityService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)

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

acceptJob, countJobs, finallyUpdateJob, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurablePublicationServiceImpl

public ConfigurablePublicationServiceImpl()

Method Details

activate

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

Description copied from class: AbstractJobProducer

OSGI activate method.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - OSGI component context

getJobType

public String getJobType()

Description copied from class: AbstractJobProducer

The type of jobs that this producer creates.

Specified by:

getJobType in interface JobProducer

Overrides:

getJobType in class AbstractJobProducer

Returns:

the job type

See Also:

• JobProducer.getJobType()

replace

public Job replace(MediaPackage mediaPackage,
 String channelId,
 Collection<? extends MediaPackageElement> addElements,
 Set<String> retractElementIds)
            throws PublicationException,
MediaPackageException

Description copied from interface: ConfigurablePublicationService

Replaces media package elements.

Specified by:

replace in interface ConfigurablePublicationService

Parameters:

mediaPackage - the media package

channelId - the id of the publication channel

addElements - the media package elements to be added

retractElementIds - the ids of the media package elements to be removed

Returns:

The job

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the mediapackage element

replaceSync

public Publication replaceSync(MediaPackage mediaPackage,
 String channelId,
 Collection<? extends MediaPackageElement> addElements,
 Set<String> retractElementIds)
                        throws PublicationException,
MediaPackageException

Description copied from interface: ConfigurablePublicationService

Synchronously replaces media package elements.

Specified by:

replaceSync in interface ConfigurablePublicationService

Parameters:

mediaPackage - the media package

channelId - the id of the publication channel

addElements - the media package elements to be added

retractElementIds - the ids of the media package elements to be removed

Returns:

The publication with the updated media package.

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the mediapackage element

process

protected String process(Job job)
                  throws Exception

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:

Exception

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducer

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

getSecurityService

protected SecurityService getSecurityService()

Description copied from class: AbstractJobProducer

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSecurityService

public void setSecurityService(SecurityService securityService)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

setDownloadDistributionService

public void setDownloadDistributionService(DownloadDistributionService downloadDistributionService)