org.apache.catalina
Class Globals

java.lang.Object
  org.apache.catalina.Globals

public final class Globals

extends java.lang.Object

Global constants that are applicable to multiple packages within Catalina.

Version:

$Id: Globals.java 1221282 2011-12-20 14:34:48Z jim $

Author:

Craig R. McClanahan

Field Summary

static java.lang.String	ALT_DD_ATTR The servlet context attribute under which we store the alternate deployment descriptor for this web application
static java.lang.String	CERTIFICATES_ATTR The request attribute under which we store the array of X509Certificate objects representing the certificate chain presented by our client, if any.
static java.lang.String	CIPHER_SUITE_ATTR The request attribute under which we store the name of the cipher suite being used on an SSL connection (as an object of type java.lang.String).
static java.lang.String	CLASS_LOADER_ATTR The servlet context attribute under which we store the class loader used for loading servlets (as an object of type java.lang.ClassLoader).
static java.lang.String	CLASS_PATH_ATTR The servlet context attribute under which we store the class path for our application class loader (as an object of type String), delimited with the appropriate path delimiter for this platform.
static java.lang.String	DISPATCHER_REQUEST_PATH_ATTR Request dispatcher path.
static java.lang.String	DISPATCHER_TYPE_ATTR Request dispatcher state.
static java.lang.String	ERROR_MESSAGE_ATTR The request attribute under which we forward an HTTP status message (as an object of type STring) to an error page.
static java.lang.String	EXCEPTION_ATTR The request attribute under which we forward a Java exception (as an object of type Throwable) to an error page.
static java.lang.String	EXCEPTION_PAGE_ATTR The request attribute under which we forward the request URI (as an object of type String) of the page on which an error occurred.
static java.lang.String	EXCEPTION_TYPE_ATTR The request attribute under which we forward a Java exception type (as an object of type Class) to an error page.
static java.lang.String	FORWARD_CONTEXT_PATH_ATTR The request attribute under which the original context path is stored on an forwarded dispatcher request.
static java.lang.String	FORWARD_PATH_INFO_ATTR The request attribute under which the original path info is stored on an forwarded dispatcher request.
static java.lang.String	FORWARD_QUERY_STRING_ATTR The request attribute under which the original query string is stored on an forwarded dispatcher request.
static java.lang.String	FORWARD_REQUEST_URI_ATTR The request attribute under which the original request URI is stored on an forwarded dispatcher request.
static java.lang.String	FORWARD_SERVLET_PATH_ATTR The request attribute under which the original servlet path is stored on an forwarded dispatcher request.
static java.lang.String	INCLUDE_CONTEXT_PATH_ATTR The request attribute under which the context path of the included servlet is stored on an included dispatcher request.
static java.lang.String	INCLUDE_PATH_INFO_ATTR The request attribute under which the path info of the included servlet is stored on an included dispatcher request.
static java.lang.String	INCLUDE_QUERY_STRING_ATTR The request attribute under which the query string of the included servlet is stored on an included dispatcher request.
static java.lang.String	INCLUDE_REQUEST_URI_ATTR The request attribute under which the request URI of the included servlet is stored on an included dispatcher request.
static java.lang.String	INCLUDE_SERVLET_PATH_ATTR The request attribute under which the servlet path of the included servlet is stored on an included dispatcher request.
static java.lang.String	INVOKED_ATTR The request attribute under which the Invoker servlet will store the invoking servlet path, if it was used to execute a servlet indirectly instead of through a servlet mapping.
static java.lang.String	JSP_FILE_ATTR The request attribute under which we expose the value of the <jsp-file> value associated with this servlet, if any.
static java.lang.String	KEY_SIZE_ATTR The request attribute under which we store the key size being used for this SSL connection (as an object of type java.lang.Integer).
static java.lang.String	MBEAN_REGISTRY_ATTR The servlet context attribute under which the managed bean Registry will be stored for privileged contexts (if enabled).
static java.lang.String	MBEAN_SERVER_ATTR The servlet context attribute under which the MBeanServer will be stored for privileged contexts (if enabled).
static java.lang.String	NAMED_DISPATCHER_ATTR The request attribute under which we store the servlet name on a named dispatcher request.
static java.lang.String	PARAMETER_PARSE_FAILED_ATTR The request attribute that is set to Boolean.TRUE if some request parameters have been ignored during request parameters parsing.
static java.lang.String	RESOURCES_ATTR The JNDI directory context which is associated with the context.
static java.lang.String	SERVLET_NAME_ATTR The request attribute under which we forward a servlet name to an error page.
static java.lang.String	SESSION_COOKIE_NAME The name of the cookie used to pass the session identifier back and forth with the client.
static java.lang.String	SESSION_PARAMETER_NAME The name of the path parameter used to pass the session identifier back and forth with the client.
static java.lang.String	SSI_FLAG_ATTR The servlet context attribute under which we store a flag used to mark this request as having been processed by the SSIServlet.
static java.lang.String	SSL_SESSION_ID_ATTR The request attribute under which we store the session id being used for this SSL connection (as an object of type java.lang.String).
static java.lang.String	STATUS_CODE_ATTR The request attribute under which we forward an HTTP status code (as an object of type Integer) to an error page.
static boolean	STRICT_SERVLET_COMPLIANCE The master flag which controls strict servlet specification compliance.
static java.lang.String	SUBJECT_ATTR The subject under which the AccessControlContext is running.
static java.lang.String	WELCOME_FILES_ATTR The servlet context attribute under which we record the set of welcome files (as an object of type String[]) for this application.
static java.lang.String	WORK_DIR_ATTR The servlet context attribute under which we store a temporary working directory (as an object of type File) for use by servlets within this web application.

