Package org.xwiki.officeimporter.server

Interface OfficeServerConfiguration

  • @Role
public interface OfficeServerConfiguration
    Configuration properties for the OfficeServer. They are defined in XWiki's global configuration file using the prefix of "officeimporter".
    Since:
    5.0M2
    Version:
    $Id: 6b8054df01128e80ea0a3ac973a2c59d10120453 $

    • Field Detail

      • SERVER_TYPE_INTERNAL

        static final int SERVER_TYPE_INTERNAL
        Indicates an internally managed office server instance.
        See Also:
        Constant Field Values

      • SERVER_TYPE_EXTERNAL_LOCAL

        static final int SERVER_TYPE_EXTERNAL_LOCAL
        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
        Indicates an externally managed remotely deployed office server instance.
        See Also:
        Constant Field Values

    • Method Detail

      • getServerType

        int getServerType()
        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

        @Deprecated
int getServerPort()
        Deprecated.
        Since 12.1RC1. Now use getServerPorts().
        Returns:
        the port number used for connecting to the office server instance

      • getServerPorts

        default int[] getServerPorts()
        Returns:
        all ports that can be used for connecting to the office server instance.
        Since:
        12.1RC1

      • isAutoStart

        boolean isAutoStart()
        Returns:
        whether office server should be started / connected automatically with XWiki Enterprise

      • getHomePath

        String getHomePath()
        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()
        Returns:
        the path to office server execution profile, null by default

      • getMaxTasksPerProcess

        int getMaxTasksPerProcess()
        Returns:
        the maximum number of simultaneous conversion tasks to be handled by a single office process instance

      • getTaskExecutionTimeout

        long getTaskExecutionTimeout()
        Returns:
        the timeout for document conversion tasks