OfficeServer (XWiki Platform - Office - Importer 14.10.19 API)

```
@Role
public interface OfficeServer
```
Component interface for managing the office server connection / process.

Since:

5.0M2

Version:

$Id: 82a7d138b1e1d881ebd43a047126ab49d166ab09 $

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OfficeServer.ServerState
Enumeration used to represent the office server state.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`OfficeConverter`	`getConverter()`
`OfficeServer.ServerState`	`getState()`
`default void`	`refreshState()`	Refresh the current state of the process.
`void`	`start()`	If an internally managed office server is configured (xwiki.properties), this method will start an office server process and connect to it.
`void`	`stop()`	If an internally managed office server is configured (xwiki.properties), this method will disconnect from the office server and terminate the server process.

- Method Detail
  - refreshState
```
default void refreshState()
```
    Refresh the current state of the process.
    
    Since:
    
    11.3RC1
  - getState
```
OfficeServer.ServerState getState()
```
    Returns:
    
    current server state
  - start
```
void start()
    throws OfficeServerException
```
    If an internally managed office server is configured (xwiki.properties), this method will start an office server process and connect to it. Otherwise this method will try to connect to an external office server instance configured through xwiki.properties. Calling start() on an already started / connected server has no effect.
    
    Throws:
    
    OfficeServerException - if the start operation fails
  - stop
```
void stop()
   throws OfficeServerException
```
    If an internally managed office server is configured (xwiki.properties), this method will disconnect from the office server and terminate the server process. Otherwise this method will simply disconnect from the external office server. Calling stop() on an already stopped / disconnected server has no effect.
    
    Throws:
    
    OfficeServerException - if stop operation fails
  - getConverter
```
OfficeConverter getConverter()
```
    Returns:
    
    OfficeConverter instance suitable for performing document conversion tasks