org.jodconverter.core.office

Class AbstractOfficeManagerPool<E extends AbstractOfficeManagerPoolEntry>

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManagerPool<E>

All Implemented Interfaces:

OfficeManager, TemporaryFileMaker

public abstract class AbstractOfficeManagerPool<E extends AbstractOfficeManagerPoolEntry>
extends Object
implements OfficeManager, TemporaryFileMaker

An AbstractOfficeManagerPool is responsible to maintain a pool of AbstractOfficeManagerPoolEntry that will be used to execute OfficeTask. The pool will use the first available AbstractOfficeManagerPoolEntry to execute a given task when the execute(org.jodconverter.core.task.OfficeTask) function is called.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B extends AbstractOfficeManagerPool.AbstractOfficeManagerPoolBuilder<B>> A builder for constructing an AbstractOfficeManagerPool.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_TASK_EXECUTION_TIMEOUT
static long	DEFAULT_TASK_QUEUE_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOfficeManagerPool(int poolSize, @NonNull File workingDir, long taskQueueTimeout) Constructs a new instance of the class with the specified settings.

Method Summary

Modifier and Type	Method and Description
void	execute(@NonNull OfficeTask task) Executes the specified task and blocks until the task terminates.
boolean	isRunning() Gets whether the manager is running.
@NonNull File	makeTemporaryFile() Creates a new temporary file without an extension.
@NonNull File	makeTemporaryFile(@Nullable String extension) Creates a new temporary file with the specified extension.
protected void	setEntries(@NonNull List<E> entries) Sets the manager entries.
void	start() Starts the manager.
void	stop() Stops the manager.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TASK_QUEUE_TIMEOUT

public static final long DEFAULT_TASK_QUEUE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_TASK_EXECUTION_TIMEOUT

public static final long DEFAULT_TASK_EXECUTION_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

AbstractOfficeManagerPool

protected AbstractOfficeManagerPool(int poolSize,
                                    @NonNull File workingDir,
                                    long taskQueueTimeout)

Constructs a new instance of the class with the specified settings.

Parameters:

poolSize - The pool size.

workingDir - The directory where temporary files and directories are created.

taskQueueTimeout - The maximum living time of a task in the conversion queue. The task will be removed from the queue if the waiting time is longer than this timeout.

Method Detail

setEntries

protected void setEntries(@NonNull List<E> entries)

Sets the manager entries.

Parameters:

entries - The entries.

start

public final void start()
                 throws OfficeException

Description copied from interface: OfficeManager

Starts the manager.

Specified by:

start in interface OfficeManager

Throws:

OfficeException - If the manager cannot be started.

stop

public final void stop()
                throws OfficeException

Description copied from interface: OfficeManager

Stops the manager.

Specified by:

stop in interface OfficeManager

Throws:

OfficeException - If the manager cannot be stopped.

isRunning

public final boolean isRunning()

Description copied from interface: OfficeManager

Gets whether the manager is running.

Specified by:

isRunning in interface OfficeManager

Returns:

true if the manager is running, false otherwise.

execute

public final void execute(@NonNull OfficeTask task)
                   throws OfficeException

Description copied from interface: OfficeManager

Executes the specified task and blocks until the task terminates.

Specified by:

execute in interface OfficeManager

Parameters:

task - The task to execute.

Throws:

OfficeException - If an error occurs.

makeTemporaryFile

public @NonNull File makeTemporaryFile()

Description copied from interface: TemporaryFileMaker

Creates a new temporary file without an extension.

Specified by:

makeTemporaryFile in interface TemporaryFileMaker

Returns:

the created file.

makeTemporaryFile

public @NonNull File makeTemporaryFile(@Nullable String extension)

Description copied from interface: TemporaryFileMaker

Creates a new temporary file with the specified extension.

Specified by:

makeTemporaryFile in interface TemporaryFileMaker

Parameters:

extension - the extension of the file to create.

Returns:

the created file.