com.edorasware.cloud.core.conversion

Interface DocumentContentConverterService

public interface DocumentContentConverterService

Provides content conversion support for documents.

Method Summary

Modifier and Type	Method and Description
void	evictCachedFile(com.edorasware.commons.core.entity.GlobalId globalId) Evicts cached file for the given document work object reference
Set<com.google.common.net.MediaType>	getAcceptableMediaTypes() Returns set of supported media types, which is converter able to convert
InputStream	getConvertedContent(com.edorasware.commons.core.entity.GlobalId documentGlobalId) Returns converted content for a given document work object.
com.edorasware.commons.core.content.ContentMetadata	getConvertedContentMetadata(com.edorasware.commons.core.entity.GlobalId documentGlobalId) Returns converted ContentMetadata for the given document work object reference
com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,InputStream>	getConvertedContentMetadataAndInputStream(com.edorasware.commons.core.entity.GlobalId documentGlobalId) Returns converted content and metadata for the given document work object reference
com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,InputStream>	getConvertedContentMetadataAndInputStream(com.edorasware.commons.core.entity.WorkObjectId documentWorkObjectId) Returns converted content and metadata for the given document work object reference
com.edorasware.commons.core.content.ContentReference	getConvertedContentReference(com.edorasware.commons.core.any.AnyWorkObjectId documentWorkObjectId) Returns converted ContentReference for the given document work object reference
boolean	isConvertible(com.edorasware.commons.core.entity.WorkObject<?,?,?> workObject) Is given workObject convertible by this service
void	shutdown() Cleans up all temporary resources

Method Detail

getConvertedContent

InputStream getConvertedContent(com.edorasware.commons.core.entity.GlobalId documentGlobalId)

Returns converted content for a given document work object.

Parameters:

documentGlobalId - the document global ID

Returns:

converted content input stream

getConvertedContentMetadataAndInputStream

com.edorasware.commons.core.util.fp.Pair<com.edorasware.commons.core.content.ContentMetadata,InputStream> getConvertedContentMetadataAndInputStream(com.edorasware.commons.core.entity.GlobalId documentGlobalId)

Returns converted content and metadata for the given document work object reference

Parameters:

documentGlobalId - document identifier

Returns:

Pair of ContentMetadata and converted content InputStream

getConvertedContentMetadataAndInputStream

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

Returns converted content and metadata for the given document work object reference

Parameters:

documentWorkObjectId - document identifier

Returns:

Pair of ContentMetadata and converted content InputStream

getConvertedContentReference

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

Returns converted ContentReference for the given document work object reference

Parameters:

documentWorkObjectId - document identifier

Returns:

ContentReference

getConvertedContentMetadata

com.edorasware.commons.core.content.ContentMetadata getConvertedContentMetadata(com.edorasware.commons.core.entity.GlobalId documentGlobalId)

Returns converted ContentMetadata for the given document work object reference

Parameters:

documentGlobalId - object identifier

Returns:

converted ContentMetadata

isConvertible

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

Is given workObject convertible by this service

Parameters:

workObject - to convert

Returns:

true if object is convertible, false otherwise

shutdown

void shutdown()

Cleans up all temporary resources

evictCachedFile

void evictCachedFile(com.edorasware.commons.core.entity.GlobalId globalId)

Evicts cached file for the given document work object reference

Parameters:

globalId - object identifier for which cache is evicted

getAcceptableMediaTypes

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

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

Returns:

set of supported MediaType