Top Description Fields Constructors Methods
org.apache.catalina

public final Class Globals

extends Object
Class Inheritance

Global constants that are applicable to multiple packages within Catalina.
Author
Craig R. McClanahan

Field Summary

Modifier and TypeField and Description
public static final String
ALT_DD_ATTR

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

public static final String
public static final String
CATALINA_BASE_PROP

Name of the system property containing the tomcat instance installation path

public static final String
CATALINA_HOME_PROP

Name of the system property containing the tomcat product installation path

public static final 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.

public static final 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 String).

public static final 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.

public static final String
CREDENTIAL_HANDLER

Name of the ServletContext attribute under which we store the context Realm's CredentialHandler (if both the Realm and the CredentialHandler exist).

public static final String
DEFAULT_MBEAN_DOMAIN

Default domain for MBeans if none can be determined

public static final String
DISPATCHER_REQUEST_PATH_ATTR

Request dispatcher path.

public static final String
DISPATCHER_TYPE_ATTR

Request dispatcher state.

public static final String
public static final boolean
IS_SECURITY_ENABLED

Has security been turned on?

public static final String
JASPER_XML_BLOCK_EXTERNAL_INIT_PARAM

Name of the ServletContext init-param that determines if the JSP engine will block external entities from being used in *.tld, *.jspx, *.tagx and tagplugin.xml files.

public static final String
JASPER_XML_VALIDATION_TLD_INIT_PARAM

Name of the ServletContext init-param that determines if the JSP engine should validate *.tld files when parsing them.

public static final 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 Integer).

public static final String
NAMED_DISPATCHER_ATTR

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

public static final 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.

public static final String
PARAMETER_PARSE_FAILED_REASON_ATTR

The reason that the parameter parsing failed.

public static final String
REMOTE_ADDR_ATTRIBUTE

The request attribute set by the RemoteIpFilter, RemoteIpValve (and may be set by other similar components) that identifies for the connector the remote IP address claimed to be associated with this request when a request is received via one or more proxies.

public static final String
REMOTE_IP_FILTER_SECURE

The request attribute that is set to the value of Boolean.TRUE if org.apache.catalina.filters.RemoteIpFilter determines that this request was submitted via a secure channel.

public static final String
REQUEST_FORWARDED_ATTRIBUTE

The request attribute that is set to the value of Boolean.TRUE by the RemoteIpFilter, RemoteIpValve (and other similar components) that identifies a request which been forwarded via one or more proxies.

public static final String
RESOURCES_ATTR

The WebResourceRoot which is associated with the context.

public static final String
SENDFILE_FILE_END_ATTR

The request attribute that can be used by a servlet to pass to the connector the end offset (not including) of the part of a file that is to be served by sendfile.

public static final String
SENDFILE_FILE_START_ATTR

The request attribute that can be used by a servlet to pass to the connector the start offset of the part of a file that is to be served by sendfile.

public static final String
SENDFILE_FILENAME_ATTR

The request attribute that can be used by a servlet to pass to the connector the name of the file that is to be served by sendfile.

public static final String
SENDFILE_SUPPORTED_ATTR

The request attribute that is set to the value of Boolean.TRUE if connector processing this request supports use of sendfile.

public static final 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 String).

public static final String
SSL_SESSION_MGR_ATTR

The request attribute key for the session manager.

public static final boolean
STRICT_SERVLET_COMPLIANCE

The flag which controls strict servlet specification compliance.

public static final String
SUBJECT_ATTR

The subject under which the AccessControlContext is running.

public static final String
WEBAPP_VERSION

Name of the ServletContext attribute under which we store the web application version string (the text that appears after ## when parallel deployment is used).

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ALT_DD_ATTRback to summary
public static final String ALT_DD_ATTR

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

ASYNC_SUPPORTED_ATTRback to summary
public static final String ASYNC_SUPPORTED_ATTR
CATALINA_BASE_PROPback to summary
public static final String CATALINA_BASE_PROP

Name of the system property containing the tomcat instance installation path

CATALINA_HOME_PROPback to summary
public static final String CATALINA_HOME_PROP

Name of the system property containing the tomcat product installation path

CERTIFICATES_ATTRback to summary
public static final 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.

CIPHER_SUITE_ATTRback to summary
public static final 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 String).

CLASS_PATH_ATTRback to summary
public static final 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.

CREDENTIAL_HANDLERback to summary
public static final String CREDENTIAL_HANDLER

Name of the ServletContext attribute under which we store the context Realm's CredentialHandler (if both the Realm and the CredentialHandler exist).

DEFAULT_MBEAN_DOMAINback to summary
public static final String DEFAULT_MBEAN_DOMAIN

Default domain for MBeans if none can be determined

DISPATCHER_REQUEST_PATH_ATTRback to summary
public static final String DISPATCHER_REQUEST_PATH_ATTR

