org.jodconverter.local.office

Class ExternalOfficeManager

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManagerPool<org.jodconverter.local.office.ExternalOfficeManagerPoolEntry>

org.jodconverter.local.office.ExternalOfficeManager

All Implemented Interfaces:

org.jodconverter.core.office.OfficeManager, org.jodconverter.core.office.TemporaryFileMaker

public final class ExternalOfficeManager
extends org.jodconverter.core.office.AbstractOfficeManagerPool<org.jodconverter.local.office.ExternalOfficeManagerPoolEntry>

OfficeManager implementation that uses a pool of external office processes to execute conversion tasks.

The external Office process needs to be started manually, e.g. from the command line with

 soffice -accept="socket,host=127.0.0.1,port=2002;urp;"
 

Since this implementation does not manage the Office process, it does not support auto-restarting the process if it exits unexpectedly.

It will however auto-reconnect to the external process if the latter is manually restarted.

This OfficeManager implementation basically provides the same behavior as JODConverter 2.x, including using synchronized blocks for serializing office operations.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.jodconverter.core.office.AbstractOfficeManagerPool

org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B extends org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>>

Field Summary

Fields inherited from class org.jodconverter.core.office.AbstractOfficeManagerPool

DEFAULT_TASK_EXECUTION_TIMEOUT, DEFAULT_TASK_QUEUE_TIMEOUT

Method Summary

Modifier and Type	Method and Description
static @NonNull ExternalOfficeManager.Builder	builder() Creates a new builder instance.
static @NonNull ExternalOfficeManager	install() Creates a new ExternalOfficeManager with default configuration.
static @NonNull ExternalOfficeManager	make() Creates a new ExternalOfficeManager with default configuration.

Methods inherited from class org.jodconverter.core.office.AbstractOfficeManagerPool

execute, isRunning, makeTemporaryFile, makeTemporaryFile, setEntries, start, stop

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static @NonNull ExternalOfficeManager.Builder builder()

Creates a new builder instance.

Returns:

A new builder instance.

make

public static @NonNull ExternalOfficeManager make()

Creates a new ExternalOfficeManager with default configuration.

Returns:

A ExternalOfficeManager with default configuration.

install

public static @NonNull ExternalOfficeManager install()

Creates a new ExternalOfficeManager with default configuration. The created manager will then be the unique instance of the InstalledOfficeManagerHolder class. Note that if the InstalledOfficeManagerHolder class already holds an OfficeManager instance, the owner of this existing manager is responsible to stopped it.

Returns:

A ExternalOfficeManager with default configuration.