Constructor Summary

Globals()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALT_DD_ATTR

public static final java.lang.String ALT_DD_ATTR

The servlet context attribute under which we store the alternate deployment descriptor for this web application

See Also:

Constant Field Values

CERTIFICATES_ATTR

public static final java.lang.String CERTIFICATES_ATTR

The request attribute under which we store the array of X509Certificate objects representing the certificate chain presented by our client, if any.

See Also:

Constant Field Values

CIPHER_SUITE_ATTR

public static final java.lang.String CIPHER_SUITE_ATTR

The request attribute under which we store the name of the cipher suite being used on an SSL connection (as an object of type java.lang.String).

See Also:

Constant Field Values

CLASS_LOADER_ATTR

public static final java.lang.String CLASS_LOADER_ATTR

The servlet context attribute under which we store the class loader used for loading servlets (as an object of type java.lang.ClassLoader).

See Also:

Constant Field Values

DISPATCHER_TYPE_ATTR

public static final java.lang.String DISPATCHER_TYPE_ATTR

Request dispatcher state.

See Also:

Constant Field Values

DISPATCHER_REQUEST_PATH_ATTR

public static final java.lang.String DISPATCHER_REQUEST_PATH_ATTR

Request dispatcher path.

See Also:

Constant Field Values

RESOURCES_ATTR

public static final java.lang.String RESOURCES_ATTR

The JNDI directory context which is associated with the context. This context can be used to manipulate static files.

See Also:

Constant Field Values

CLASS_PATH_ATTR

public static final java.lang.String CLASS_PATH_ATTR

The servlet context attribute under which we store the class path for our application class loader (as an object of type String), delimited with the appropriate path delimiter for this platform.

See Also:

Constant Field Values

EXCEPTION_ATTR

public static final java.lang.String EXCEPTION_ATTR

The request attribute under which we forward a Java exception (as an object of type Throwable) to an error page.

See Also:

Constant Field Values

EXCEPTION_PAGE_ATTR

public static final java.lang.String EXCEPTION_PAGE_ATTR

The request attribute under which we forward the request URI (as an object of type String) of the page on which an error occurred.

See Also:

Constant Field Values

EXCEPTION_TYPE_ATTR

public static final java.lang.String EXCEPTION_TYPE_ATTR

The request attribute under which we forward a Java exception type (as an object of type Class) to an error page.

See Also:

Constant Field Values

ERROR_MESSAGE_ATTR

public static final java.lang.String ERROR_MESSAGE_ATTR

The request attribute under which we forward an HTTP status message (as an object of type STring) to an error page.

See Also:

Constant Field Values

INVOKED_ATTR

public static final java.lang.String INVOKED_ATTR

The request attribute under which the Invoker servlet will store the invoking servlet path, if it was used to execute a servlet indirectly instead of through a servlet mapping.

See Also:

Constant Field Values

JSP_FILE_ATTR

public static final java.lang.String JSP_FILE_ATTR

The request attribute under which we expose the value of the <jsp-file> value associated with this servlet, if any.

See Also:

Constant Field Values

KEY_SIZE_ATTR

public static final java.lang.String KEY_SIZE_ATTR

The request attribute under which we store the key size being used for this SSL connection (as an object of type java.lang.Integer).

See Also:

Constant Field Values

SSL_SESSION_ID_ATTR

public static final java.lang.String SSL_SESSION_ID_ATTR

The request attribute under which we store the session id being used for this SSL connection (as an object of type java.lang.String).

See Also:

Constant Field Values

MBEAN_REGISTRY_ATTR

public static final java.lang.String MBEAN_REGISTRY_ATTR

The servlet context attribute under which the managed bean Registry will be stored for privileged contexts (if enabled).

See Also:

Constant Field Values

MBEAN_SERVER_ATTR

public static final java.lang.String MBEAN_SERVER_ATTR

The servlet context attribute under which the MBeanServer will be stored for privileged contexts (if enabled).

See Also:

