org.jahia.services.transform

Class DocumentConverterService

java.lang.Object

org.jahia.services.transform.DocumentConverterService

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class DocumentConverterService
extends Object
implements org.springframework.context.ApplicationContextAware

Document transformation service that uses OpenOffice for file conversion.

Author:

Fabrice Cantegrel, Sergiy Shyrkov

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,Object>	DEF_PROPS

Constructor Summary

Constructors

Constructor and Description
DocumentConverterService()

Method Summary

Modifier and Type	Method and Description
void	convert(File inputFile, org.artofsolving.jodconverter.document.DocumentFormat inputFormat, File outputFile, org.artofsolving.jodconverter.document.DocumentFormat outputFormat) Converts the provided input file into output, considering provided document formats.
void	convert(File inputFile, File outputFile) Converts the provided input file into output automatically detecting file mime-type by is extension.
File	convert(File inputFile, String inputFileMimeType, String outputMimeType) Converts the provided file, considering provided mime-types.
void	convert(InputStream inputStream, String inputMimeType, OutputStream outputStream, String outputMimeType) Converts the provided input stream into output, considering provided mime-types.
protected File	createTempFile()
protected org.artofsolving.jodconverter.office.OfficeTask	getConversionTask(File inputFile, org.artofsolving.jodconverter.document.DocumentFormat inputFormat, File outputFile, org.artofsolving.jodconverter.document.DocumentFormat outputFormat) Converts the provided input file into output, considering provided document formats.
String	getExtension(String mimeType)
org.artofsolving.jodconverter.document.DocumentFormat	getFormat(File file) Returns the DocumentFormat based of the extension of the specified file.
org.artofsolving.jodconverter.document.DocumentFormat	getFormatByFileName(String fileName) Returns the DocumentFormat based on the extension extracted from the file name of the specified file.
org.artofsolving.jodconverter.document.DocumentFormat	getFormatByMimeType(String mimeType) Returns the DocumentFormat based on the mimeType of the specified file.
String	getMimeType(String extension)
boolean	isEnabled()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDefaultLoadProperties(Map<String,?> defaultLoadProperties)
void	setEnabled(boolean enabled)
void	setFormatRegistry(org.artofsolving.jodconverter.document.DocumentFormatRegistry formatRegistry) Initializes an instance of the document format registry.
void	setOfficeManagerBeanName(String officeManagerBeanName)
void	start() Initializes the service and starts office manager.
void	stop() Shuts down the office manager.
protected void	writeToOutputStream(OutputStream os, File file)

Methods inherited from class java.lang.Object

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

Field Detail

DEF_PROPS

protected static final Map<String,Object> DEF_PROPS

Constructor Detail

DocumentConverterService

public DocumentConverterService()

Method Detail

convert

public void convert(File inputFile,
                    org.artofsolving.jodconverter.document.DocumentFormat inputFormat,
                    File outputFile,
                    org.artofsolving.jodconverter.document.DocumentFormat outputFormat)
             throws org.artofsolving.jodconverter.office.OfficeException

Converts the provided input file into output, considering provided document formats.

Parameters:

inputFile - the source file

inputFormat - description of the source file

outputFile - the output file descriptor to store converted content into

outputFormat - description of the output file

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of a conversion error

convert

public void convert(File inputFile,
                    File outputFile)
             throws org.artofsolving.jodconverter.office.OfficeException

Converts the provided input file into output automatically detecting file mime-type by is extension.

Parameters:

inputFile - the source file

outputFile - the output file descriptor to store converted content into

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of a conversion error

convert

public void convert(InputStream inputStream,
                    String inputMimeType,
                    OutputStream outputStream,
                    String outputMimeType)
             throws org.artofsolving.jodconverter.office.OfficeException

Converts the provided input stream into output, considering provided mime-types.

Parameters:

inputStream - the source stream

inputMimeType - the input MIME type

outputStream - the destination stream

outputMimeType - the output MIME type

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of a conversion error

convert

public File convert(File inputFile,
                    String inputFileMimeType,
                    String outputMimeType)
             throws IOException,
                    org.artofsolving.jodconverter.office.OfficeException

Converts the provided file, considering provided mime-types.

Parameters:

inputFile - the source File

inputFileMimeType - the source file content type

outputMimeType - the output MIME type

Returns:

A File, which is inputFile converted into a mimeType defined by outputMimeType

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of a conversion error

IOException

createTempFile

protected File createTempFile()
                       throws IOException

Throws:

IOException

getMimeType

public String getMimeType(String extension)

getExtension

public String getExtension(String mimeType)

writeToOutputStream

protected void writeToOutputStream(OutputStream os,
                                   File file)

Parameters:

os - The outputStream to write into

file - The file to read from

getConversionTask

protected org.artofsolving.jodconverter.office.OfficeTask getConversionTask(File inputFile,
                                                                            org.artofsolving.jodconverter.document.DocumentFormat inputFormat,
                                                                            File outputFile,
                                                                            org.artofsolving.jodconverter.document.DocumentFormat outputFormat)

Converts the provided input file into output, considering provided document formats.

Parameters:

inputFile - the source file

inputFormat - description of the source file

outputFile - the output file descriptor to store converted content into

outputFormat - description of the output file

getFormat

public org.artofsolving.jodconverter.document.DocumentFormat getFormat(File file)

Returns the DocumentFormat based of the extension of the specified file.

Parameters:

file - the file to detect format for

Returns:

the DocumentFormat based of the extension of the specified file

getFormatByMimeType

public org.artofsolving.jodconverter.document.DocumentFormat getFormatByMimeType(String mimeType)

Returns the DocumentFormat based on the mimeType of the specified file.

Parameters:

mimeType - the mimeType to detect format for

Returns:

the DocumentFormat based on a mimeType

getFormatByFileName

public org.artofsolving.jodconverter.document.DocumentFormat getFormatByFileName(String fileName)

Returns the DocumentFormat based on the extension extracted from the file name of the specified file.

Parameters:

fileName - the file name to detect format for

Returns:

the DocumentFormat based on a mimeType

isEnabled

public boolean isEnabled()

Returns:

the enabled

setDefaultLoadProperties

public void setDefaultLoadProperties(Map<String,?> defaultLoadProperties)

Parameters:

defaultLoadProperties - the defaultLoadProperties to set

setEnabled

public void setEnabled(boolean enabled)

Parameters:

enabled - the enabled to set

setFormatRegistry

public void setFormatRegistry(org.artofsolving.jodconverter.document.DocumentFormatRegistry formatRegistry)

Initializes an instance of the document format registry.

Parameters:

formatRegistry - an instance of the document format registry

start

public void start()
           throws org.artofsolving.jodconverter.office.OfficeException

Initializes the service and starts office manager.

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of an initialization error

stop

public void stop()
          throws org.artofsolving.jodconverter.office.OfficeException

Shuts down the office manager.

Throws:

org.artofsolving.jodconverter.office.OfficeException - in case of a shutdown error

setOfficeManagerBeanName

public void setOfficeManagerBeanName(String officeManagerBeanName)

Parameters:

officeManagerBeanName - the officeManagerBeanName to set

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException