com.edorasware.cloud.core.conversion

Class DocumentContentConverterService

java.lang.Object

com.edorasware.cloud.core.conversion.DocumentContentConverterService

All Implemented Interfaces:

com.edorasware.commons.core.util.service.Service, EventListener, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

public class DocumentContentConverterService
extends Object
implements com.edorasware.commons.core.util.service.Service, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

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
DocumentContentConverterService(com.edorasware.commons.core.content.ContentManager contentManager, com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, String cacheTempPath, String tempFileNamePrefix, List<DocumentContentConverter> contentConverters, com.edorasware.one.cache.OneCache oneCache)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ensureTemporaryDirectory(String temporaryDirectoryPath)
void	evictCachedFile(com.edorasware.commons.core.entity.WorkObjectId id) Evict the cached file from the corresponding WorkObject.
Set<com.google.common.net.MediaType>	getAcceptableMediaTypes()
InputStream	getConvertedContent(com.edorasware.commons.core.entity.WorkObjectId id)
com.edorasware.commons.core.content.ContentMetadata	getConvertedContentMetadata(com.edorasware.commons.core.any.AnyWorkObjectId id)
com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,InputStream>	getConvertedContentMetadataAndInputStream(com.edorasware.commons.core.entity.WorkObjectId id)
com.edorasware.commons.core.content.ContentReference	getConvertedContentReference(com.edorasware.commons.core.any.AnyWorkObjectId id)
protected String	getDefaultBaseDirectory() Returns the default base directory for content providers with a trailing separator.
void	init()
boolean	isConvertible(com.edorasware.commons.core.entity.WorkObject<?,?,?> workObject)
void	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event) clean up temp directory files in the case of context refresh event.
void	shutdown() Clean up the cache and remove all temporary files

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentContentConverterService

public DocumentContentConverterService(com.edorasware.commons.core.content.ContentManager contentManager,
                               com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                               String cacheTempPath,
                               String tempFileNamePrefix,
                               List<DocumentContentConverter> contentConverters,
                               com.edorasware.one.cache.OneCache oneCache)

Parameters:

contentManager - content manager to use for obtaining content

anyWorkObjectService - 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

oneCache - One cache.

Method Detail

init

public void init()

Specified by:

init in interface com.edorasware.commons.core.util.service.Service

getConvertedContent

public InputStream getConvertedContent(com.edorasware.commons.core.entity.WorkObjectId id)

getConvertedContentMetadataAndInputStream

public com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,InputStream> getConvertedContentMetadataAndInputStream(com.edorasware.commons.core.entity.WorkObjectId id)

getConvertedContentReference

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

getConvertedContentMetadata

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

isConvertible

public boolean isConvertible(com.edorasware.commons.core.entity.WorkObject<?,?,?> workObject)

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

clean up temp directory files in the case of context refresh event.

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

Parameters:

event - context refresh event

shutdown

public void shutdown()

Clean up the cache and remove all temporary files

evictCachedFile

public void evictCachedFile(com.edorasware.commons.core.entity.WorkObjectId id)

Evict the cached file from the corresponding WorkObject.

Parameters:

id - The WorkObjectId to evict

getAcceptableMediaTypes

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

ensureTemporaryDirectory

protected void ensureTemporaryDirectory(String temporaryDirectoryPath)

getDefaultBaseDirectory

protected String getDefaultBaseDirectory()

Returns the default base directory for content providers with a trailing separator.

Returns:

{user.home}/.edoras-one/