Package org.opencastproject.publication.oaipmh

Class OaiPmhPublicationServiceImpl

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.publication.oaipmh.OaiPmhPublicationServiceImpl

All Implemented Interfaces:

JobProducer, OaiPmhPublicationService

public class OaiPmhPublicationServiceImpl
extends AbstractJobProducer
implements OaiPmhPublicationService

Publishes a recording to an OAI-PMH publication repository.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OaiPmhPublicationServiceImpl.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.OaiPmhPublicationService

JOB_TYPE, PUBLICATION_CHANNEL_PREFIX, SEPARATOR

Constructor Summary

Constructors

Constructor	Description
OaiPmhPublicationServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	checkInputArguments(MediaPackage mediaPackage, String repository)
protected Publication	createPublicationElement(String mpId, String repository)	Create a new publication element.
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected String	getPublicationChannelName(String repository)
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
static MediaPackage	merge(MediaPackage updatedMp, MediaPackage publishedMp)	Merges the updated media package with the one that is currently published in a way where the updated elements replace existing ones in the published media package based on their flavor.
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
protected Publication	publish(Job job, MediaPackage mediaPackage, String repository, Set<String> downloadElementIds, Set<String> streamingElementIds, boolean checkAvailability)
Job	publish(MediaPackage mediaPackage, String repository, Set<String> downloadElementIds, Set<String> streamingElementIds, boolean checkAvailability)	Publishes some media package elements.
static MediaPackage	removeMatchingNonExistantElements(MediaPackage updatedMp, MediaPackage publishedMp, Set<MediaPackageElementFlavor> flavors, Set<String> tags)	Remove all these elements from publishedMp, that matches the given flavors and tags but are not in the updatedMp.
Job	replace(MediaPackage mediaPackage, String repository, Set<? extends MediaPackageElement> downloadElements, Set<? extends MediaPackageElement> streamingElements, Set<MediaPackageElementFlavor> retractDownloadFlavors, Set<MediaPackageElementFlavor> retractStreamingFlavors, Set<? extends Publication> publications, boolean checkAvailability)	Updates the given media package in the Oai-Pmh storage incrementally, i.e. without retracting the whole media package.
Publication	replaceSync(MediaPackage mediaPackage, String repository, Set<? extends MediaPackageElement> downloadElements, Set<? extends MediaPackageElement> streamingElements, Set<MediaPackageElementFlavor> retractDownloadFlavors, Set<MediaPackageElementFlavor> retractStreamingFlavors, Set<? extends Publication> publications, boolean checkAvailability)	Synchronously updates the given media package in the Oai-Pmh storage incrementally, i.e. without retracting the whole media package.
protected Publication	retract(Job job, MediaPackage mediaPackage, String repository)
Job	retract(MediaPackage mediaPackage, String repository)	Retract a media package from the publication channel.
void	setDownloadDistributionService(DownloadDistributionService downloadDistributionService)	OSGI DI
void	setOaiPmhDatabase(OaiPmhDatabase oaiPmhDatabase)	OSGI DI
void	setOaiPmhServerInfo(OaiPmhServerInfo oaiPmhServerInfo)	OSGI DI
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)	OSGI DI
void	setSecurityService(SecurityService securityService)	OSGI DI
void	setServiceRegistry(ServiceRegistry serviceRegistry)	OSGI DI
void	setStreamingDistributionService(StreamingDistributionService streamingDistributionService)	OSGI DI
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGI DI
protected Publication	updateMetadata(Job job, MediaPackage mediaPackage, String repository, Set<String> flavors, Set<String> tags, boolean checkAvailability)
Job	updateMetadata(MediaPackage mediaPackage, String repository, Set<String> flavors, Set<String> tags, boolean checkAvailability)	Update all media package elements that match the flavors and tags.

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

OaiPmhPublicationServiceImpl

public OaiPmhPublicationServiceImpl()

Method Details

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

replace

public Job replace(MediaPackage mediaPackage,
 String repository,
 Set<? extends MediaPackageElement> downloadElements,
 Set<? extends MediaPackageElement> streamingElements,
 Set<MediaPackageElementFlavor> retractDownloadFlavors,
 Set<MediaPackageElementFlavor> retractStreamingFlavors,
 Set<? extends Publication> publications,
 boolean checkAvailability)
            throws PublicationException

Description copied from interface: OaiPmhPublicationService

Updates the given media package in the Oai-Pmh storage incrementally, i.e. without retracting the whole media package.

Specified by:

replace in interface OaiPmhPublicationService

Parameters:

mediaPackage - The media package to publish the element for

repository - The OAI-PMH repository

downloadElements - the download elements to publish

streamingElements - the streaming elements to publish

retractDownloadFlavors - flavors to use to search for download elements to retract.

retractStreamingFlavors - flavors to use to search for streaming elements to retract.

publications - the publications to update

checkAvailability - whether to check the distributed download artifacts are available at their URLs

Returns:

The job which performs the operation (The job payload will hold the publication with the updated media package).

Throws:

PublicationException - if the job could not be created.

replaceSync

public Publication replaceSync(MediaPackage mediaPackage,
 String repository,
 Set<? extends MediaPackageElement> downloadElements,
 Set<? extends MediaPackageElement> streamingElements,
 Set<MediaPackageElementFlavor> retractDownloadFlavors,
 Set<MediaPackageElementFlavor> retractStreamingFlavors,
 Set<? extends Publication> publications,
 boolean checkAvailability)
                        throws PublicationException,
