ExternalOfficeManager (jodconverter-local 4.2.4 API)

java.lang.Object
- org.jodconverter.office.ExternalOfficeManager

All Implemented Interfaces:

org.jodconverter.office.OfficeManager, org.jodconverter.office.TemporaryFileMaker
```
public final class ExternalOfficeManager
extends Object
```
OfficeManager implementation that connects to an external Office process.
The external Office process needs to be started manually, e.g. from the command line with
```
 soffice -accept="socket,host=127.0.0.1,port=2002;urp;"
 
```
Since this implementation does not manage the Office process, it does not support auto-restarting the process if it exits unexpectedly.
It will however auto-reconnect to the external process if the latter is manually restarted.
This OfficeManager implementation basically provides the same behavior as JODConverter 2.x, including using synchronized blocks for serializing office operations.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`org.jodconverter.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<B extends org.jodconverter.office.AbstractOfficeManager.AbstractOfficeManagerBuilder<B>>`
`static class`	`ExternalOfficeManager.Builder` A builder for constructing a `ExternalOfficeManager`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.jodconverter.office.OfficeManagerConfig`	`config`
`static long`	`DEFAULT_CONNECT_TIMEOUT` The default timeout when connecting to office.
`static long`	`DEFAULT_INITIAL_DELAY` The default initial delay when connecting to office.
`static String`	`DEFAULT_PIPE_NAME` The default pipe name to connect to office.
`static int`	`DEFAULT_PORT_NUMBER` The default port number to connect to office.
`static long`	`DEFAULT_RETRY_INTERVAL` The default delay between each try to connect.
`static long`	`MAX_RETRY_INTERVAL` The maximum value for the delay between each try to connect.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ExternalOfficeManager.Builder`	`builder()` Creates a new builder instance.
`protected void`	`deleteTempDir()`
`void`	`execute(org.jodconverter.task.OfficeTask task)`
`static ExternalOfficeManager`	`install()` Creates a new `ExternalOfficeManager` with default configuration.
`boolean`	`isRunning()`
`static ExternalOfficeManager`	`make()` Creates a new `ExternalOfficeManager` with default configuration.
`protected void`	`makeTempDir()`
`protected static File`	`makeTempDir(File arg0)`
`File`	`makeTemporaryFile()`
`File`	`makeTemporaryFile(String arg0)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_PORT_NUMBER
```
public static final int DEFAULT_PORT_NUMBER
```
    The default port number to connect to office.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PIPE_NAME
```
public static final String DEFAULT_PIPE_NAME
```
    The default pipe name to connect to office.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIAL_DELAY
```
public static final long DEFAULT_INITIAL_DELAY
```
    The default initial delay when connecting to office.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CONNECT_TIMEOUT
```
public static final long DEFAULT_CONNECT_TIMEOUT
```
    The default timeout when connecting to office.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RETRY_INTERVAL
```
public static final long DEFAULT_RETRY_INTERVAL
```
    The default delay between each try to connect.
    
    See Also:
    
    Constant Field Values
  - MAX_RETRY_INTERVAL
```
public static final long MAX_RETRY_INTERVAL
```
    The maximum value for the delay between each try to connect.
    
    See Also:
    
    Constant Field Values
  - config
```
protected final org.jodconverter.office.OfficeManagerConfig config
```
- Method Detail
  - builder
```
public static ExternalOfficeManager.Builder builder()
```
    Creates a new builder instance.
    
    Returns:
    
    A new builder instance.
  - make
```
public static ExternalOfficeManager make()
```
    Creates a new ExternalOfficeManager with default configuration.
    
    Returns:
    
    A ExternalOfficeManager with default configuration.
  - install
```
public static ExternalOfficeManager install()
```
    Creates a new ExternalOfficeManager with default configuration. The created manager will then be the unique instance of the InstalledOfficeManagerHolder class. Note that if the InstalledOfficeManagerHolder class already holds an OfficeManager instance, the owner of this existing manager is responsible to stopped it.
    
    Returns:
    
    A ExternalOfficeManager with default configuration.
  - execute
```
public void execute(org.jodconverter.task.OfficeTask task)
             throws org.jodconverter.office.OfficeException
```
    Throws:
    
    org.jodconverter.office.OfficeException
  - isRunning
```
public boolean isRunning()
```
  - start
```
public void start()
           throws org.jodconverter.office.OfficeException
```
    Throws:
    
    org.jodconverter.office.OfficeException
  - stop
```
public void stop()
```
  - makeTempDir
```
protected static File makeTempDir(File arg0)
```
  - makeTemporaryFile
```
public File makeTemporaryFile()
```
    Specified by:
    
    makeTemporaryFile in interface org.jodconverter.office.TemporaryFileMaker
  - makeTemporaryFile
```
public File makeTemporaryFile(String arg0)
```
    Specified by:
    
    makeTemporaryFile in interface org.jodconverter.office.TemporaryFileMaker
  - makeTempDir
```
protected void makeTempDir()
```
  - deleteTempDir
```
protected void deleteTempDir()
```

Class ExternalOfficeManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT_NUMBER

DEFAULT_PIPE_NAME

DEFAULT_INITIAL_DELAY

DEFAULT_CONNECT_TIMEOUT

DEFAULT_RETRY_INTERVAL

MAX_RETRY_INTERVAL

config

Method Detail

builder

make

install

execute

isRunning

start

stop

makeTempDir

makeTemporaryFile

makeTemporaryFile

makeTempDir

deleteTempDir