org.jodconverter.local.office

Class LocalOfficeManager.Builder

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<LocalOfficeManager.Builder>

org.jodconverter.local.office.LocalOfficeManager.Builder

Enclosing class:

LocalOfficeManager

public static final class LocalOfficeManager.Builder
extends org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<LocalOfficeManager.Builder>

A builder for constructing a LocalOfficeManager.

See Also:

LocalOfficeManager

Field Summary

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

install, taskExecutionTimeout, taskQueueTimeout, workingDir

Method Summary

Modifier and Type	Method and Description
@NonNull LocalOfficeManager.Builder	afterStartProcessDelay(@Nullable java.lang.Long afterStartProcessDelay) Specifies the delay, in milliseconds, after an attempt to start an office process before doing anything else.
@NonNull LocalOfficeManager	build()
@NonNull LocalOfficeManager.Builder	existingProcessAction(@Nullable ExistingProcessAction existingProcessAction) Specifies the action that must be taken when starting a new office process, and there already is an existing running process for the same connection string.
@NonNull LocalOfficeManager.Builder	existingProcessAction(@Nullable java.lang.String existingProcessAction) Specifies the action that must be taken when starting a new office process and there already is an existing running process for the same connection string.
@NonNull LocalOfficeManager.Builder	hostName(java.lang.String hostName) Specifies the host name that will be used in the --accept argument when starting an office process.
@NonNull LocalOfficeManager.Builder	keepAliveOnShutdown(@Nullable java.lang.Boolean keepAliveOnShutdown) Controls whether the manager will keep the office process alive on shutdown.
@NonNull LocalOfficeManager.Builder	maxTasksPerProcess(@Nullable java.lang.Integer maxTasksPerProcess) Specifies the maximum number of tasks an office process can execute before restarting.
@NonNull LocalOfficeManager.Builder	officeHome(@Nullable java.io.File officeHome) Specifies the office home directory (office installation).
@NonNull LocalOfficeManager.Builder	officeHome(@Nullable java.lang.String officeHome) Specifies the office home directory (office installation).
@NonNull LocalOfficeManager.Builder	pipeNames(java.lang.String... pipeNames) Specifies the pipe names that will be used to communicate with office.
@NonNull LocalOfficeManager.Builder	portNumbers(int... portNumbers) Specifies the port numbers that will be used to communicate with office.
@NonNull LocalOfficeManager.Builder	processManager(@Nullable ProcessManager processManager) Provides a specific ProcessManager implementation to be used when dealing with an office process (retrieve PID, kill process).
@NonNull LocalOfficeManager.Builder	processManager(@Nullable java.lang.String processManagerClass) Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.
@NonNull LocalOfficeManager.Builder	processRetryInterval(@Nullable java.lang.Long processRetryInterval) Specifies the delay, in milliseconds, between each try when trying to execute an office process call (start/terminate).
@NonNull LocalOfficeManager.Builder	processTimeout(@Nullable java.lang.Long processTimeout) Specifies the timeout, in milliseconds, when trying to execute an office process call (start/terminate).
@NonNull LocalOfficeManager.Builder	runAsArgs(java.lang.String... runAsArgs) Specifies the sudo arguments that will be used with unix commands.
@NonNull LocalOfficeManager.Builder	startFailFast(@Nullable java.lang.Boolean startFailFast) Controls whether the manager will "fail fast" if an office process cannot be started or the connection to the started process fails.
@NonNull LocalOfficeManager.Builder	templateProfileDir(@Nullable java.io.File templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDir(@Nullable java.lang.String templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDirOrDefault(@Nullable java.io.File templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDirOrDefault(@Nullable java.lang.String templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.

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

install, taskExecutionTimeout, taskQueueTimeout, workingDir, workingDir

Methods inherited from class java.lang.Object

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

Method Detail

build

public @NonNull LocalOfficeManager build()

Specified by:

build in class org.jodconverter.core.office.AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<LocalOfficeManager.Builder>

pipeNames

public @NonNull LocalOfficeManager.Builder pipeNames(java.lang.String... pipeNames)

Specifies the pipe names that will be used to communicate with office. An instance of office will be launched for each pipe name.

Parameters:

pipeNames - The pipe names to use.

Returns:

This builder instance.

hostName

public @NonNull LocalOfficeManager.Builder hostName(java.lang.String hostName)

Specifies the host name that will be used in the --accept argument when starting an office process. Most of the time, the default will work. But if it doesn't work (unable to connect to the started process), using localhost instead may work.

Default: 127.0.0.1

Parameters:

hostName - The host name to use.

Returns:

This builder instance.

portNumbers

public @NonNull LocalOfficeManager.Builder portNumbers(int... portNumbers)

Specifies the port numbers that will be used to communicate with office. An instance of office will be launched for each port number.

Parameters:

portNumbers - The port numbers to use.

Returns:

This builder instance.

officeHome

public @NonNull LocalOfficeManager.Builder officeHome(@Nullable java.io.File officeHome)

Specifies the office home directory (office installation).

Parameters:

officeHome - The new home directory to set.

Returns:

This builder instance.

officeHome

public @NonNull LocalOfficeManager.Builder officeHome(@Nullable java.lang.String officeHome)

Specifies the office home directory (office installation).

Parameters:

officeHome - The new home directory to set.

Returns:

This builder instance.

processManager

public @NonNull LocalOfficeManager.Builder processManager(@Nullable ProcessManager processManager)

Provides a specific ProcessManager implementation to be used when dealing with an office process (retrieve PID, kill process).

Parameters:

processManager - The provided process manager.

Returns:

This builder instance.

processManager

public @NonNull LocalOfficeManager.Builder processManager(@Nullable java.lang.String processManagerClass)

Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.

Parameters:

processManagerClass - Type of the provided process manager. The class must implement the ProcessManager interface, must be on the classpath (or more specifically accessible from the current classloader) and must have a default public constructor (no argument).

Returns:

This builder instance.

See Also:

ProcessManager, AbstractProcessManager

runAsArgs

public @NonNull LocalOfficeManager.Builder runAsArgs(java.lang.String... runAsArgs)

Specifies the sudo arguments that will be used with unix commands.

Parameters:

runAsArgs - The sudo arguments for a unix os.

Returns:

This builder instance.

templateProfileDir

public @NonNull LocalOfficeManager.Builder templateProfileDir(@Nullable java.io.File templateProfileDir)

Specifies the directory to copy to the temporary office profile directories to be created.

Parameters:

templateProfileDir - The new template profile directory.

Returns:

This builder instance.

templateProfileDir

public @NonNull LocalOfficeManager.Builder templateProfileDir(@Nullable java.lang.String templateProfileDir)

Specifies the directory to copy to the temporary office profile directories to be created.

Parameters:

templateProfileDir - The new template profile directory.

Returns:

This builder instance.

templateProfileDirOrDefault

public @NonNull LocalOfficeManager.Builder templateProfileDirOrDefault(@Nullable java.io.File templateProfileDir)

Specifies the directory to copy to the temporary office profile directories to be created. If the given templateProfileDir is not valid, it will be ignored and the default behavior will be applied.

Parameters:

templateProfileDir - The new template profile directory.

Returns:

This builder instance.

templateProfileDirOrDefault

public @NonNull LocalOfficeManager.Builder templateProfileDirOrDefault(@Nullable java.lang.String templateProfileDir)

Specifies the directory to copy to the temporary office profile directories to be created. If the given templateProfileDir is not valid, it will be ignored and the default behavior will be applied.

Parameters:

templateProfileDir - The new template profile directory.

Returns:

This builder instance.

processTimeout

public @NonNull LocalOfficeManager.Builder processTimeout(@Nullable java.lang.Long processTimeout)

Specifies the timeout, in milliseconds, when trying to execute an office process call (start/terminate).

Default: 120000 (2 minutes)

Parameters:

processTimeout - The process timeout, in milliseconds.

Returns:

This builder instance.

processRetryInterval

public @NonNull LocalOfficeManager.Builder processRetryInterval(@Nullable java.lang.Long processRetryInterval)

Specifies the delay, in milliseconds, between each try when trying to execute an office process call (start/terminate).

Default: 250 (0.25 seconds)

Parameters:

processRetryInterval - The retry interval, in milliseconds.

Returns:

This builder instance.

afterStartProcessDelay

public @NonNull LocalOfficeManager.Builder afterStartProcessDelay(@Nullable java.lang.Long afterStartProcessDelay)

Specifies the delay, in milliseconds, after an attempt to start an office process before doing anything else. It is required on some OS to avoid an attempt to connect to the started process that will hang for more than 5 minutes before throwing a timeout exception, we do not know why.

Default: 0 (no delay). On FreeBSD, which is a known OS needing this, it defaults to 2000 (2 seconds).

Parameters:

afterStartProcessDelay - The delay, in milliseconds.

Returns:

This builder instance.

existingProcessAction

public @NonNull LocalOfficeManager.Builder existingProcessAction(@Nullable ExistingProcessAction existingProcessAction)

Specifies the action that must be taken when starting a new office process, and there already is an existing running process for the same connection string.

Default: ExistingProcessAction.KILL

Parameters:

existingProcessAction - The existing process action.

Returns:

This builder instance.

existingProcessAction

public @NonNull LocalOfficeManager.Builder existingProcessAction(@Nullable java.lang.String existingProcessAction)

Specifies the action that must be taken when starting a new office process and there already is an existing running process for the same connection string.

Default: ExistingProcessAction.KILL

Parameters:

existingProcessAction - The existing process action.

Returns:

This builder instance.

startFailFast

public @NonNull LocalOfficeManager.Builder startFailFast(@Nullable java.lang.Boolean startFailFast)

Controls whether the manager will "fail fast" if an office process cannot be started or the connection to the started process fails. If set to true, the start of a process will wait for the task to be completed, and will throw an exception if the office process is not started successfully or if the connection to the started process fails. If set to false, the task of starting the process and connecting to it will be submitted and will return immediately, meaning a faster starting process. Only error logs will be produced if anything goes wrong.

Default: false

Parameters:

startFailFast - true to "fail fast", false otherwise.

Returns:

This builder instance.

keepAliveOnShutdown

public @NonNull LocalOfficeManager.Builder keepAliveOnShutdown(@Nullable java.lang.Boolean keepAliveOnShutdown)

Controls whether the manager will keep the office process alive on shutdown. If set to true, the stop task will only disconnect from the office process, which will stay alive. If set to false, the office process will be stopped gracefully (or killed if could not been stopped gracefully).

Default: false

Parameters:

keepAliveOnShutdown - true to keep the process alive, false otherwise.

Returns:

This builder instance.

maxTasksPerProcess

public @NonNull LocalOfficeManager.Builder maxTasksPerProcess(@Nullable java.lang.Integer maxTasksPerProcess)

Specifies the maximum number of tasks an office process can execute before restarting. 0 means an infinite number of tasks (will never restart).

Default: 200

Parameters:

maxTasksPerProcess - The new maximum number of tasks an office process can execute.

Returns:

This builder instance.