001: /*
002: * Copyright 1999,2004 The Apache Software Foundation.
003: *
004: * Licensed under the Apache License, Version 2.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.apache.org/licenses/LICENSE-2.0
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016:
017: package org.apache.catalina;
018:
019: /**
020: * Global constants that are applicable to multiple packages within Catalina.
021: *
022: * @author Craig R. McClanahan
023: * @version $Revision: 1.9 $ $Date: 2004/04/01 20:18:15 $
024: */
025:
026: public final class Globals {
027:
028: /**
029: * The servlet context attribute under which we store the alternate
030: * deployment descriptor for this web application
031: */
032: public static final String ALT_DD_ATTR = "org.apache.catalina.deploy.alt_dd";
033:
034: /**
035: * The request attribute under which we store the array of X509Certificate
036: * objects representing the certificate chain presented by our client,
037: * if any.
038: */
039: public static final String CERTIFICATES_ATTR = "javax.servlet.request.X509Certificate";
040:
041: /**
042: * SSL Certificate Request Attributite.
043: */
044: public static final String SSL_CERTIFICATE_ATTR = "org.apache.coyote.request.X509Certificate";
045:
046: /**
047: * The request attribute under which we store the name of the cipher suite
048: * being used on an SSL connection (as an object of type
049: * java.lang.String).
050: */
051: public static final String CIPHER_SUITE_ATTR = "javax.servlet.request.cipher_suite";
052:
053: /**
054: * The servlet context attribute under which we store the class loader
055: * used for loading servlets (as an object of type java.lang.ClassLoader).
056: */
057: public static final String CLASS_LOADER_ATTR = "org.apache.catalina.classloader";
058:
059: /**
060: * Request dispatcher state.
061: */
062: public static final String DISPATCHER_TYPE_ATTR = "org.apache.catalina.core.DISPATCHER_TYPE";
063:
064: /**
065: * Request dispatcher path.
066: */
067: public static final String DISPATCHER_REQUEST_PATH_ATTR = "org.apache.catalina.core.DISPATCHER_REQUEST_PATH";
068:
069: /**
070: * The JNDI directory context which is associated with the context. This
071: * context can be used to manipulate static files.
072: */
073: public static final String RESOURCES_ATTR = "org.apache.catalina.resources";
074:
075: /**
076: * The servlet context attribute under which we store the class path
077: * for our application class loader (as an object of type String),
078: * delimited with the appropriate path delimiter for this platform.
079: */
080: public static final String CLASS_PATH_ATTR = "org.apache.catalina.jsp_classpath";
081:
082: /**
083: * The request attribute under which the original context path is stored
084: * on an included dispatcher request.
085: */
086: public static final String INCLUDE_CONTEXT_PATH_ATTR = "javax.servlet.include.context_path";
087:
088: /**
089: * The request attribute under which the original context path is stored
090: * on an forwarded dispatcher request.
091: */
092: public static final String FORWARD_CONTEXT_PATH_ATTR = "javax.servlet.forward.context_path";
093:
094: /**
095: * The request attribute under which we forward a Java exception
096: * (as an object of type Throwable) to an error page.
097: */
098: public static final String EXCEPTION_ATTR = "javax.servlet.error.exception";
099:
100: /**
101: * The request attribute under which we forward the request URI
102: * (as an object of type String) of the page on which an error occurred.
103: */
104: public static final String EXCEPTION_PAGE_ATTR = "javax.servlet.error.request_uri";
105:
106: /**
107: * The request attribute under which we forward a Java exception type
108: * (as an object of type Class) to an error page.
109: */
110: public static final String EXCEPTION_TYPE_ATTR = "javax.servlet.error.exception_type";
111:
112: /**
113: * The request attribute under which we forward an HTTP status message
114: * (as an object of type STring) to an error page.
115: */
116: public static final String ERROR_MESSAGE_ATTR = "javax.servlet.error.message";
117:
118: /**
119: * The request attribute under which the Invoker servlet will store
120: * the invoking servlet path, if it was used to execute a servlet
121: * indirectly instead of through a servlet mapping.
122: */
123: public static final String INVOKED_ATTR = "org.apache.catalina.INVOKED";
124:
125: /**
126: * The request attribute under which we expose the value of the
127: * <code><jsp-file></code> value associated with this servlet,
128: * if any.
129: */
130: public static final String JSP_FILE_ATTR = "org.apache.catalina.jsp_file";
131:
132: /**
133: * The request attribute under which we store the key size being used for
134: * this SSL connection (as an object of type java.lang.Integer).
135: */
136: public static final String KEY_SIZE_ATTR = "javax.servlet.request.key_size";
137:
138: /**
139: * The servlet context attribute under which the managed bean Registry
140: * will be stored for privileged contexts (if enabled).
141: */
142: public static final String MBEAN_REGISTRY_ATTR = "org.apache.catalina.Registry";
143:
144: /**
145: * The servlet context attribute under which the MBeanServer will be stored
146: * for privileged contexts (if enabled).
147: */
148: public static final String MBEAN_SERVER_ATTR = "org.apache.catalina.MBeanServer";
149:
150: /**
151: * The request attribute under which we store the servlet name on a
152: * named dispatcher request.
153: */
154: public static final String NAMED_DISPATCHER_ATTR = "org.apache.catalina.NAMED";
155:
156: /**
157: * The request attribute under which the original path info is stored
158: * on an included dispatcher request.
159: */
160: public static final String INCLUDE_PATH_INFO_ATTR = "javax.servlet.include.path_info";
161:
162: /**
163: * The request attribute under which the original path info is stored
164: * on an forwarded dispatcher request.
165: */
166: public static final String FORWARD_PATH_INFO_ATTR = "javax.servlet.forward.path_info";
167:
168: /**
169: * The request attribute under which the original query string is stored
170: * on an included dispatcher request.
171: */
172: public static final String INCLUDE_QUERY_STRING_ATTR = "javax.servlet.include.query_string";
173:
174: /**
175: * The request attribute under which the original query string is stored
176: * on an forwarded dispatcher request.
177: */
178: public static final String FORWARD_QUERY_STRING_ATTR = "javax.servlet.forward.query_string";
179:
180: /**
181: * The request attribute under which the original request URI is stored
182: * on an included dispatcher request.
183: */
184: public static final String INCLUDE_REQUEST_URI_ATTR = "javax.servlet.include.request_uri";
185:
186: /**
187: * The request attribute under which the original request URI is stored
188: * on an forwarded dispatcher request.
189: */
190: public static final String FORWARD_REQUEST_URI_ATTR = "javax.servlet.forward.request_uri";
191:
192: /**
193: * The request attribute under which we forward a servlet name to
194: * an error page.
195: */
196: public static final String SERVLET_NAME_ATTR = "javax.servlet.error.servlet_name";
197:
198: /**
199: * The request attribute under which the original servlet path is stored
200: * on an included dispatcher request.
201: */
202: public static final String INCLUDE_SERVLET_PATH_ATTR = "javax.servlet.include.servlet_path";
203:
204: /**
205: * The request attribute under which the original servlet path is stored
206: * on an forwarded dispatcher request.
207: */
208: public static final String FORWARD_SERVLET_PATH_ATTR = "javax.servlet.forward.servlet_path";
209:
210: /**
211: * The name of the cookie used to pass the session identifier back
212: * and forth with the client.
213: */
214: public static final String SESSION_COOKIE_NAME = "JSESSIONID";
215:
216: /**
217: * The name of the path parameter used to pass the session identifier
218: * back and forth with the client.
219: */
220: public static final String SESSION_PARAMETER_NAME = "jsessionid";
221:
222: /**
223: * The request attribute under which we forward an HTTP status code
224: * (as an object of type Integer) to an error page.
225: */
226: public static final String STATUS_CODE_ATTR = "javax.servlet.error.status_code";
227:
228: /**
229: * The subject under which the AccessControlContext is running.
230: */
231: public static final String SUBJECT_ATTR = "javax.security.auth.subject";
232:
233: /**
234: * The servlet context attribute under which we record the set of
235: * welcome files (as an object of type String[]) for this application.
236: */
237: public static final String WELCOME_FILES_ATTR = "org.apache.catalina.WELCOME_FILES";
238:
239: /**
240: * The servlet context attribute under which we store a temporary
241: * working directory (as an object of type File) for use by servlets
242: * within this web application.
243: */
244: public static final String WORK_DIR_ATTR = "javax.servlet.context.tempdir";
245:
246: }
|