forked from apache/tomcat
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOptions.java
More file actions
378 lines (325 loc) · 11.3 KB
/
Options.java
File metadata and controls
378 lines (325 loc) · 11.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jasper;
import java.io.File;
import java.util.Map;
import jakarta.servlet.jsp.tagext.TagLibraryInfo;
import org.apache.jasper.compiler.JspConfig;
import org.apache.jasper.compiler.TagPluginManager;
import org.apache.jasper.compiler.TldCache;
/**
* A class to hold all init parameters specific to the JSP engine.
*
* @author Anil K. Vijendran
* @author Hans Bergsten
* @author Pierre Delisle
*/
public interface Options {
/**
* Returns true if Jasper issues a compilation error instead of a runtime
* Instantiation error if the class attribute specified in useBean action
* is invalid.
* @return <code>true</code> to get an error
*/
public boolean getErrorOnUseBeanInvalidClassAttribute();
/**
* @return <code>true</code> to keep the generated source
*/
public boolean getKeepGenerated();
/**
* @return <code>true</code> if tag handler pooling is enabled,
* <code>false</code> otherwise.
*/
public boolean isPoolingEnabled();
/**
* @return <code>true</code> if HTML mapped Servlets are supported.
*/
public boolean getMappedFile();
/**
* @return <code>true</code> if debug information in included
* in compiled classes.
*/
public boolean getClassDebugInfo();
/**
* @return background compile thread check interval in seconds
*/
public int getCheckInterval();
/**
* Main development flag, which enables detailed error reports with
* sources, as well automatic recompilation of JSPs and tag files.
* This setting should usually be <code>false</code> when running
* in production.
* @return <code>true</code> if Jasper is in development mode
*/
public boolean getDevelopment();
/**
* @return <code>true</code> to include a source fragment in exception
* messages.
*/
public boolean getDisplaySourceFragment();
/**
* @return <code>true</code> to suppress generation of SMAP info for
* JSR45 debugging.
*/
public boolean isSmapSuppressed();
/**
* This setting is ignored if suppressSmap() is <code>true</code>.
* @return <code>true</code> to write SMAP info for JSR45 debugging to a
* file.
*/
public boolean isSmapDumped();
/**
* @return {@link TrimSpacesOption#TRUE} to remove template text that
* consists only of whitespace from the output completely,
* {@link TrimSpacesOption#SINGLE} to replace such template text
* with a single space, {@link TrimSpacesOption#FALSE} to leave
* such template text unchanged or {@link TrimSpacesOption#EXTENDED}
* to remove template text that consists only of whitespace and to
* replace any sequence of whitespace and new lines within template
* text with a single new line.
*/
public TrimSpacesOption getTrimSpaces();
/**
* Gets the class-id value that is sent to Internet Explorer when using
* <jsp:plugin> tags.
* @return Class-id value
*/
public String getIeClassId();
/**
* @return the work folder
*/
public File getScratchDir();
/**
* @return the classpath used to compile generated Servlets
*/
public String getClassPath();
/**
* Compiler to use.
*
* <p>
* If <code>null</code> (the default), the java compiler from Eclipse JDT
* project, bundled with Tomcat, will be used. Otherwise, the
* <code>javac</code> task from Apache Ant will be used to call an external
* java compiler and the value of this option will be passed to it. See
* Apache Ant documentation for the possible values.
* @return the compiler name
*/
public String getCompiler();
/**
* @return the compiler target VM, e.g. 1.8.
*/
public String getCompilerTargetVM();
/**
* @return the compiler source VM, e.g. 1.8.
*/
public String getCompilerSourceVM();
/**
* @return Jasper Java compiler class to use.
*/
public String getCompilerClassName();
/**
* The cache that maps URIs, resource paths and parsed TLD files for the
* various tag libraries 'exposed' by the web application.
* A tag library is 'exposed' either explicitly in
* web.xml or implicitly via the uri tag in the TLD
* of a taglib deployed in a jar file (WEB-INF/lib).
*
* @return the instance of the TldLocationsCache
* for the web-application.
*/
public TldCache getTldCache();
/**
* @return Java platform encoding to generate the JSP page servlet.
*/
public String getJavaEncoding();
/**
* The boolean flag to tell Ant whether to fork JSP page compilations.
*
* <p>
* Is used only when Jasper uses an external java compiler (wrapped through
* a <code>javac</code> Apache Ant task).
* @return <code>true</code> to fork a process during compilation
*/
public boolean getFork();
/**
* @return JSP configuration information specified in web.xml.
*/
public JspConfig getJspConfig();
/**
* @return <code>true</code> to generate a X-Powered-By response header.
*/
public boolean isXpoweredBy();
/**
* @return a Tag Plugin Manager
*/
public TagPluginManager getTagPluginManager();
/**
* Indicates whether text strings are to be generated as char arrays.
*
* @return <code>true</code> if text strings are to be generated as char
* arrays, <code>false</code> otherwise
*/
public boolean genStringAsCharArray();
/**
* @return modification test interval.
*/
public int getModificationTestInterval();
/**
* @return <code>true</code> if re-compile will occur on a failure.
*/
public boolean getRecompileOnFail();
/**
* @return <code>true</code> is caching is enabled
* (used for precompilation).
*/
public boolean isCaching();
/**
* The web-application wide cache for the TagLibraryInfo tag library
* descriptors, used if {@link #isCaching()} returns <code>true</code>.
*
* <p>
* Using this cache avoids the cost of repeating the parsing of a tag
* library descriptor XML file (performed by TagLibraryInfoImpl.parseTLD).
* </p>
*
* @return the Map(String uri, TagLibraryInfo tld) instance.
*/
public Map<String, TagLibraryInfo> getCache();
/**
* The maximum number of loaded jsps per web-application. If there are more
* jsps loaded, they will be unloaded. If unset or less than 0, no jsps
* are unloaded.
* @return The JSP count
*/
public int getMaxLoadedJsps();
/**
* @return the idle time in seconds after which a JSP is unloaded.
* If unset or less or equal than 0, no jsps are unloaded.
*/
public int getJspIdleTimeout();
/**
* @return {@code true} if the quote escaping required by section JSP.1.6 of
* the JSP specification should be applied to scriplet expression.
*/
public boolean getStrictQuoteEscaping();
/**
* @return {@code true} if EL expressions used within attributes should have
* the quoting rules in JSP.1.6 applied to the expression.
*/
public boolean getQuoteAttributeEL();
/**
* @return the name of the variable that will be used in the generated
* JSP code for the expression factory
*/
public default String getVariableForExpressionFactory() {
return "_el_expressionfactory";
}
/**
* @return the name of the variable that will be used in the generated
* JSP code for the instance manager
*/
public default String getVariableForInstanceManager() {
return "_jsp_instancemanager";
}
/**
* @return {@code true} if tag pooling is disabled with page that uses
* extends.
*/
public default boolean getPoolTagsWithExtends() {
return false;
}
/**
* @return {@code true} if the requirement to have the object
* used in jsp:getProperty action to be previously "introduced"
* to the JSP processor (see JSP.5.3) is enforced.
*/
public default boolean getStrictGetProperty() {
return true;
}
/**
* @return {@code true} if the strict white space rules are
* applied.
*/
public default boolean getStrictWhitespace() {
return true;
}
/**
* @return the default base class for generated JSP Servlets
*/
public default String getJspServletBase() {
return "org.apache.jasper.runtime.HttpJspBase";
}
/**
* _jspService is the name of the method that is called by
* HttpJspBase.service(). This is where most of the code generated
* from JSPs go.
* @return the method name
*/
public default String getServiceMethodName() {
return "_jspService";
}
/**
* @return ServletContext attribute for classpath. This is tomcat specific.
* Other servlet engines may choose to support this attribute if they
* want to have this JSP engine running on them.
*/
public default String getServletClasspathAttribute() {
return "org.apache.catalina.jsp_classpath";
}
/**
* @return The query parameter that causes the JSP engine to just
* pregenerated the servlet but not invoke it.
*/
public default String getJspPrecompilationQueryParameter() {
return "jsp_precompile";
}
/**
* @return The default package name for compiled jsp pages.
*/
public default String getGeneratedJspPackageName() {
return "org.apache.jsp";
}
/**
* @return The default package name for tag handlers generated from tag files.
*/
public default String getGeneratedTagFilePackageName() {
return "org.apache.jsp.tag";
}
/**
* @return Prefix to use for generated temporary variable names
*/
public default String getTempVariableNamePrefix() {
return "_jspx_temp";
}
/**
* @return {@code true} if the container instance manager will be used
* to create the bean instances
*/
public default boolean getUseInstanceManagerForTags() {
return false;
}
/**
* Should the container include the time the file was generated in the
* comments at the start of a Java file generated from a JSP or tag.
* Defaults to {@code true}.
*
* @return {@code true} to include the timestamp, otherwise don't include it
*/
public default boolean getGeneratedJavaAddTimestamp() {
return true;
}
}