com.documents4j.job

Class LocalConverter

java.lang.Object

com.documents4j.job.ConverterAdapter

com.documents4j.job.LocalConverter

All Implemented Interfaces:

IConverter

public class LocalConverter
extends ConverterAdapter

A converter that relies on an external converter such as an MS Office component on the local machine. A LocalConverter delegates its conversions to a IExternalConverter. Such converters must be registered manually as long as they are shipped with documents4j where they are discovered on the class path.

Important: There should only exist one LocalConverter per physical machine! This instance needs to communicate with external applications via command line and needs to shut down and start up applications. This cannot be done in a safely manner without introducing a major latency. It is therefore the responsibility of the application developer to only run this program once per physical machine. It should be made explicit: It is not enough to create a singleton instance per JVM a LocalConverter on another JVM would share external application state.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalConverter.Builder A builder for constructing a LocalConverter.

Field Summary

Fields inherited from class com.documents4j.job.ConverterAdapter

DEFAULT_CLOSE_STREAM

Fields inherited from interface com.documents4j.api.IConverter

JOB_PRIORITY_HIGH, JOB_PRIORITY_LOW, JOB_PRIORITY_NORMAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalConverter(File baseFolder, int corePoolSize, int maximumPoolSize, long keepAliveTime, long processTimeout, TimeUnit processTimeoutUnit, Map<Class<? extends IExternalConverter>,Boolean> converterConfiguration)

Method Summary

Modifier and Type	Method and Description
static LocalConverter.Builder	builder() Creates a new builder instance.
IConversionJobWithSourceUnspecified	convert(IFileSource source)
Map<DocumentType,Set<DocumentType>>	getSupportedConversions()
boolean	isOperational()
void	kill()
static IConverter	make() Creates a new LocalConverter with default configuration.
protected IConversionManager	makeConversionManager(File baseFolder, long processTimeout, TimeUnit unit, Map<Class<? extends IExternalConverter>,Boolean> converterConfiguration)
void	shutDown()

Methods inherited from class com.documents4j.job.ConverterAdapter

convert, convert, convert, convert, deregisterShutdownHook, getTempFileFolder, makeExecutorService, makeTemporaryFile, makeTemporaryFile, registerShutdownHook

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalConverter

protected LocalConverter(File baseFolder,
                         int corePoolSize,
                         int maximumPoolSize,
                         long keepAliveTime,
                         long processTimeout,
                         TimeUnit processTimeoutUnit,
                         Map<Class<? extends IExternalConverter>,Boolean> converterConfiguration)

Method Detail

builder

public static LocalConverter.Builder builder()

Creates a new builder instance.

Returns:

A new builder instance.

make

public static IConverter make()

Creates a new LocalConverter with default configuration.

Returns:

A LocalConverter with default configuration.

makeConversionManager

protected IConversionManager makeConversionManager(File baseFolder,
                                                   long processTimeout,
                                                   TimeUnit unit,
                                                   Map<Class<? extends IExternalConverter>,Boolean> converterConfiguration)

getSupportedConversions

public Map<DocumentType,Set<DocumentType>> getSupportedConversions()

convert

public IConversionJobWithSourceUnspecified convert(IFileSource source)

Specified by:

convert in interface IConverter

Overrides:

convert in class ConverterAdapter

isOperational

public boolean isOperational()

shutDown

public void shutDown()

Specified by:

shutDown in interface IConverter

Overrides:

shutDown in class ConverterAdapter

kill

public void kill()

Specified by:

kill in interface IConverter

Overrides:

kill in class ConverterAdapter