MediaPackageException

Description copied from interface: OaiPmhPublicationService

Synchronously updates the given media package in the Oai-Pmh storage incrementally, i.e. without retracting the whole media package.

Specified by:

replaceSync in interface OaiPmhPublicationService

Parameters:

mediaPackage - The media package to publish the element for

repository - The OAI-PMH repository

downloadElements - the download elements to publish

streamingElements - the streaming elements to publish

retractDownloadFlavors - flavors to use to search for download elements to retract.

retractStreamingFlavors - flavors to use to search for streaming elements to retract.

publications - the publications to update

checkAvailability - whether to check the distributed download artifacts are available at their URLs

Returns:

The publication with the updated media package.

Throws:

PublicationException - if the job could not be created.

MediaPackageException - if distribution failed.

publish

public Job publish(MediaPackage mediaPackage,
 String repository,
 Set<String> downloadElementIds,
 Set<String> streamingElementIds,
 boolean checkAvailability)
            throws PublicationException,
MediaPackageException

Description copied from interface: OaiPmhPublicationService

Publishes some media package elements.

Specified by:

publish in interface OaiPmhPublicationService

Parameters:

mediaPackage - the media package

repository - the OAI-PMH repository

downloadElementIds - the download element ids to publish

streamingElementIds - the streaming element ids to publish

checkAvailability - whether to check the distributed download artifacts are available at its URL

Returns:

The job

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the mediapackage element

retract

public Job retract(MediaPackage mediaPackage,
 String repository)
            throws PublicationException,
NotFoundException

Description copied from interface: OaiPmhPublicationService

Retract a media package from the publication channel.

Specified by:

retract in interface OaiPmhPublicationService

Parameters:

mediaPackage - the media package

repository - the OAI-PMH repository

Throws:

PublicationException - if there was a problem retracting the mediapackage

NotFoundException - if there was no mediapackage to retract from this channel

updateMetadata

public Job updateMetadata(MediaPackage mediaPackage,
 String repository,
 Set<String> flavors,
 Set<String> tags,
 boolean checkAvailability)
                   throws PublicationException,
MediaPackageException

Description copied from interface: OaiPmhPublicationService

Update all media package elements that match the flavors and tags. Also update the media package in the given OAI-PMH repository.

Specified by:

updateMetadata in interface OaiPmhPublicationService

Parameters:

mediaPackage - media package with updated elements

repository - OAI-PMH repository where to update the media package

flavors - updated media package element flavors

tags - updated media package element tags

checkAvailability - whether to check the distributed download artifacts are available at its URL

Returns:

The job to update the media package

Throws:

PublicationException - if there was a problem publishing the media

MediaPackageException - if there was a problem with the media package element

publish

protected Publication publish(Job job,
 MediaPackage mediaPackage,
 String repository,
 Set<String> downloadElementIds,
 Set<String> streamingElementIds,
 boolean checkAvailability)
                       throws PublicationException,
MediaPackageException

Throws:

PublicationException

MediaPackageException

retract

protected Publication retract(Job job,
 MediaPackage mediaPackage,
 String repository)
                       throws PublicationException,
NotFoundException

Throws:

PublicationException

NotFoundException

updateMetadata

protected Publication updateMetadata(Job job,
 MediaPackage mediaPackage,
 String repository,
 Set<String> flavors,
 Set<String> tags,
 boolean checkAvailability)
                              throws PublicationException

Throws:

PublicationException

checkInputArguments

protected void checkInputArguments(MediaPackage mediaPackage,
 String repository)

getPublicationChannelName

protected String getPublicationChannelName(String repository)

createPublicationElement

protected Publication createPublicationElement(String mpId,
 String repository)
                                        throws PublicationException

Create a new publication element.

Throws:

PublicationException

removeMatchingNonExistantElements

public static MediaPackage removeMatchingNonExistantElements(MediaPackage updatedMp,
 MediaPackage publishedMp,
 Set<MediaPackageElementFlavor> flavors,
 Set<String> tags)

Remove all these elements from publishedMp, that matches the given flavors and tags but are not in the updatedMp.

Parameters:

updatedMp - the updated media package

publishedMp - the media package that is currently published

flavors - flavors of elements to update

tags - tags of elements to update

Returns:

published media package without elements, that matches the flavors and tags but are not in the updated media package

merge

public static MediaPackage merge(MediaPackage updatedMp,
 MediaPackage publishedMp)

Merges the updated media package with the one that is currently published in a way where the updated elements replace existing ones in the published media package based on their flavor.

If publishedMp is null, this method returns the updated media package without any modifications.

Parameters:

updatedMp - the updated media package

publishedMp - the media package that is currently published

Returns:

the merged media package

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

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

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

OSGI DI

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGI DI

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGI DI

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

OSGI DI

setDownloadDistributionService

public void setDownloadDistributionService(DownloadDistributionService downloadDistributionService)

OSGI DI

setStreamingDistributionService

public void setStreamingDistributionService(StreamingDistributionService streamingDistributionService)

OSGI DI

setOaiPmhServerInfo

public void setOaiPmhServerInfo(OaiPmhServerInfo oaiPmhServerInfo)

OSGI DI

setOaiPmhDatabase

public void setOaiPmhDatabase(OaiPmhDatabase oaiPmhDatabase)

OSGI DI