org.jodconverter.core.office

Class AbstractOfficeManagerPoolEntry

java.lang.Object

org.jodconverter.core.office.AbstractOfficeManagerPoolEntry

All Implemented Interfaces:

OfficeManager

public abstract class AbstractOfficeManagerPoolEntry
extends Object
implements OfficeManager

Base class for all office manager pool entry implementations.

An important note here is to keep in mind that subclasses are responsible to manage the availability of the task executor. This abstract class never set the availability to true. Only when the manager is stopped that the availability is set to false.

See Also:

OfficeManager, AbstractOfficeManagerPool

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOfficeManagerPoolEntry(long taskExecutionTimeout) Initializes a new pool entry with the specified configuration.

Method Summary

Modifier and Type	Method and Description
protected void	cancelTask() Cancels the current running task, if any.
protected abstract void	doExecute(@NonNull OfficeTask task) Performs the execution of a task.
protected abstract void	doStart() Allow subclasses to perform operation when the office manager is started.
protected abstract void	doStop() Allow subclasses to perform operation when the office manager is stopped.
void	execute(@NonNull OfficeTask task) Executes the specified task and blocks until the task terminates.
protected void	handleExecuteTimeoutException(@NonNull TimeoutException timeoutEx) Handles a timeout exception raised while executing a task.
boolean	isRunning() Gets whether the manager is running.
protected void	setAvailable(boolean available) Sets the availability of this manager entry.
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

Constructor Detail

AbstractOfficeManagerPoolEntry

protected AbstractOfficeManagerPoolEntry(long taskExecutionTimeout)

Initializes a new pool entry with the specified configuration.

Parameters:

taskExecutionTimeout - The maximum time allowed to process a task. If the processing time of a task is longer than this timeout, this task will be aborted and the next task is processed.

Method Detail

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.

doExecute

protected abstract void doExecute(@NonNull OfficeTask task)
                           throws OfficeException

Performs the execution of a task.

Parameters:

task - The task to execute.

Throws:

OfficeException - If any errors occurs during the conversion.

handleExecuteTimeoutException

protected void handleExecuteTimeoutException(@NonNull TimeoutException timeoutEx)

Handles a timeout exception raised while executing a task.

Parameters:

timeoutEx - the exception thrown.

isRunning

public 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.

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.

cancelTask

protected void cancelTask()

Cancels the current running task, if any. Do nothing if there is no current running task.

setAvailable

protected void setAvailable(boolean available)

Sets the availability of this manager entry.

Parameters:

available - true if the manager is available to execute tasks, false otherwise.

doStart

protected abstract void doStart()
                         throws OfficeException

Allow subclasses to perform operation when the office manager is started.

Throws:

OfficeException - If an error occurred while starting the manager.

doStop

protected abstract void doStop()
                        throws OfficeException

Allow subclasses to perform operation when the office manager is stopped.

Throws:

OfficeException - If an error occurred while stopping the manager.