1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.officeimporter.server

File OfficeServerConfiguration.java

 

Code metrics

0
0
0
1
92
16
0
-
-
0
-

Classes

Class Line # Actions
OfficeServerConfiguration 32 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.officeimporter.server;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Configuration properties for the {@link OfficeServer}. They are defined in XWiki's global configuration file using
26    * the prefix of "officeimporter".
27    *
28    * @version $Id: 9616eecbfe3a502a9904dd4b6424ea74363af3e2 $
29    * @since 5.0M2
30    */
31    @Role
 
32    public interface OfficeServerConfiguration
33    {
34    /**
35    * Indicates an internally managed office server instance.
36    */
37    int SERVER_TYPE_INTERNAL = 0;
38   
39    /**
40    * Indicates an externally managed locally deployed office server instance.
41    */
42    int SERVER_TYPE_EXTERNAL_LOCAL = 1;
43   
44    /**
45    * Indicates an externally managed remotely deployed office server instance.
46    */
47    int SERVER_TYPE_EXTERNAL_REMOTE = 2;
48   
49    /**
50    * Returns the type of the office server instance consumed by office importer module:
51    * <ul>
52    * <li>0 - Internally managed server instance</li>
53    * <li>1 - Externally managed (local) server instance</li>
54    * </ul>
55    * .
56    *
57    * @return type of the office server used by the office importer module
58    */
59    int getServerType();
60   
61    /**
62    * @return the port number used for connecting to the office server instance
63    */
64    int getServerPort();
65   
66    /**
67    * @return whether office server should be started / connected automatically with XWiki Enterprise
68    */
69    boolean isAutoStart();
70   
71    /**
72    * @return the path to the office server installation, or {@code null} if the home path is not configured and the
73    * office installation is not detected (which means the office server is either not installed or it is
74    * installed at a custom path)
75    */
76    String getHomePath();
77   
78    /**
79    * @return the path to office server execution profile, {@code null} by default
80    */
81    String getProfilePath();
82   
83    /**
84    * @return the maximum number of simultaneous conversion tasks to be handled by a single office process instance
85    */
86    int getMaxTasksPerProcess();
87   
88    /**
89    * @return the timeout for document conversion tasks
90    */
91    long getTaskExecutionTimeout();
92    }