org.jodconverter.office.DefaultOfficeManagerBuilder Maven / Gradle / Ivy
Show all versions of jodconverter-local Show documentation
/*
* Copyright 2004 - 2012 Mirko Nasato and contributors
* 2016 - 2020 Simon Braconnier and contributors
*
* This file is part of JODConverter - Java OpenDocument Converter.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jodconverter.office;
import java.io.File;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import org.jodconverter.process.AbstractProcessManager;
import org.jodconverter.process.ProcessManager;
/**
* Builder class for default OfficeManager.
*
* @deprecated Use {@link LocalOfficeManager#builder()} instead.
*/
@Deprecated
public class DefaultOfficeManagerBuilder {
private static final OfficeConnectionProtocol DEFAULT_PROTOCOL = OfficeConnectionProtocol.SOCKET;
// OfficeProcess
private OfficeConnectionProtocol connectionProtocol = DEFAULT_PROTOCOL;
private String[] pipeNames;
private int[] portNumbers;
private File officeHome;
private File workingDir;
private ProcessManager processManager;
private String[] runAsArgs;
private File templateProfileDir;
private boolean killExistingProcess = OfficeProcessConfig.DEFAULT_KILL_EXISTING_PROCESS;
// OfficeProcessManager
private long processTimeout = OfficeProcessManagerConfig.DEFAULT_PROCESS_TIMEOUT;
private long processRetryInterval = OfficeProcessManagerConfig.DEFAULT_PROCESS_RETRY_INTERVAL;
private int maxTasksPerProcess = OfficeProcessManagerConfig.DEFAULT_MAX_TASKS_PER_PROCESS;
// OfficeManagerPoolEntry
private long taskExecutionTimeout = OfficeManagerPoolEntryConfig.DEFAULT_TASK_EXECUTION_TIMEOUT;
// OfficeManagerPool
private long taskQueueTimeout = OfficeManagerPoolConfig.DEFAULT_TASK_QUEUE_TIMEOUT;
/**
* Builds a {@code ProcessPoolOfficeManager} with the current configuration.
*
* @return the created OfficeManager
*/
public OfficeManager build() {
final LocalOfficeManager.Builder builder =
LocalOfficeManager.builder()
.officeHome(officeHome)
.workingDir(workingDir)
.templateProfileDir(templateProfileDir)
.killExistingProcess(killExistingProcess)
.processTimeout(processTimeout)
.processRetryInterval(processRetryInterval)
.maxTasksPerProcess(maxTasksPerProcess)
.taskExecutionTimeout(taskExecutionTimeout)
.taskQueueTimeout(taskQueueTimeout);
if (connectionProtocol == OfficeConnectionProtocol.SOCKET) {
builder.portNumbers(ArrayUtils.isEmpty(portNumbers) ? new int[] {2002} : portNumbers);
} else {
builder.pipeNames(ArrayUtils.isEmpty(pipeNames) ? new String[] {"office"} : pipeNames);
}
if (processManager != null) {
builder.processManager(processManager);
}
if (!ArrayUtils.isEmpty(runAsArgs)) {
builder.runAsArgs(runAsArgs);
}
return builder.build();
}
/**
* Sets the connection protocol.
*
* @param connectionProtocol the new protocol to set.
* @return the updated configuration.
*/
public DefaultOfficeManagerBuilder setConnectionProtocol(
final OfficeConnectionProtocol connectionProtocol) {
Validate.notNull(connectionProtocol);
this.connectionProtocol = connectionProtocol;
return this;
}
//
// OfficeProcess
//
/**
* Specifies the pipe names that will be use to communicate with office. An instance of office
* will be launched for each pipe name.
*
* @param pipeNames The pipe names to use.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setPipeNames(final String... pipeNames) {
Validate.isTrue(
pipeNames != null && pipeNames.length > 0, "The pipe name list must not be empty");
this.pipeNames = ArrayUtils.clone(pipeNames);
return this;
}
/**
* Specifies the port numbers that will be use to communicate with office. An instance of office
* will be launched for each port number.
*
* @param portNumbers The port numbers to use.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setPortNumbers(final int... portNumbers) {
Validate.isTrue(
portNumbers != null && portNumbers.length > 0, "The port number list must not be empty");
this.portNumbers = ArrayUtils.clone(portNumbers);
return this;
}
/**
* Specifies the office home directory (office installation).
*
* @param officeHome The new home directory to set.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setOfficeHome(final File officeHome) {
this.officeHome = officeHome;
return this;
}
/**
* Specifies the office home directory (office installation).
*
* @param officeHome The new home directory to set.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setOfficeHome(final String officeHome) {
return StringUtils.isBlank(officeHome) ? this : setOfficeHome(new File(officeHome));
}
/**
* Provides a specific {@link ProcessManager} implementation to be used when dealing with an
* office process (retrieve PID, kill process).
*
* @param processManager The provided process manager.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setProcessManager(final ProcessManager processManager) {
Validate.notNull(processManager);
this.processManager = processManager;
return this;
}
/**
* Provides a custom {@link ProcessManager} implementation, which may not be included in the
* standard JODConverter distribution.
*
* @param processManagerClass Type of the provided process manager. The class must implement the
* {@code ProcessManager} interface, must be on the classpath (or more specifically accessible
* from the current classloader) and must have a default public constructor (no argument).
* @return This builder instance.
* @see ProcessManager
* @see AbstractProcessManager
*/
public DefaultOfficeManagerBuilder setProcessManager(final String processManagerClass) {
try {
return StringUtils.isBlank(processManagerClass)
? this
: setProcessManager((ProcessManager) Class.forName(processManagerClass).newInstance());
} catch (InstantiationException | IllegalAccessException | ClassNotFoundException ex) {
throw new IllegalArgumentException(
"Unable to create a Process manager from the specified class name: "
+ processManagerClass,
ex);
}
}
/**
* Specifies the sudo arguments that will be used with unix commands.
*
* @param runAsArgs The sudo arguments for a unix os.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setRunAsArgs(final String... runAsArgs) {
Validate.isTrue(
runAsArgs != null && runAsArgs.length > 0, "The runAs argument list must not be empty");
this.runAsArgs = ArrayUtils.clone(runAsArgs);
return this;
}
/**
* Specifies the directory where temporary office profile directories will be created. An office
* profile directory is created per office process launched.
*
* Default: The system temporary directory as specified by the
* java.io.tmpdir system property.
*
* @param workingDir The new working directory to set.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setWorkingDir(final File workingDir) {
this.workingDir = workingDir;
return this;
}
/**
* Specifies the directory where temporary office profile directories will be created. An office
* profile directory is created per office process launched.
*
*
Default: The system temporary directory as specified by the
* java.io.tmpdir system property.
*
* @param workingDir The new working directory to set.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setWorkingDir(final String workingDir) {
return StringUtils.isBlank(workingDir) ? this : setWorkingDir(new File(workingDir));
}
/**
* Specifies the directory to copy to the temporary office profile directories to be created.
*
* @param templateProfileDir The new template profile directory.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setTemplateProfileDir(final File templateProfileDir) {
this.templateProfileDir = templateProfileDir;
return this;
}
/**
* Specifies the directory to copy to the temporary office profile directories to be created.
*
* @param templateProfileDir The new template profile directory.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setTemplateProfileDir(final String templateProfileDir) {
return StringUtils.isBlank(templateProfileDir)
? this
: setTemplateProfileDir(new File(templateProfileDir));
}
/**
* Specifies if an existing office process is killed when starting a new office process for the
* same connection string.
*
*
Default: true
*
* @param killExistingProcess {@code true} to kill existing process when a new process must be
* created with the same connection string, {@code false} otherwise.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setKillExistingProcess(final boolean killExistingProcess) {
this.killExistingProcess = killExistingProcess;
return this;
}
//
// OfficeProcessManager
//
/**
* Specifies the timeout, in milliseconds, when trying to execute an office process call
* (start/terminate).
*
*
Default: 120000 (2 minutes)
*
* @param retryTimeout the process timeout, in milliseconds.
* @return This builder instance.
*/
@Deprecated
public DefaultOfficeManagerBuilder setRetryTimeout(final long retryTimeout) {
Validate.inclusiveBetween(
0,
Long.MAX_VALUE,
retryTimeout,
String.format("The processTimeout %s must be greater than or equal to 0", retryTimeout));
this.processTimeout = retryTimeout;
return this;
}
/**
* Specifies the delay, in milliseconds, between each try when trying to execute an office process
* call (start/terminate).
*
*
Default: 250 (0.25 seconds)
*
* @param retryInterval the retry interval, in milliseconds.
* @return This builder instance.
*/
@Deprecated
public DefaultOfficeManagerBuilder setRetryInterval(final long retryInterval) {
Validate.inclusiveBetween(
OfficeProcessManagerConfig.MIN_PROCESS_RETRY_INTERVAL,
OfficeProcessManagerConfig.MAX_PROCESS_RETRY_INTERVAL,
retryInterval,
String.format(
"The processRetryInterval %s must be in the inclusive range of %s to %s",
retryInterval,
OfficeProcessManagerConfig.MIN_PROCESS_RETRY_INTERVAL,
OfficeProcessManagerConfig.MAX_PROCESS_RETRY_INTERVAL));
this.processRetryInterval = retryInterval;
return this;
}
/**
* Specifies the maximum number of tasks an office process can execute before restarting.
*
*
Default: 200
*
* @param maxTasksPerProcess The new maximum number of tasks an office process can execute.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setMaxTasksPerProcess(final int maxTasksPerProcess) {
Validate.inclusiveBetween(
1,
Integer.MAX_VALUE,
maxTasksPerProcess,
String.format("The maxTasksPerProcess %s greater than 0", maxTasksPerProcess));
this.maxTasksPerProcess = maxTasksPerProcess;
return this;
}
//
// OfficeManagerPoolEntry
//
/**
* Specifies 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.
*
*
Default: 120000 (2 minutes)
*
* @param taskExecutionTimeout The task execution timeout, in milliseconds.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setTaskExecutionTimeout(final long taskExecutionTimeout) {
Validate.inclusiveBetween(
0,
Long.MAX_VALUE,
taskExecutionTimeout,
String.format(
"The taskExecutionTimeout %s must greater than or equal to 0", taskExecutionTimeout));
this.taskExecutionTimeout = taskExecutionTimeout;
return this;
}
//
// OfficeManagerPool
//
/**
* Specifies 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.
*
*
Default: 30000 (30 seconds)
*
* @param taskQueueTimeout The task queue timeout, in milliseconds.
* @return This builder instance.
*/
public DefaultOfficeManagerBuilder setTaskQueueTimeout(final long taskQueueTimeout) {
Validate.inclusiveBetween(
0,
Long.MAX_VALUE,
taskQueueTimeout,
String.format("The taskQueueTimeout %s must greater than or equal to 0", taskQueueTimeout));
this.taskQueueTimeout = taskQueueTimeout;
return this;
}
}