org.jodconverter.local.office

Class ExternalOfficeManager.Builder

java.lang.Object

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

org.jodconverter.local.office.ExternalOfficeManager.Builder

Enclosing class:

ExternalOfficeManager

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

A builder for constructing a ExternalOfficeManager.

See Also:

ExternalOfficeManager

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 ExternalOfficeManager	build()
@NonNull ExternalOfficeManager.Builder	connectFailFast(@Nullable Boolean connectFailFast) Controls whether the manager will "fail fast" if the connection to the external process fails.
@NonNull ExternalOfficeManager.Builder	connectOnStart(@Nullable Boolean connectOnStart) Specifies whether a connection must be attempted on AbstractOfficeManagerPool.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.
@NonNull ExternalOfficeManager.Builder	connectRetryInterval(@Nullable Long connectRetryInterval) Specifies the delay, in milliseconds, between each try when trying to connect to office.
@NonNull ExternalOfficeManager.Builder	connectTimeout(@Nullable Long connectTimeout) Specifies the timeout, in milliseconds, after which a connection attempt will fail.
@NonNull ExternalOfficeManager.Builder	hostName(String hostName) Specifies host name that will be used to communicate with office.
@NonNull ExternalOfficeManager.Builder	maxTasksPerConnection(@Nullable Integer maxTasksPerConnection) Specifies the maximum number of tasks an office process can execute before reconnecting to it.
@NonNull ExternalOfficeManager.Builder	pipeNames(String... pipeNames) Specifies the pipe names that will be used to communicate with office.
@NonNull ExternalOfficeManager.Builder	portNumbers(int... portNumbers) Specifies the port numbers that will be used to communicate with office.

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 ExternalOfficeManager build()

Specified by:

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

pipeNames

public @NonNull ExternalOfficeManager.Builder pipeNames(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 ExternalOfficeManager.Builder hostName(String hostName)

Specifies host name that will be used to communicate with office.

Parameters:

hostName - The host name to use.

Returns:

This builder instance.

portNumbers

public @NonNull ExternalOfficeManager.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.

connectOnStart

public @NonNull ExternalOfficeManager.Builder connectOnStart(@Nullable Boolean connectOnStart)

Specifies whether a connection must be attempted on AbstractOfficeManagerPool.start()? If false, a connection will only be attempted the first time an OfficeTask is executed.

Default: true

Parameters:

connectOnStart - true to connect on start, false otherwise.

Returns:

This builder instance.

connectTimeout

public @NonNull ExternalOfficeManager.Builder connectTimeout(@Nullable Long connectTimeout)

Specifies the timeout, in milliseconds, after which a connection attempt will fail.

Default: 120000 (2 minutes)

Parameters:

connectTimeout - the process timeout, in milliseconds.

Returns:

This builder instance.

connectRetryInterval

public @NonNull ExternalOfficeManager.Builder connectRetryInterval(@Nullable Long connectRetryInterval)

Specifies the delay, in milliseconds, between each try when trying to connect to office.

Default: 250 (0.25 seconds)

Parameters:

connectRetryInterval - the connection retry interval, in milliseconds.

Returns:

This builder instance.

connectFailFast

public @NonNull ExternalOfficeManager.Builder connectFailFast(@Nullable Boolean connectFailFast)

Controls whether the manager will "fail fast" if the connection to the external process fails. If set to true, a connection attempt will wait for the task to be completed, and will throw an exception if the connection to the external process fails. If set to false, the task of connecting to the external process will be submitted and will return immediately, meaning a faster connecting process. Only error logs will be produced if anything goes wrong.

Default: false

Parameters:

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

Returns:

This builder instance.

maxTasksPerConnection

public @NonNull ExternalOfficeManager.Builder maxTasksPerConnection(@Nullable Integer maxTasksPerConnection)

Specifies the maximum number of tasks an office process can execute before reconnecting to it. 0 means infinite number of task (will never reconnect).

Default: 1000

Parameters:

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

Returns:

This builder instance.