org.xwiki.officeimporter.openoffice

Interface OpenOfficeConfiguration

Deprecated.

since 5.0M2, use the OfficeServerConfiguration instead.

@Role
 @Deprecated
public interface OpenOfficeConfiguration

Configuration properties for office importer module.

These configuration properties are defined in XWiki's global configuration file using the prefix of "officeimporter".

Since:

1.8RC3

Version:

$Id: 53b13241d59f5bf0eed8a37b16ec7c0dac77ee42 $

Field Summary

Fields

Modifier and Type	Field and Description
static int	SERVER_TYPE_EXTERNAL_LOCAL Deprecated. Indicates an externally managed locally deployed office server instance.
static int	SERVER_TYPE_EXTERNAL_REMOTE Deprecated. Indicates an externally managed remotely deployed office server instance.
static int	SERVER_TYPE_INTERNAL Deprecated. Indicates an internally managed office server instance.

Method Summary

Modifier and Type	Method and Description
String	getHomePath() Deprecated.
int	getMaxTasksPerProcess() Deprecated.
String	getProfilePath() Deprecated.
int	getServerPort() Deprecated.
int	getServerType() Deprecated. Returns the type of the office server instance consumed by office importer module: 0 - Internally managed server instance 1 - Externally managed (local) server instance .
long	getTaskExecutionTimeout() Deprecated.
boolean	isAutoStart() Deprecated.

Field Detail

SERVER_TYPE_INTERNAL

static final int SERVER_TYPE_INTERNAL

Deprecated.

Indicates an internally managed office server instance.

See Also:

Constant Field Values

SERVER_TYPE_EXTERNAL_LOCAL

static final int SERVER_TYPE_EXTERNAL_LOCAL

Deprecated.

Indicates an externally managed locally deployed office server instance.

See Also:

Constant Field Values

SERVER_TYPE_EXTERNAL_REMOTE

static final int SERVER_TYPE_EXTERNAL_REMOTE

Deprecated.

Indicates an externally managed remotely deployed office server instance.

See Also:

Constant Field Values

Method Detail

getServerType

int getServerType()

Deprecated.

Returns the type of the office server instance consumed by office importer module:

• 0 - Internally managed server instance
• 1 - Externally managed (local) server instance

.

Returns:

type of the office server used by the office importer module

getServerPort

int getServerPort()

Deprecated.

Returns:

the port number used for connecting to the office server instance

isAutoStart

boolean isAutoStart()

Deprecated.

Returns:

whether office server should be started / connected automatically with XWiki Enterprise

getHomePath

String getHomePath()

Deprecated.

Returns:

the path to the office server installation, or null if the home path is not configured and the office installation is not detected (which means the office server is either not installed or it is installed at a custom path)

getProfilePath

String getProfilePath()

Deprecated.

Returns:

the path to office server execution profile, null by default

getMaxTasksPerProcess

int getMaxTasksPerProcess()

Deprecated.

Returns:

the maximum number of simultaneous conversion tasks to be handled by a single office process instance

getTaskExecutionTimeout

long getTaskExecutionTimeout()

Deprecated.

Returns:

the timeout for document conversion tasks