1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 package util;
24 
25 /**
26  * This interfaces describes some key names which are used in <CODE>lib.TestParameters</CODE>.
27  */
28 
29 public interface PropertyName {
30     /**
31      * parameter name: "AppExecutionCommand"
32      */
33     final public static String APP_EXECUTION_COMMAND = "AppExecutionCommand";
34     /**
35      * parameter name: "AppKillCommand"
36      */
37     final public static String APP_KILL_COMMAND = "AppKillCommand";
38     /**
39      * parameter name: "ConnectionString"
40      */
41     final public static String CONNECTION_STRING = "ConnectionString";
42     final public static String PIPE_CONNECTION_STRING = "PipeConnectionString";
43     final public static String USE_PIPE_CONNECTION = "UsePipeConnection";
44 
45     /**
46      * parameter name: "TestBase"
47      */
48     final public static String TEST_BASE = "TestBase";
49     /**
50      * parameter name: "TestDocumentPath"
51      */
52     final public static String TEST_DOCUMENT_PATH = "TestDocumentPath";
53     /**
54      * parameter name: "LoggingIsActive"
55      */
56     final public static String LOGGING_IS_ACTIVE = "LoggingIsActive";
57     /**
58      * parameter name: "DebugIsActive"
59      */
60     final public static String DEBUG_IS_ACTIVE = "DebugIsActive";
61     /**
62      * parameter name: "OutProduceer"
63      */
64     final public static String OUT_PRODUCER = "OutProducer";
65     /**
66      * parameter name: "ShortWait"
67      */
68     final public static String SHORT_WAIT= "ShortWait";
69     /**
70      * internal only, no parameter
71      */
72     final public static String OFFICE_PROVIDER = "OfficeProvider";
73     /**
74      * internal only, no parameter
75      */
76     final public static String OFFICE_WATCHER = "Watcher";
77     /**
78      * internal only, no parameter
79      */
80     final public static String LOG_WRITER = "LogWriter";
81     /**
82      * parameter name: "TimeOut"<p>
83      * time out given in milli seconds
84      */
85     final public static String TIME_OUT = "TimeOut";
86     /**
87      * parameter name: "ThreadTimeOut"
88      */
89     final public static String THREAD_TIME_OUT = "ThreadTimeOut";
90     /**
91      * parameter name: "OfficeCloseTimeOut"
92      */
93     final public static String OFFICE_CLOSE_TIME_OUT = "OfficeCloseTimeOut";
94     /**
95      * parameter name: "OperatingSystem"
96      */
97     final public static String OPERATING_SYSTEM = "OperatingSystem";
98     /**
99      * parameter name: "AutoRestart"
100      */
101     final public static String AUTO_RESTART = "AutoRestart";
102     /**
103      * parameter name: "NewOfficeInstance"
104      */
105     final public static String NEW_OFFICE_INSTANCE = "NewOfficeInstance";
106     /**
107      * parameter name: "KeepDocument"
108      */
109     final public static String KEEP_DOCUMENT = "KeepDocument";
110     /**
111      * parameter name: "SRC_ROOT"<p>
112      * path to the source root of OpenOffice.org
113      */
114     final public static String SRC_ROOT = "SRC_ROOT";
115     /**
116      * parameter name: "Version"<p>
117      * the name of the version to test
118      */
119     final public static String VERSION = "Version";
120 
121     /**
122      * parameter name "Shell"<p>
123      * Path to a shell.
124      * This shell is used to run some commands outside of Java
125      * example: /bin/tcsh c:\\myShell\\myShell.exe
126      */
127     final public static String SHELL = "Shell";
128     /**
129      * parameter name "Cygwin"<p>
130      * If Cygwin is set to TRUE it indicates if the runner runs in a Cygwin
131      * environment
132      */
133     final public static String CYGWIN = "Cygwin";
134     /**
135      * parameter name: "NoCwsAttach"<p>
136      * If this parameter is set to "true" , a status of CWS-UnoAPI-Tests was not attached to EIS<p>
137      * @see complex.unoapi.CheckModuleAPI
138      */
139     final public static String NO_CWS_ATTACH = "NoCwsAttach";
140     /**
141      * internal only, no parameter
142      */
143     final public static String WNTMSCI = "wntmsci";
144     /**
145      * internal only, no parameter
146      */
147     final public static String UNXLNGI = "unxlngi";
148     /**
149      * internal only, no parameter
150      */
151     final public static String UNXSOLS = "unxsols";
152     /**
153      * internal only, no parameter
154      */
155     final public static String UNXSOLI = "unxsoli";
156     /**
157      * internal only, no parameter
158      */
159     final public static String UNXMACXI = "unxmacxi";
160 
161     /**
162      * can be used to dont backup the user layer, faster office start/stop but less secure default is to backup the user layer
163      */
164     final public static String DONT_BACKUP_USERLAYER = "DontBackupUserLayer";
165 }
166