Package org.opencastproject.coverimage.impl

Class AbstractCoverImageService

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.coverimage.impl.AbstractCoverImageService

All Implemented Interfaces:

CoverImageService, JobProducer

Direct Known Subclasses:

CoverImageServiceOsgiImpl

public abstract class AbstractCoverImageService
extends AbstractJobProducer
implements CoverImageService

Service for creating cover images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	AbstractCoverImageService.Operation	List of available operations on jobs

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	COVERIMAGE_WORKSPACE_COLLECTION
protected OrganizationDirectoryService	organizationDirectoryService	The organization directory service
protected SecurityService	securityService	The security service
protected ServiceRegistry	serviceRegistry	The service registry service
protected UserDirectoryService	userDirectoryService	The user directory service
protected Workspace	workspace	The workspace service

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.coverimage.CoverImageService

JOB_TYPE

Constructor Summary

Constructors

Constructor	Description
AbstractCoverImageService()	Creates a new composer service instance.

Method Summary

Modifier and Type	Method	Description
protected File	createTempFile(Job job, String suffix)
Job	generateCoverImage(String xml, String xsl, String width, String height, String posterImageUri, String targetFlavor)	Creates a job for creating a cover image for movie/media package.
protected Attachment	generateCoverImageInternal(Job job, String xml, String xsl, int width, int height, String posterImage, String targetFlavor)
protected static Document	parseXsl(String xsl)
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
protected static void	rasterizeSvg(File svgSource, File pngResult)
protected static void	transformSvg(Result svg, InputSource xmlSource, Document xslDoc, int width, int height, String posterImage)

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

acceptJob, activate, countJobs, finallyUpdateJob, getJobType, getOrganizationDirectoryService, getSecurityService, getServiceRegistry, getUserDirectoryService, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

COVERIMAGE_WORKSPACE_COLLECTION

protected static final String COVERIMAGE_WORKSPACE_COLLECTION

See Also:

• Constant Field Values

workspace

protected Workspace workspace

The workspace service

serviceRegistry

protected ServiceRegistry serviceRegistry

The service registry service

securityService

protected SecurityService securityService

The security service

userDirectoryService

protected UserDirectoryService userDirectoryService

The user directory service

organizationDirectoryService

protected OrganizationDirectoryService organizationDirectoryService

The organization directory service

Constructor Details

AbstractCoverImageService

public AbstractCoverImageService()

Creates a new composer service instance.

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

generateCoverImage

public Job generateCoverImage(String xml,
 String xsl,
 String width,
 String height,
 String posterImageUri,
 String targetFlavor)
                       throws CoverImageException

Description copied from interface: CoverImageService

Creates a job for creating a cover image for movie/media package.

Specified by:

generateCoverImage in interface CoverImageService

Parameters:

xml - metadata as XML. Will be handed over to the XSL transformation. Optional, if not given, there should be a fallback

xsl - the XSL stylesheet used to create the SVG version of the cover image

width - the width of the resulting image

height - the height of the resulting image

posterImageUri - file URI to an additional poster image (optional)

targetFlavor - target flavor

Returns:

a job instance

Throws:

CoverImageException - if there is an error while creating the job

generateCoverImageInternal

protected Attachment generateCoverImageInternal(Job job,
 String xml,
 String xsl,
 int width,
 int height,
 String posterImage,
 String targetFlavor)
                                         throws CoverImageException

Throws:

CoverImageException

parseXsl

protected static Document parseXsl(String xsl)
                            throws CoverImageException

Throws:

CoverImageException

transformSvg

protected static void transformSvg(Result svg,
 InputSource xmlSource,
 Document xslDoc,
 int width,
 int height,
 String posterImage)
                            throws TransformerFactoryConfigurationError,
CoverImageException

Throws:

TransformerFactoryConfigurationError

CoverImageException

createTempFile

protected File createTempFile(Job job,
 String suffix)
                       throws CoverImageException

Throws:

CoverImageException

rasterizeSvg

protected static void rasterizeSvg(File svgSource,
 File pngResult)
                            throws CoverImageException

Throws:

CoverImageException