Request dispatcher path.

DISPATCHER_TYPE_ATTRback to summary
public static final String DISPATCHER_TYPE_ATTR

Request dispatcher state.

GSS_CREDENTIAL_ATTRback to summary
public static final String GSS_CREDENTIAL_ATTR
IS_SECURITY_ENABLEDback to summary
public static final boolean IS_SECURITY_ENABLED

Has security been turned on?

JASPER_XML_BLOCK_EXTERNAL_INIT_PARAMback to summary
public static final String JASPER_XML_BLOCK_EXTERNAL_INIT_PARAM

Name of the ServletContext init-param that determines if the JSP engine will block external entities from being used in *.tld, *.jspx, *.tagx and tagplugin.xml files.

This must be kept in sync with org.apache.jasper.Constants

JASPER_XML_VALIDATION_TLD_INIT_PARAMback to summary
public static final String JASPER_XML_VALIDATION_TLD_INIT_PARAM

Name of the ServletContext init-param that determines if the JSP engine should validate *.tld files when parsing them.

This must be kept in sync with org.apache.jasper.Constants

KEY_SIZE_ATTRback to summary
public static final 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 Integer).

NAMED_DISPATCHER_ATTRback to summary
public static final String NAMED_DISPATCHER_ATTR

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

PARAMETER_PARSE_FAILED_ATTRback to summary
public static final 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.

PARAMETER_PARSE_FAILED_REASON_ATTRback to summary
public static final String PARAMETER_PARSE_FAILED_REASON_ATTR

The reason that the parameter parsing failed.

REMOTE_ADDR_ATTRIBUTEback to summary
public static final String REMOTE_ADDR_ATTRIBUTE

The request attribute set by the RemoteIpFilter, RemoteIpValve (and may be set by other similar components) that identifies for the connector the remote IP address claimed to be associated with this request when a request is received via one or more proxies. It is typically provided via the X-Forwarded-For HTTP header. Duplicated here for neater code in the catalina packages.

REMOTE_IP_FILTER_SECUREback to summary
public static final String REMOTE_IP_FILTER_SECURE

The request attribute that is set to the value of Boolean.TRUE if org.apache.catalina.filters.RemoteIpFilter determines that this request was submitted via a secure channel.

REQUEST_FORWARDED_ATTRIBUTEback to summary
public static final String REQUEST_FORWARDED_ATTRIBUTE

The request attribute that is set to the value of Boolean.TRUE by the RemoteIpFilter, RemoteIpValve (and other similar components) that identifies a request which been forwarded via one or more proxies.

RESOURCES_ATTRback to summary
public static final String RESOURCES_ATTR

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

SENDFILE_FILE_END_ATTRback to summary
public static final String SENDFILE_FILE_END_ATTR

The request attribute that can be used by a servlet to pass to the connector the end offset (not including) of the part of a file that is to be served by sendfile. The value should be java.lang.Long. To serve complete file the value should be equal to the length of the file. Duplicated here for neater code in the catalina packages.

SENDFILE_FILE_START_ATTRback to summary
public static final String SENDFILE_FILE_START_ATTR

The request attribute that can be used by a servlet to pass to the connector the start offset of the part of a file that is to be served by sendfile. The value should be Long. To serve complete file the value should be Long.valueOf(0). Duplicated here for neater code in the catalina packages.

SENDFILE_FILENAME_ATTRback to summary
public static final String SENDFILE_FILENAME_ATTR

The request attribute that can be used by a servlet to pass to the connector the name of the file that is to be served by sendfile. The value should be String that is File.getCanonicalPath() of the file to be served. Duplicated here for neater code in the catalina packages.

SENDFILE_SUPPORTED_ATTRback to summary
public static final String SENDFILE_SUPPORTED_ATTR

The request attribute that is set to the value of Boolean.TRUE if connector processing this request supports use of sendfile. Duplicated here for neater code in the catalina packages.

SSL_SESSION_ID_ATTRback to summary
public static final 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 String).

SSL_SESSION_MGR_ATTRback to summary
public static final String SSL_SESSION_MGR_ATTR

The request attribute key for the session manager. This one is a Tomcat extension to the Servlet spec.

STRICT_SERVLET_COMPLIANCEback to summary
public static final boolean STRICT_SERVLET_COMPLIANCE

The flag which controls strict servlet specification compliance. Setting this flag to true will change the defaults for other settings.

SUBJECT_ATTRback to summary
public static final String SUBJECT_ATTR

The subject under which the AccessControlContext is running.

WEBAPP_VERSIONback to summary
public static final String WEBAPP_VERSION

Name of the ServletContext attribute under which we store the web application version string (the text that appears after ## when parallel deployment is used).

Constructor Detail

Globalsback to summary
public Globals()