org.jodconverter.local.office

Class LocalOfficeManager.Builder

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<B>

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

taskExecutionTimeout, taskQueueTimeout

Fields inherited from class org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder

install, workingDir

Method Summary

Modifier and Type	Method and Description
@NonNull LocalOfficeManager	build()
@NonNull LocalOfficeManager.Builder	disableOpengl(@Nullable Boolean disableOpengl) Specifies whether OpenGL must be disabled when starting a new office process.
@NonNull LocalOfficeManager.Builder	killExistingProcess(@Nullable Boolean killExistingProcess) Specifies whether an existing office process is killed when starting a new office process for the same connection string.
@NonNull LocalOfficeManager.Builder	maxTasksPerProcess(@Nullable Integer maxTasksPerProcess) Specifies the maximum number of tasks an office process can execute before restarting.
@NonNull LocalOfficeManager.Builder	officeHome(@Nullable File officeHome) Specifies the office home directory (office installation).
@NonNull LocalOfficeManager.Builder	officeHome(@Nullable String officeHome) Specifies the office home directory (office installation).
@NonNull LocalOfficeManager.Builder	pipeNames(String... pipeNames) Specifies the pipe names that will be use to communicate with office.
@NonNull LocalOfficeManager.Builder	portNumbers(int... portNumbers) Specifies the port numbers that will be use 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 String processManagerClass) Provides a custom ProcessManager implementation, which may not be included in the standard JODConverter distribution.
@NonNull LocalOfficeManager.Builder	processRetryInterval(@Nullable 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 Long processTimeout) Specifies the timeout, in milliseconds, when trying to execute an office process call (start/terminate).
@NonNull LocalOfficeManager.Builder	runAsArgs(String... runAsArgs) Specifies the sudo arguments that will be used with unix commands.
@NonNull LocalOfficeManager.Builder	templateProfileDir(@Nullable File templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDir(@Nullable String templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDirOrDefault(@Nullable File templateProfileDir) Specifies the directory to copy to the temporary office profile directories to be created.
@NonNull LocalOfficeManager.Builder	templateProfileDirOrDefault(@Nullable 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

taskExecutionTimeout, taskQueueTimeout

Methods inherited from class org.jodconverter.core.office.AbstractOfficeManager.AbstractOfficeManagerBuilder

install, 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.AbstractOfficeManager.AbstractOfficeManagerBuilder<LocalOfficeManager.Builder>

pipeNames

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

Specifies the pipe names that will be use 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.

portNumbers

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

Specifies the port numbers that will be use 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 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 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 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(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 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 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 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 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.

killExistingProcess

public @NonNull LocalOfficeManager.Builder killExistingProcess(@Nullable Boolean killExistingProcess)

Specifies whether an existing office process is killed when starting a new office process for the same connection string.

Default: true

Parameters:

killExistingProcess - true to kill existing process when a new process must be created with the same connection string, false otherwise.

Returns:

This builder instance.

processTimeout

public @NonNull LocalOfficeManager.Builder processTimeout(@Nullable 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 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.

maxTasksPerProcess

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

Specifies the maximum number of tasks an office process can execute before restarting.

Default: 200

Parameters:

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

Returns:

This builder instance.

disableOpengl

public @NonNull LocalOfficeManager.Builder disableOpengl(@Nullable Boolean disableOpengl)

Specifies whether OpenGL must be disabled when starting a new office process. Nothing will be done if OpenGL is already disabled according to the user profile used with the office process. If the options is changed, then office must be restarted.

Default: false

Parameters:

disableOpengl - true to disable OpenGL, false otherwise.

Returns:

This builder instance.