org.artofsolving.jodconverter.office
Class DefaultOfficeManagerConfiguration

java.lang.Object
  extended by org.artofsolving.jodconverter.office.DefaultOfficeManagerConfiguration

public class DefaultOfficeManagerConfiguration
extends Object


Field Summary
static long DEFAULT_RETRY_TIMEOUT
           
 
Constructor Summary
DefaultOfficeManagerConfiguration()
           
 
Method Summary
 OfficeManager buildOfficeManager()
           
 DefaultOfficeManagerConfiguration setConnectionProtocol(OfficeConnectionProtocol connectionProtocol)
           
 DefaultOfficeManagerConfiguration setMaxTasksPerProcess(int maxTasksPerProcess)
           
 DefaultOfficeManagerConfiguration setOfficeHome(File officeHome)
           
 DefaultOfficeManagerConfiguration setOfficeHome(String officeHome)
           
 DefaultOfficeManagerConfiguration setPipeName(String pipeName)
           
 DefaultOfficeManagerConfiguration setPipeNames(String... pipeNames)
           
 DefaultOfficeManagerConfiguration setPortNumber(int portNumber)
           
 DefaultOfficeManagerConfiguration setPortNumbers(int... portNumbers)
           
 DefaultOfficeManagerConfiguration setProcessManager(ProcessManager processManager)
          Provide a specific ProcessManager implementation
 DefaultOfficeManagerConfiguration setRetryTimeout(long retryTimeout)
          Retry timeout set in milliseconds.
 DefaultOfficeManagerConfiguration setRunAsArgs(String... runAsArgs)
           
 DefaultOfficeManagerConfiguration setTaskExecutionTimeout(long taskExecutionTimeout)
           
 DefaultOfficeManagerConfiguration setTaskQueueTimeout(long taskQueueTimeout)
           
 DefaultOfficeManagerConfiguration setTemplateProfileDir(File templateProfileDir)
           
 DefaultOfficeManagerConfiguration setWorkDir(File workDir)
          Sets the directory where temporary office profiles will be created.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_RETRY_TIMEOUT

public static final long DEFAULT_RETRY_TIMEOUT
See Also:
Constant Field Values
Constructor Detail

DefaultOfficeManagerConfiguration

public DefaultOfficeManagerConfiguration()
Method Detail

setOfficeHome

public DefaultOfficeManagerConfiguration setOfficeHome(String officeHome)
                                                throws NullPointerException,
                                                       IllegalArgumentException
Throws:
NullPointerException
IllegalArgumentException

setOfficeHome

public DefaultOfficeManagerConfiguration setOfficeHome(File officeHome)
                                                throws NullPointerException,
                                                       IllegalArgumentException
Throws:
NullPointerException
IllegalArgumentException

setConnectionProtocol

public DefaultOfficeManagerConfiguration setConnectionProtocol(OfficeConnectionProtocol connectionProtocol)
                                                        throws NullPointerException
Throws:
NullPointerException

setPortNumber

public DefaultOfficeManagerConfiguration setPortNumber(int portNumber)

setPortNumbers

public DefaultOfficeManagerConfiguration setPortNumbers(int... portNumbers)
                                                 throws NullPointerException,
                                                        IllegalArgumentException
Throws:
NullPointerException
IllegalArgumentException

setPipeName

public DefaultOfficeManagerConfiguration setPipeName(String pipeName)
                                              throws NullPointerException
Throws:
NullPointerException

setPipeNames

public DefaultOfficeManagerConfiguration setPipeNames(String... pipeNames)
                                               throws NullPointerException,
                                                      IllegalArgumentException
Throws:
NullPointerException
IllegalArgumentException

setRunAsArgs

public DefaultOfficeManagerConfiguration setRunAsArgs(String... runAsArgs)

setTemplateProfileDir

public DefaultOfficeManagerConfiguration setTemplateProfileDir(File templateProfileDir)
                                                        throws IllegalArgumentException
Throws:
IllegalArgumentException

setWorkDir

public DefaultOfficeManagerConfiguration setWorkDir(File workDir)
Sets the directory where temporary office profiles will be created.

Defaults to the system temporary directory as specified by the java.io.tmpdir system property.

Parameters:
workDir -
Returns:

setTaskQueueTimeout

public DefaultOfficeManagerConfiguration setTaskQueueTimeout(long taskQueueTimeout)

setTaskExecutionTimeout

public DefaultOfficeManagerConfiguration setTaskExecutionTimeout(long taskExecutionTimeout)

setMaxTasksPerProcess

public DefaultOfficeManagerConfiguration setMaxTasksPerProcess(int maxTasksPerProcess)

setProcessManager

public DefaultOfficeManagerConfiguration setProcessManager(ProcessManager processManager)
                                                    throws NullPointerException
Provide a specific ProcessManager implementation

The default is to use SigarProcessManager if sigar.jar is available in the classpath, otherwise LinuxProcessManager on Linux and PureJavaProcessManager on other platforms.

Parameters:
processManager -
Returns:
Throws:
NullPointerException

setRetryTimeout

public DefaultOfficeManagerConfiguration setRetryTimeout(long retryTimeout)
Retry timeout set in milliseconds. Used for retrying office process calls. If not set, it defaults to 2 minutes

Parameters:
retryTimeout - in milliseconds
Returns:

buildOfficeManager

public OfficeManager buildOfficeManager()
                                 throws IllegalStateException
Throws:
IllegalStateException


Copyright © 2003-2011. All Rights Reserved.