Constant Field Values

NAMED_DISPATCHER_ATTR

public static final java.lang.String NAMED_DISPATCHER_ATTR

The request attribute under which we store the servlet name on a named dispatcher request.

See Also:

Constant Field Values

INCLUDE_REQUEST_URI_ATTR

public static final java.lang.String INCLUDE_REQUEST_URI_ATTR

The request attribute under which the request URI of the included servlet is stored on an included dispatcher request.

See Also:

Constant Field Values

INCLUDE_CONTEXT_PATH_ATTR

public static final java.lang.String INCLUDE_CONTEXT_PATH_ATTR

The request attribute under which the context path of the included servlet is stored on an included dispatcher request.

See Also:

Constant Field Values

INCLUDE_PATH_INFO_ATTR

public static final java.lang.String INCLUDE_PATH_INFO_ATTR

The request attribute under which the path info of the included servlet is stored on an included dispatcher request.

See Also:

Constant Field Values

INCLUDE_SERVLET_PATH_ATTR

public static final java.lang.String INCLUDE_SERVLET_PATH_ATTR

The request attribute under which the servlet path of the included servlet is stored on an included dispatcher request.

See Also:

Constant Field Values

INCLUDE_QUERY_STRING_ATTR

public static final java.lang.String INCLUDE_QUERY_STRING_ATTR

The request attribute under which the query string of the included servlet is stored on an included dispatcher request.

See Also:

Constant Field Values

FORWARD_REQUEST_URI_ATTR

public static final java.lang.String FORWARD_REQUEST_URI_ATTR

The request attribute under which the original request URI is stored on an forwarded dispatcher request.

See Also:

Constant Field Values

FORWARD_CONTEXT_PATH_ATTR

public static final java.lang.String FORWARD_CONTEXT_PATH_ATTR

The request attribute under which the original context path is stored on an forwarded dispatcher request.

See Also:

Constant Field Values

FORWARD_PATH_INFO_ATTR

public static final java.lang.String FORWARD_PATH_INFO_ATTR

The request attribute under which the original path info is stored on an forwarded dispatcher request.

See Also:

Constant Field Values

FORWARD_SERVLET_PATH_ATTR

public static final java.lang.String FORWARD_SERVLET_PATH_ATTR

The request attribute under which the original servlet path is stored on an forwarded dispatcher request.

See Also:

Constant Field Values

FORWARD_QUERY_STRING_ATTR

public static final java.lang.String FORWARD_QUERY_STRING_ATTR

The request attribute under which the original query string is stored on an forwarded dispatcher request.

See Also:

Constant Field Values

SERVLET_NAME_ATTR

public static final java.lang.String SERVLET_NAME_ATTR

The request attribute under which we forward a servlet name to an error page.

See Also:

Constant Field Values

SESSION_COOKIE_NAME

public static final java.lang.String SESSION_COOKIE_NAME

The name of the cookie used to pass the session identifier back and forth with the client.

SESSION_PARAMETER_NAME

public static final java.lang.String SESSION_PARAMETER_NAME

The name of the path parameter used to pass the session identifier back and forth with the client.

SSI_FLAG_ATTR

public static final java.lang.String SSI_FLAG_ATTR

The servlet context attribute under which we store a flag used to mark this request as having been processed by the SSIServlet. We do this because of the pathInfo mangling happening when using the CGIServlet in conjunction with the SSI servlet. (value stored as an object of type String)

See Also:

Constant Field Values

STATUS_CODE_ATTR

public static final java.lang.String STATUS_CODE_ATTR

The request attribute under which we forward an HTTP status code (as an object of type Integer) to an error page.

See Also:

Constant Field Values

SUBJECT_ATTR

public static final java.lang.String SUBJECT_ATTR

The subject under which the AccessControlContext is running.

See Also:

Constant Field Values

WELCOME_FILES_ATTR

public static final java.lang.String WELCOME_FILES_ATTR

The servlet context attribute under which we record the set of welcome files (as an object of type String[]) for this application.

See Also:

Constant Field Values

WORK_DIR_ATTR

public static final java.lang.String WORK_DIR_ATTR

The servlet context attribute under which we store a temporary working directory (as an object of type File) for use by servlets within this web application.

See Also:

Constant Field Values

PARAMETER_PARSE_FAILED_ATTR

public static final java.lang.String PARAMETER_PARSE_FAILED_ATTR

The request attribute that is set to Boolean.TRUE if some request parameters have been ignored during request parameters parsing. It can happen, for example, if there is a limit on the total count of parseable parameters, or if parameter cannot be decoded, or any other error happened during parameter parsing.

See Also:

Constant Field Values

STRICT_SERVLET_COMPLIANCE

public static final boolean STRICT_SERVLET_COMPLIANCE

The master flag which controls strict servlet specification compliance.

Constructor Detail

Globals

public Globals()