001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Globals.java,v 1.43 2001/12/21 21:15:44 craigmcc Exp $
003: * $Revision: 1.43 $
004: * $Date: 2001/12/21 21:15:44 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: /**
067: * Global constants that are applicable to multiple packages within Catalina.
068: *
069: * @author Craig R. McClanahan
070: * @version $Revision: 1.43 $ $Date: 2001/12/21 21:15:44 $
071: */
072:
073: public final class Globals {
074:
075: /**
076: * The request attribute under which we store the array of X509Certificate
077: * objects representing the certificate chain presented by our client,
078: * if any.
079: */
080: public static final String CERTIFICATES_ATTR = "javax.servlet.request.X509Certificate";
081:
082: /**
083: * The request attribute under which we store the name of the cipher suite
084: * being used on an SSL connection (as an object of type
085: * java.lang.String).
086: */
087: public static final String CIPHER_SUITE_ATTR = "javax.servlet.request.cipher_suite";
088:
089: /**
090: * The servlet context attribute under which we store the class loader
091: * used for loading servlets (as an object of type java.lang.ClassLoader).
092: */
093: public static final String CLASS_LOADER_ATTR = "org.apache.catalina.classloader";
094:
095: /**
096: * The JNDI directory context which is associated with the context. This
097: * context can be used to manipulate static files.
098: */
099: public static final String RESOURCES_ATTR = "org.apache.catalina.resources";
100:
101: /**
102: * The servlet context attribute under which we store the class path
103: * for our application class loader (as an object of type String),
104: * delimited with the appropriate path delimiter for this platform.
105: */
106: public static final String CLASS_PATH_ATTR = "org.apache.catalina.jsp_classpath";
107:
108: /**
109: * The request attribute under which the original context path is stored
110: * on an included dispatcher request.
111: */
112: public static final String CONTEXT_PATH_ATTR = "javax.servlet.include.context_path";
113:
114: /**
115: * The request attribute under which we forward a Java exception
116: * (as an object of type Throwable) to an error page.
117: */
118: public static final String EXCEPTION_ATTR = "javax.servlet.error.exception";
119:
120: /**
121: * The request attribute under which we forward the request URI
122: * (as an object of type String) of the page on which an error occurred.
123: */
124: public static final String EXCEPTION_PAGE_ATTR = "javax.servlet.error.request_uri";
125:
126: /**
127: * The request attribute under which we forward a Java exception type
128: * (as an object of type Class) to an error page.
129: */
130: public static final String EXCEPTION_TYPE_ATTR = "javax.servlet.error.exception_type";
131:
132: /**
133: * The request attribute under which we forward an HTTP status message
134: * (as an object of type STring) to an error page.
135: */
136: public static final String ERROR_MESSAGE_ATTR = "javax.servlet.error.message";
137:
138: /**
139: * The request attribute under which the Invoker servlet will store
140: * the invoking servlet path, if it was used to execute a servlet
141: * indirectly instead of through a servlet mapping.
142: */
143: public static final String INVOKED_ATTR = "org.apache.catalina.INVOKED";
144:
145: /**
146: * The request attribute under which we expose the value of the
147: * <code><jsp-file></code> value associated with this servlet,
148: * if any.
149: */
150: public static final String JSP_FILE_ATTR = "org.apache.catalina.jsp_file";
151:
152: /**
153: * The request attribute under which we store the key size being used for
154: * this SSL connection (as an object of type java.lang.Integer).
155: */
156: public static final String KEY_SIZE_ATTR = "javax.servlet.request.key_size";
157:
158: /**
159: * The servlet context attribute under which the managed bean Registry
160: * will be stored for privileged contexts (if enabled).
161: */
162: public static final String MBEAN_REGISTRY_ATTR = "org.apache.catalina.Registry";
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 = "org.apache.catalina.MBeanServer";
169:
170: /**
171: * The request attribute under which we store the servlet name on a
172: * named dispatcher request.
173: */
174: public static final String NAMED_DISPATCHER_ATTR = "org.apache.catalina.NAMED";
175:
176: /**
177: * The request attribute under which the original path info is stored
178: * on an included dispatcher request.
179: */
180: public static final String PATH_INFO_ATTR = "javax.servlet.include.path_info";
181:
182: /**
183: * The request attribute under which the original query string is stored
184: * on an included dispatcher request.
185: */
186: public static final String QUERY_STRING_ATTR = "javax.servlet.include.query_string";
187:
188: /**
189: * The request attribute under which the original request URI is stored
190: * on an included dispatcher request.
191: */
192: public static final String REQUEST_URI_ATTR = "javax.servlet.include.request_uri";
193:
194: /**
195: * The request attribute under which we forward a servlet name to
196: * an error page.
197: */
198: public static final String SERVLET_NAME_ATTR = "javax.servlet.error.servlet_name";
199:
200: /**
201: * The request attribute under which the original servlet path is stored
202: * on an included dispatcher request.
203: */
204: public static final String SERVLET_PATH_ATTR = "javax.servlet.include.servlet_path";
205:
206: /**
207: * The name of the cookie used to pass the session identifier back
208: * and forth with the client.
209: */
210: public static final String SESSION_COOKIE_NAME = "JSESSIONID";
211:
212: /**
213: * The name of the path parameter used to pass the session identifier
214: * back and forth with the client.
215: */
216: public static final String SESSION_PARAMETER_NAME = "jsessionid";
217:
218: /**
219: * The request attribute under which we forward an HTTP status code
220: * (as an object of type Integer) to an error page.
221: */
222: public static final String STATUS_CODE_ATTR = "javax.servlet.error.status_code";
223:
224: /**
225: * The servlet context attribute under which we record the set of
226: * welcome files (as an object of type String[]) for this application.
227: */
228: public static final String WELCOME_FILES_ATTR = "org.apache.catalina.WELCOME_FILES";
229:
230: /**
231: * The servlet context attribute under which we store a temporary
232: * working directory (as an object of type File) for use by servlets
233: * within this web application.
234: */
235: public static final String WORK_DIR_ATTR = "javax.servlet.context.tempdir";
236:
237: }
|