| 1 | |
|---|
| 2 | |
|---|
| 3 | /* |
|---|
| 4 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
|---|
| 5 | * |
|---|
| 6 | * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved. |
|---|
| 7 | * |
|---|
| 8 | * Portions Copyright Apache Software Foundation. |
|---|
| 9 | * |
|---|
| 10 | * The contents of this file are subject to the terms of either the GNU |
|---|
| 11 | * General Public License Version 2 only ("GPL") or the Common Development |
|---|
| 12 | * and Distribution License("CDDL") (collectively, the "License"). You |
|---|
| 13 | * may not use this file except in compliance with the License. You can obtain |
|---|
| 14 | * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html |
|---|
| 15 | * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific |
|---|
| 16 | * language governing permissions and limitations under the License. |
|---|
| 17 | * |
|---|
| 18 | * When distributing the software, include this License Header Notice in each |
|---|
| 19 | * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. |
|---|
| 20 | * Sun designates this particular file as subject to the "Classpath" exception |
|---|
| 21 | * as provided by Sun in the GPL Version 2 section of the License file that |
|---|
| 22 | * accompanied this code. If applicable, add the following below the License |
|---|
| 23 | * Header, with the fields enclosed by brackets [] replaced by your own |
|---|
| 24 | * identifying information: "Portions Copyrighted [year] |
|---|
| 25 | * [name of copyright owner]" |
|---|
| 26 | * |
|---|
| 27 | * Contributor(s): |
|---|
| 28 | * |
|---|
| 29 | * If you wish your version of this file to be governed by only the CDDL or |
|---|
| 30 | * only the GPL Version 2, indicate your decision by adding "[Contributor] |
|---|
| 31 | * elects to include this software in this distribution under the [CDDL or GPL |
|---|
| 32 | * Version 2] license." If you don't indicate a single choice of license, a |
|---|
| 33 | * recipient has the option to distribute your version of this file under |
|---|
| 34 | * either the CDDL, the GPL Version 2 or to extend the choice of license to |
|---|
| 35 | * its licensees as provided above. However, if you add GPL Version 2 code |
|---|
| 36 | * and therefore, elected the GPL Version 2 license, then the option applies |
|---|
| 37 | * only if the new code is made subject to such option by the copyright |
|---|
| 38 | * holder. |
|---|
| 39 | */ |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | package org.aiotrade.servlets; |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | /** |
|---|
| 46 | * Global constants that are applicable to multiple packages within Catalina. |
|---|
| 47 | * |
|---|
| 48 | * @author Craig R. McClanahan |
|---|
| 49 | * @version $Revision: 1.13 $ $Date: 2007/10/11 23:15:50 $ |
|---|
| 50 | */ |
|---|
| 51 | |
|---|
| 52 | public final class Globals { |
|---|
| 53 | |
|---|
| 54 | /** |
|---|
| 55 | * The servlet context attribute under which we store the alternate |
|---|
| 56 | * deployment descriptor for this web application |
|---|
| 57 | */ |
|---|
| 58 | public static final String ALT_DD_ATTR = |
|---|
| 59 | "org.apache.catalina.deploy.alt_dd"; |
|---|
| 60 | |
|---|
| 61 | /** |
|---|
| 62 | * The request attribute under which we store the array of X509Certificate |
|---|
| 63 | * objects representing the certificate chain presented by our client, |
|---|
| 64 | * if any. |
|---|
| 65 | */ |
|---|
| 66 | public static final String CERTIFICATES_ATTR = |
|---|
| 67 | "javax.servlet.request.X509Certificate"; |
|---|
| 68 | |
|---|
| 69 | /** |
|---|
| 70 | * SSL Certificate Request Attributite. |
|---|
| 71 | */ |
|---|
| 72 | public static final String SSL_CERTIFICATE_ATTR = "org.apache.coyote.request.X509Certificate"; |
|---|
| 73 | |
|---|
| 74 | /** |
|---|
| 75 | * The request attribute under which we store the name of the cipher suite |
|---|
| 76 | * being used on an SSL connection (as an object of type |
|---|
| 77 | * java.lang.String). |
|---|
| 78 | */ |
|---|
| 79 | public static final String CIPHER_SUITE_ATTR = |
|---|
| 80 | "javax.servlet.request.cipher_suite"; |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | /** |
|---|
| 84 | * The servlet context attribute under which we store the class loader |
|---|
| 85 | * used for loading servlets (as an object of type java.lang.ClassLoader). |
|---|
| 86 | */ |
|---|
| 87 | public static final String CLASS_LOADER_ATTR = |
|---|
| 88 | "org.apache.catalina.classloader"; |
|---|
| 89 | |
|---|
| 90 | /** |
|---|
| 91 | * Request dispatcher state. |
|---|
| 92 | */ |
|---|
| 93 | public static final String DISPATCHER_TYPE_ATTR = |
|---|
| 94 | "org.apache.catalina.core.DISPATCHER_TYPE"; |
|---|
| 95 | |
|---|
| 96 | /** |
|---|
| 97 | * Request dispatcher path. |
|---|
| 98 | */ |
|---|
| 99 | public static final String DISPATCHER_REQUEST_PATH_ATTR = |
|---|
| 100 | "org.apache.catalina.core.DISPATCHER_REQUEST_PATH"; |
|---|
| 101 | |
|---|
| 102 | /** |
|---|
| 103 | * The JNDI directory context which is associated with the context. This |
|---|
| 104 | * context can be used to manipulate static files. |
|---|
| 105 | */ |
|---|
| 106 | public static final String RESOURCES_ATTR = |
|---|
| 107 | "org.apache.catalina.resources"; |
|---|
| 108 | public static final String ALTERNATE_RESOURCES_ATTR = |
|---|
| 109 | "org.apache.catalina.alternateResources"; |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | /** |
|---|
| 113 | * The servlet context attribute under which we store the class path |
|---|
| 114 | * for our application class loader (as an object of type String), |
|---|
| 115 | * delimited with the appropriate path delimiter for this platform. |
|---|
| 116 | */ |
|---|
| 117 | public static final String CLASS_PATH_ATTR = |
|---|
| 118 | "org.apache.catalina.jsp_classpath"; |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | /** |
|---|
| 122 | * The request attribute under which we forward a Java exception |
|---|
| 123 | * (as an object of type Throwable) to an error page. |
|---|
| 124 | */ |
|---|
| 125 | public static final String EXCEPTION_ATTR = |
|---|
| 126 | "javax.servlet.error.exception"; |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | /** |
|---|
| 130 | * The request attribute under which we forward the request URI |
|---|
| 131 | * (as an object of type String) of the page on which an error occurred. |
|---|
| 132 | */ |
|---|
| 133 | public static final String EXCEPTION_PAGE_ATTR = |
|---|
| 134 | "javax.servlet.error.request_uri"; |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | /** |
|---|
| 138 | * The request attribute under which we forward a Java exception type |
|---|
| 139 | * (as an object of type Class) to an error page. |
|---|
| 140 | */ |
|---|
| 141 | public static final String EXCEPTION_TYPE_ATTR = |
|---|
| 142 | "javax.servlet.error.exception_type"; |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | /** |
|---|
| 146 | * The request attribute under which we forward an HTTP status message |
|---|
| 147 | * (as an object of type STring) to an error page. |
|---|
| 148 | */ |
|---|
| 149 | public static final String ERROR_MESSAGE_ATTR = |
|---|
| 150 | "javax.servlet.error.message"; |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | /** |
|---|
| 154 | * The request attribute under which the Invoker servlet will store |
|---|
| 155 | * the invoking servlet path, if it was used to execute a servlet |
|---|
| 156 | * indirectly instead of through a servlet mapping. |
|---|
| 157 | */ |
|---|
| 158 | public static final String INVOKED_ATTR = |
|---|
| 159 | "org.apache.catalina.INVOKED"; |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | /** |
|---|
| 163 | * The request attribute under which we expose the value of the |
|---|
| 164 | * <code><jsp-file></code> value associated with this servlet, |
|---|
| 165 | * if any. |
|---|
| 166 | */ |
|---|
| 167 | public static final String JSP_FILE_ATTR = |
|---|
| 168 | "org.apache.catalina.jsp_file"; |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | /** |
|---|
| 172 | * The request attribute under which we store the key size being used for |
|---|
| 173 | * this SSL connection (as an object of type java.lang.Integer). |
|---|
| 174 | */ |
|---|
| 175 | public static final String KEY_SIZE_ATTR = |
|---|
| 176 | "javax.servlet.request.key_size"; |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | /** |
|---|
| 180 | * The servlet context attribute under which the managed bean Registry |
|---|
| 181 | * will be stored for privileged contexts (if enabled). |
|---|
| 182 | */ |
|---|
| 183 | public static final String MBEAN_REGISTRY_ATTR = |
|---|
| 184 | "org.apache.catalina.Registry"; |
|---|
| 185 | |
|---|
| 186 | |
|---|
| 187 | /** |
|---|
| 188 | * The servlet context attribute under which the MBeanServer will be stored |
|---|
| 189 | * for privileged contexts (if enabled). |
|---|
| 190 | */ |
|---|
| 191 | public static final String MBEAN_SERVER_ATTR = |
|---|
| 192 | "org.apache.catalina.MBeanServer"; |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | /** |
|---|
| 196 | * The request attribute under which we store the servlet name on a |
|---|
| 197 | * named dispatcher request. |
|---|
| 198 | */ |
|---|
| 199 | public static final String NAMED_DISPATCHER_ATTR = |
|---|
| 200 | "org.apache.catalina.NAMED"; |
|---|
| 201 | |
|---|
| 202 | |
|---|
| 203 | /** |
|---|
| 204 | * The request attribute under which the request URI of the included |
|---|
| 205 | * servlet is stored on an included dispatcher request. |
|---|
| 206 | */ |
|---|
| 207 | public static final String INCLUDE_REQUEST_URI_ATTR = |
|---|
| 208 | "javax.servlet.include.request_uri"; |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | /** |
|---|
| 212 | * The request attribute under which the context path of the included |
|---|
| 213 | * servlet is stored on an included dispatcher request. |
|---|
| 214 | */ |
|---|
| 215 | public static final String INCLUDE_CONTEXT_PATH_ATTR = |
|---|
| 216 | "javax.servlet.include.context_path"; |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | /** |
|---|
| 220 | * The request attribute under which the path info of the included |
|---|
| 221 | * servlet is stored on an included dispatcher request. |
|---|
| 222 | */ |
|---|
| 223 | public static final String INCLUDE_PATH_INFO_ATTR = |
|---|
| 224 | "javax.servlet.include.path_info"; |
|---|
| 225 | |
|---|
| 226 | |
|---|
| 227 | /** |
|---|
| 228 | * The request attribute under which the servlet path of the included |
|---|
| 229 | * servlet is stored on an included dispatcher request. |
|---|
| 230 | */ |
|---|
| 231 | public static final String INCLUDE_SERVLET_PATH_ATTR = |
|---|
| 232 | "javax.servlet.include.servlet_path"; |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | /** |
|---|
| 236 | * The request attribute under which the query string of the included |
|---|
| 237 | * servlet is stored on an included dispatcher request. |
|---|
| 238 | */ |
|---|
| 239 | public static final String INCLUDE_QUERY_STRING_ATTR = |
|---|
| 240 | "javax.servlet.include.query_string"; |
|---|
| 241 | |
|---|
| 242 | |
|---|
| 243 | /** |
|---|
| 244 | * The request attribute under which the original request URI is stored |
|---|
| 245 | * on an forwarded dispatcher request. |
|---|
| 246 | */ |
|---|
| 247 | public static final String FORWARD_REQUEST_URI_ATTR = |
|---|
| 248 | "javax.servlet.forward.request_uri"; |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | /** |
|---|
| 252 | * The request attribute under which the original context path is stored |
|---|
| 253 | * on an forwarded dispatcher request. |
|---|
| 254 | */ |
|---|
| 255 | public static final String FORWARD_CONTEXT_PATH_ATTR = |
|---|
| 256 | "javax.servlet.forward.context_path"; |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | /** |
|---|
| 260 | * The request attribute under which the original path info is stored |
|---|
| 261 | * on an forwarded dispatcher request. |
|---|
| 262 | */ |
|---|
| 263 | public static final String FORWARD_PATH_INFO_ATTR = |
|---|
| 264 | "javax.servlet.forward.path_info"; |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | /** |
|---|
| 268 | * The request attribute under which the original servlet path is stored |
|---|
| 269 | * on an forwarded dispatcher request. |
|---|
| 270 | */ |
|---|
| 271 | public static final String FORWARD_SERVLET_PATH_ATTR = |
|---|
| 272 | "javax.servlet.forward.servlet_path"; |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | /** |
|---|
| 276 | * The request attribute under which the original query string is stored |
|---|
| 277 | * on an forwarded dispatcher request. |
|---|
| 278 | */ |
|---|
| 279 | public static final String FORWARD_QUERY_STRING_ATTR = |
|---|
| 280 | "javax.servlet.forward.query_string"; |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | /** |
|---|
| 284 | * The request attribute under which we forward a servlet name to |
|---|
| 285 | * an error page. |
|---|
| 286 | */ |
|---|
| 287 | public static final String SERVLET_NAME_ATTR = |
|---|
| 288 | "javax.servlet.error.servlet_name"; |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | /** |
|---|
| 292 | * The name of the cookie used to pass the session identifier back |
|---|
| 293 | * and forth with the client. |
|---|
| 294 | */ |
|---|
| 295 | public static final String SESSION_COOKIE_NAME = "JSESSIONID"; |
|---|
| 296 | |
|---|
| 297 | |
|---|
| 298 | /** |
|---|
| 299 | * The name of the path parameter used to pass the session identifier |
|---|
| 300 | * back and forth with the client. |
|---|
| 301 | */ |
|---|
| 302 | public static final String SESSION_PARAMETER_NAME = "jsessionid"; |
|---|
| 303 | |
|---|
| 304 | |
|---|
| 305 | /** |
|---|
| 306 | * The request attribute under which we forward an HTTP status code |
|---|
| 307 | * (as an object of type Integer) to an error page. |
|---|
| 308 | */ |
|---|
| 309 | public static final String STATUS_CODE_ATTR = |
|---|
| 310 | "javax.servlet.error.status_code"; |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | /** |
|---|
| 314 | * The subject under which the AccessControlContext is running. |
|---|
| 315 | */ |
|---|
| 316 | public static final String SUBJECT_ATTR = |
|---|
| 317 | "javax.security.auth.subject"; |
|---|
| 318 | |
|---|
| 319 | |
|---|
| 320 | /** |
|---|
| 321 | * The servlet context attribute under which we record the set of |
|---|
| 322 | * welcome files (as an object of type String[]) for this application. |
|---|
| 323 | */ |
|---|
| 324 | public static final String WELCOME_FILES_ATTR = |
|---|
| 325 | "org.apache.catalina.WELCOME_FILES"; |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | /** |
|---|
| 329 | * The servlet context attribute under which we store a temporary |
|---|
| 330 | * working directory (as an object of type File) for use by servlets |
|---|
| 331 | * within this web application. |
|---|
| 332 | */ |
|---|
| 333 | public static final String WORK_DIR_ATTR = |
|---|
| 334 | "javax.servlet.context.tempdir"; |
|---|
| 335 | |
|---|
| 336 | |
|---|
| 337 | /** |
|---|
| 338 | * Has security been turned on? |
|---|
| 339 | */ |
|---|
| 340 | public static final boolean IS_SECURITY_ENABLED = |
|---|
| 341 | (System.getSecurityManager() != null); |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | // START GlassFish 740 |
|---|
| 345 | public static final String JSP_PROPERTY_GROUPS_CONTEXT_ATTRIBUTE = |
|---|
| 346 | "com.sun.jsp.propertyGroups"; |
|---|
| 347 | |
|---|
| 348 | public static final String WEB_XML_VERSION_CONTEXT_ATTRIBUTE = |
|---|
| 349 | "com.sun.servlet.webxml.version"; |
|---|
| 350 | // END GlassFish 740 |
|---|
| 351 | |
|---|
| 352 | // START GlassFish 747 |
|---|
| 353 | public static final String JSP_TLD_URI_TO_LOCATION_MAP = |
|---|
| 354 | "com.sun.jsp.tldUriToLocationMap"; |
|---|
| 355 | // END GlassFish 747 |
|---|
| 356 | |
|---|
| 357 | // START GlassFish 896 |
|---|
| 358 | public static final String SESSION_TRACKER = |
|---|
| 359 | "com.sun.enterprise.http.sessionTracker"; |
|---|
| 360 | // END GlassFish 896 |
|---|
| 361 | |
|---|
| 362 | /** |
|---|
| 363 | * The name of the cookie used to carry a session's version info |
|---|
| 364 | */ |
|---|
| 365 | public static final String SESSION_VERSION_COOKIE_NAME = |
|---|
| 366 | "JSESSIONIDVERSION"; |
|---|
| 367 | |
|---|
| 368 | /** |
|---|
| 369 | * The name of the path parameter used to carry a session's version info |
|---|
| 370 | */ |
|---|
| 371 | public static final String SESSION_VERSION_PARAMETER_NAME = |
|---|
| 372 | "jsessionidversion"; |
|---|
| 373 | |
|---|
| 374 | public static final String SESSION_VERSION_PARAMETER = |
|---|
| 375 | ";" + SESSION_VERSION_PARAMETER_NAME + "="; |
|---|
| 376 | |
|---|
| 377 | public static final String SESSION_VERSIONS_REQUEST_ATTRIBUTE = |
|---|
| 378 | "com.sun.enterprise.http.sessionVersions"; |
|---|
| 379 | |
|---|
| 380 | public static final String WRAPPED_REQUEST = |
|---|
| 381 | "__javax.security.auth.message.request"; |
|---|
| 382 | |
|---|
| 383 | public static final String WRAPPED_RESPONSE = |
|---|
| 384 | "__javax.security.auth.message.response"; |
|---|
| 385 | |
|---|
| 386 | |
|---|
| 387 | /** |
|---|
| 388 | * The servlet context attribute under which we store a flag used |
|---|
| 389 | * to mark this request as having been processed by the SSIServlet. |
|---|
| 390 | * We do this because of the pathInfo mangling happening when using |
|---|
| 391 | * the CGIServlet in conjunction with the SSI servlet. (value stored |
|---|
| 392 | * as an object of type String) |
|---|
| 393 | */ |
|---|
| 394 | public static final String SSI_FLAG_ATTR = |
|---|
| 395 | "org.apache.catalina.ssi.SSIServlet"; |
|---|
| 396 | |
|---|
| 397 | /** |
|---|
| 398 | * Request path. |
|---|
| 399 | */ |
|---|
| 400 | public static final String CONSTRAINT_URI = |
|---|
| 401 | "org.apache.catalina.CONSTRAINT_URI"; |
|---|
| 402 | } |
|---|