@Role
public interface OfficeServer
Modifier and Type | Interface and Description |
---|---|
static class |
OfficeServer.ServerState
Enumeration used to represent the office server state.
|
Modifier and Type | Method and 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.
|
default void refreshState()
OfficeServer.ServerState getState()
void start() throws OfficeServerException
start()
on an already started / connected server has no
effect.OfficeServerException
- if the start operation failsvoid stop() throws OfficeServerException
stop()
on an already stopped / disconnected server has no effect.OfficeServerException
- if stop operation failsOfficeConverter getConverter()
OfficeConverter
instance suitable for performing document conversion tasksCopyright © 2004–2021 XWiki. All rights reserved.