Globals


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  
19  package org.apache.catalina;
20  
21  
22  /**
23   * Global constants that are applicable to multiple packages within Catalina.
24   *
25   * @author Craig R. McClanahan
26   * @version $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
27   */
28  
29  public final class Globals {
30  
31      /**
32       * The servlet context attribute under which we store the alternate
33       * deployment descriptor for this web application 
34       */
35      public static final String   ALT_DD_ATTR = 
36          "org.apache.catalina.deploy.alt_dd";
37  
38      /**
39       * The request attribute under which we store the array of X509Certificate
40       * objects representing the certificate chain presented by our client,
41       * if any.
42       */
43      public static final String   CERTIFICATES_ATTR =
44          "javax.servlet.request.X509Certificate";
45  
46      /**
47       * The request attribute under which we store the name of the cipher suite
48       * being used on an SSL connection (as an object of type
49       * java.lang.String).
50       */
51      public static final String   CIPHER_SUITE_ATTR =
52          "javax.servlet.request.cipher_suite";
53  
54  
55      /**
56       * The servlet context attribute under which we store the class loader
57       * used for loading servlets (as an object of type java.lang.ClassLoader).
58       */
59      public static final String   CLASS_LOADER_ATTR =
60          "org.apache.catalina.classloader";
61  
62      /**
63       * Request dispatcher state.
64       */
65      public static final String   DISPATCHER_TYPE_ATTR = 
66          "org.apache.catalina.core.DISPATCHER_TYPE";
67  
68      /**
69       * Request dispatcher path.
70       */
71      public static final String   DISPATCHER_REQUEST_PATH_ATTR = 
72          "org.apache.catalina.core.DISPATCHER_REQUEST_PATH";
73  
74      /**
75       * The JNDI directory context which is associated with the context. This
76       * context can be used to manipulate static files.
77       */
78      public static final String   RESOURCES_ATTR =
79          "org.apache.catalina.resources";
80  
81  
82      /**
83       * The servlet context attribute under which we store the class path
84       * for our application class loader (as an object of type String),
85       * delimited with the appropriate path delimiter for this platform.
86       */
87      public static final String   CLASS_PATH_ATTR =
88          "org.apache.catalina.jsp_classpath";
89  
90  
91      /**
92       * The request attribute under which we forward a Java exception
93       * (as an object of type Throwable) to an error page.
94       */
95      public static final String   EXCEPTION_ATTR =
96          "javax.servlet.error.exception";
97  
98  
99      /**
100      * The request attribute under which we forward the request URI
101      * (as an object of type String) of the page on which an error occurred.
102      */
103     public static final String   EXCEPTION_PAGE_ATTR =
104         "javax.servlet.error.request_uri";
105 
106 
107     /**
108      * The request attribute under which we forward a Java exception type
109      * (as an object of type Class) to an error page.
110      */
111     public static final String   EXCEPTION_TYPE_ATTR =
112         "javax.servlet.error.exception_type";
113 
114 
115     /**
116      * The request attribute under which we forward an HTTP status message
117      * (as an object of type STring) to an error page.
118      */
119     public static final String   ERROR_MESSAGE_ATTR =
120         "javax.servlet.error.message";
121 
122 
123     /**
124      * The request attribute under which the Invoker servlet will store
125      * the invoking servlet path, if it was used to execute a servlet
126      * indirectly instead of through a servlet mapping.
127      */
128     public static final String   INVOKED_ATTR =
129         "org.apache.catalina.INVOKED";
130 
131 
132     /**
133      * The request attribute under which we expose the value of the
134      * <code>&lt;jsp-file&gt;</code> value associated with this servlet,
135      * if any.
136      */
137     public static final String   JSP_FILE_ATTR =
138         "org.apache.catalina.jsp_file";
139 
140 
141     /**
142      * The request attribute under which we store the key size being used for
143      * this SSL connection (as an object of type java.lang.Integer).
144      */
145     public static final String   KEY_SIZE_ATTR =
146         "javax.servlet.request.key_size";
147 
148     /**
149      * The request attribute under which we store the session id being used
150      * for this SSL connection (as an object of type java.lang.String).
151      */
152     public static final String   SSL_SESSION_ID_ATTR =
153         "javax.servlet.request.ssl_session";
154 
155 
156     /**
157      * The servlet context attribute under which the managed bean Registry
158      * will be stored for privileged contexts (if enabled).
159      */
160     public static final String   MBEAN_REGISTRY_ATTR =
161         "org.apache.catalina.Registry";
162 
163 
164     /**
165      * The servlet context attribute under which the MBeanServer will be stored
166      * for privileged contexts (if enabled).
167      */
168     public static final String   MBEAN_SERVER_ATTR =
169         "org.apache.catalina.MBeanServer";
170 
171 
172     /**
173      * The request attribute under which we store the servlet name on a
174      * named dispatcher request.
175      */
176     public static final String   NAMED_DISPATCHER_ATTR =
177         "org.apache.catalina.NAMED";
178 
179 
180     /**
181      * The request attribute under which the request URI of the included
182      * servlet is stored on an included dispatcher request.
183      */
184     public static final String   INCLUDE_REQUEST_URI_ATTR =
185         "javax.servlet.include.request_uri";
186 
187 
188     /**
189      * The request attribute under which the context path of the included
190      * servlet is stored on an included dispatcher request.
191      */
192     public static final String   INCLUDE_CONTEXT_PATH_ATTR =
193         "javax.servlet.include.context_path";
194 
195 
196     /**
197      * The request attribute under which the path info of the included
198      * servlet is stored on an included dispatcher request.
199      */
200     public static final String   INCLUDE_PATH_INFO_ATTR =
201         "javax.servlet.include.path_info";
202 
203 
204     /**
205      * The request attribute under which the servlet path of the included
206      * servlet is stored on an included dispatcher request.
207      */
208     public static final String   INCLUDE_SERVLET_PATH_ATTR =
209         "javax.servlet.include.servlet_path";
210 
211 
212     /**
213      * The request attribute under which the query string of the included
214      * servlet is stored on an included dispatcher request.
215      */
216     public static final String   INCLUDE_QUERY_STRING_ATTR =
217         "javax.servlet.include.query_string";
218 
219 
220     /**
221      * The request attribute under which the original request URI is stored
222      * on an forwarded dispatcher request.
223      */
224     public static final String   FORWARD_REQUEST_URI_ATTR =
225         "javax.servlet.forward.request_uri";
226     
227     
228     /**
229      * The request attribute under which the original context path is stored
230      * on an forwarded dispatcher request.
231      */
232     public static final String   FORWARD_CONTEXT_PATH_ATTR =
233         "javax.servlet.forward.context_path";
234 
235 
236     /**
237      * The request attribute under which the original path info is stored
238      * on an forwarded dispatcher request.
239      */
240     public static final String   FORWARD_PATH_INFO_ATTR =
241         "javax.servlet.forward.path_info";
242 
243 
244     /**
245      * The request attribute under which the original servlet path is stored
246      * on an forwarded dispatcher request.
247      */
248     public static final String   FORWARD_SERVLET_PATH_ATTR =
249         "javax.servlet.forward.servlet_path";
250 
251 
252     /**
253      * The request attribute under which the original query string is stored
254      * on an forwarded dispatcher request.
255      */
256     public static final String   FORWARD_QUERY_STRING_ATTR =
257         "javax.servlet.forward.query_string";
258 
259 
260     /**
261      * The request attribute under which we forward a servlet name to
262      * an error page.
263      */
264     public static final String   SERVLET_NAME_ATTR =
265         "javax.servlet.error.servlet_name";
266 
267     
268     /**
269      * The name of the cookie used to pass the session identifier back
270      * and forth with the client.
271      */
272     public static final String   SESSION_COOKIE_NAME = "JSESSIONID";
273 
274 
275     /**
276      * The name of the path parameter used to pass the session identifier
277      * back and forth with the client.
278      */
279     public static final String   SESSION_PARAMETER_NAME = "jsessionid";
280 
281 
282     /**
283      * The servlet context attribute under which we store a flag used
284      * to mark this request as having been processed by the SSIServlet.
285      * We do this because of the pathInfo mangling happening when using
286      * the CGIServlet in conjunction with the SSI servlet. (value stored
287      * as an object of type String)
288      */
289      public static final String   SSI_FLAG_ATTR =
290          "org.apache.catalina.ssi.SSIServlet";
291 
292 
293     /**
294      * The request attribute under which we forward an HTTP status code
295      * (as an object of type Integer) to an error page.
296      */
297     public static final String   STATUS_CODE_ATTR =
298         "javax.servlet.error.status_code";
299 
300 
301     /**
302      * The subject under which the AccessControlContext is running.
303      */
304     public static final String   SUBJECT_ATTR =
305         "javax.security.auth.subject";
306 
307     
308     /**
309      * The servlet context attribute under which we record the set of
310      * welcome files (as an object of type String[]) for this application.
311      */
312     public static final String   WELCOME_FILES_ATTR =
313         "org.apache.catalina.WELCOME_FILES";
314 
315 
316     /**
317      * The servlet context attribute under which we store a temporary
318      * working directory (as an object of type File) for use by servlets
319      * within this web application.
320      */
321     public static final String   WORK_DIR_ATTR =
322         "javax.servlet.context.tempdir";
323 
324 
325     /**
326      * The master flag which controls strict servlet specification 
327      * compliance.
328      */
329     public static final boolean STRICT_SERVLET_COMPLIANCE =
330         Boolean.valueOf(System.getProperty("org.apache.catalina.STRICT_SERVLET_COMPLIANCE", "false")).booleanValue();
331 
332 
333 }
334
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags