com.edorasware.cloud.core.conversion.internal

Class AbstractDocumentContentConverterService

java.lang.Object

com.edorasware.cloud.core.conversion.internal.AbstractDocumentContentConverterService

All Implemented Interfaces:

DocumentContentConverterService

Direct Known Subclasses:

DefaultPdfDocumentContentConverterService, DefaultPreviewDocumentContentConverterService

public abstract class AbstractDocumentContentConverterService
extends Object
implements DocumentContentConverterService

This class is responsible for document content conversion (usually for *->pdf for preview and pdf download purposes) Service uses cache (memory and disk) to minimize unneeded conversions.

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentContentConverterService(com.edorasware.commons.core.content.ContentManager contentManager, com.edorasware.api.workobject.WorkObjectService workObjectService, String cacheTempPath, String tempFileNamePrefix, List<DocumentContentConverter> contentConverters, com.edorasware.commons.core.cache.StatisticsAwareCache statisticsAwareCache)

Method Summary

Modifier and Type	Method and Description
void	evictCachedFile(String globalId) Evict the cached file from the corresponding WorkObject.
Set<com.google.common.net.MediaType>	getAcceptableMediaTypes() Returns set of supported media types, which is converter able to convert
org.springframework.core.io.Resource	getConvertedContent(String id) Returns converted content for a given document work object.
com.edorasware.commons.core.content.ContentMetadata	getConvertedContentMetadata(String id) Returns converted ContentMetadata for the given document work object reference
com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,org.springframework.core.io.Resource>	getConvertedContentMetadataAndInputStream(String id) Returns converted content for the given document identifier
com.edorasware.commons.core.content.ContentReference	getConvertedContentReference(String id) Returns converted ContentReference for the given document work object reference
boolean	isConvertible(com.edorasware.api.workobject.WorkObject workObject) Is given workObject convertible by this service
void	shutdown() Clean up the cache and remove all temporary files

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocumentContentConverterService

public AbstractDocumentContentConverterService(com.edorasware.commons.core.content.ContentManager contentManager,
                                               com.edorasware.api.workobject.WorkObjectService workObjectService,
                                               String cacheTempPath,
                                               String tempFileNamePrefix,
                                               List<DocumentContentConverter> contentConverters,
                                               com.edorasware.commons.core.cache.StatisticsAwareCache statisticsAwareCache)

Parameters:

contentManager - content manager to use for obtaining content

workObjectService - generic workobject service for resolving workobjects

cacheTempPath - directory in which temporary converted content is stored. If null or empty default path (${edoras-one.home}/temp) is used. Directory is always cleaned up on the spring application context refresh.

tempFileNamePrefix - file name prefix used for cached files (can be empty)

contentConverters - converters to use for content conversion

statisticsAwareCache - One cache.

Method Detail

getConvertedContent

public org.springframework.core.io.Resource getConvertedContent(String id)

Description copied from interface: DocumentContentConverterService

Returns converted content for a given document work object.

Specified by:

getConvertedContent in interface DocumentContentConverterService

Parameters:

id - the document identifier

Returns:

converted content input stream

getConvertedContentMetadataAndInputStream

public com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,org.springframework.core.io.Resource> getConvertedContentMetadataAndInputStream(String id)

Description copied from interface: DocumentContentConverterService

Returns converted content for the given document identifier

Specified by:

getConvertedContentMetadataAndInputStream in interface DocumentContentConverterService

Parameters:

id - document identifier

Returns:

Pair of ContentMetadata and converted content InputStream

getConvertedContentReference

public com.edorasware.commons.core.content.ContentReference getConvertedContentReference(String id)

Description copied from interface: DocumentContentConverterService

Returns converted ContentReference for the given document work object reference

Specified by:

getConvertedContentReference in interface DocumentContentConverterService

Parameters:

id - document identifier

Returns:

ContentReference

getConvertedContentMetadata

public com.edorasware.commons.core.content.ContentMetadata getConvertedContentMetadata(String id)

Description copied from interface: DocumentContentConverterService

Returns converted ContentMetadata for the given document work object reference

Specified by:

getConvertedContentMetadata in interface DocumentContentConverterService

Parameters:

id - document identifier

Returns:

converted ContentMetadata

isConvertible

public boolean isConvertible(com.edorasware.api.workobject.WorkObject workObject)

Description copied from interface: DocumentContentConverterService

Is given workObject convertible by this service

Specified by:

isConvertible in interface DocumentContentConverterService

Parameters:

workObject - to convert

Returns:

true if object is convertible, false otherwise

shutdown

public void shutdown()

Clean up the cache and remove all temporary files

Specified by:

shutdown in interface DocumentContentConverterService

evictCachedFile

public void evictCachedFile(String globalId)

Evict the cached file from the corresponding WorkObject.

Specified by:

evictCachedFile in interface DocumentContentConverterService

Parameters:

globalId - The global ID to evict

getAcceptableMediaTypes

public Set<com.google.common.net.MediaType> getAcceptableMediaTypes()

Description copied from interface: DocumentContentConverterService

Returns set of supported media types, which is converter able to convert

Specified by:

getAcceptableMediaTypes in interface DocumentContentConverterService

Returns:

set of supported MediaType