Package org.apache.catalina
Class Globals
java.lang.Object
org.apache.catalina.Globals
Global constants that are applicable to multiple packages within Catalina.
- Author:
- Craig R. McClanahan
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The servlet context attribute under which we store the alternate deployment descriptor for this web applicationstatic final String
static final String
Name of the system property containing the tomcat instance installation pathstatic final String
Name of the system property containing the tomcat product installation pathstatic final String
The request attribute under which we store the array of X509Certificate objects representing the certificate chain presented by our client, if any.static final String
The request attribute under which we store the name of the cipher suite being used on an SSL connection (as an object of typeString
).static final String
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 final String
The request attribute used to expose the current connection ID associated with the request, if any.static final String
Name of the ServletContext attribute under which we store the context Realm's CredentialHandler (if both the Realm and the CredentialHandler exist).static final String
Default domain for MBeans if none can be determinedstatic final String
Request dispatcher path.static final String
Request dispatcher state.static final String
static final boolean
Has security been turned on?static final String
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.static final String
Name of the ServletContext init-param that determines if the JSP engine should validate *.tld files when parsing them.static final String
The request attribute under which we store the key size being used for this SSL connection (as an object of typeInteger
).static final String
The request attribute under which we store the servlet name on a named dispatcher request.static final String
The request attribute that is set toBoolean.TRUE
if some request parameters have been ignored during request parameters parsing.static final String
The reason that the parameter parsing failed.static final String
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.static final String
The request attribute that is set to the value ofBoolean.TRUE
ifRemoteIpFilter
determines that this request was submitted via a secure channel.static final String
The request attribute that is set to the value ofBoolean.TRUE
by the RemoteIpFilter, RemoteIpValve (and other similar components) that identifies a request which been forwarded via one or more proxies.static final String
The WebResourceRoot which is associated with the context.static final String
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.static final String
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.static final String
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.static final String
The request attribute that is set to the value ofBoolean.TRUE
if connector processing this request supports use of sendfile.static final String
Deprecated.Unused.static final String
The request attribute under which we store the session id being used for this SSL connection (as an object of typeString
).static final String
The request attribute key for the session manager.static final String
The request attribute used to expose the current stream ID associated with the request, if any.static final boolean
The flag which controls strict servlet specification compliance.static final String
The subject under which the AccessControlContext is running.static final String
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
-
Method Summary
-
Field Details
-
ASYNC_SUPPORTED_ATTR
- See Also:
-
GSS_CREDENTIAL_ATTR
- See Also:
-
DISPATCHER_TYPE_ATTR
Request dispatcher state.- See Also:
-
DISPATCHER_REQUEST_PATH_ATTR
Request dispatcher path.- See Also:
-
NAMED_DISPATCHER_ATTR
The request attribute under which we store the servlet name on a named dispatcher request.- See Also:
-
CONNECTION_ID
The request attribute used to expose the current connection ID associated with the request, if any. Used with multiplexing protocols such as HTTTP/2.- See Also:
-
STREAM_ID
The request attribute used to expose the current stream ID associated with the request, if any. Used with multiplexing protocols such as HTTTP/2.- See Also:
-
PARAMETER_PARSE_FAILED_ATTR
The request attribute that is set toBoolean.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:
-
PARAMETER_PARSE_FAILED_REASON_ATTR
The reason that the parameter parsing failed.- See Also:
-
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.- See Also:
-
REQUEST_FORWARDED_ATTRIBUTE
The request attribute that is set to the value ofBoolean.TRUE
by the RemoteIpFilter, RemoteIpValve (and other similar components) that identifies a request which been forwarded via one or more proxies.- See Also:
-
SENDFILE_SUPPORTED_ATTR
The request attribute that is set to the value ofBoolean.TRUE
if connector processing this request supports use of sendfile. Duplicated here for neater code in the catalina packages.- See Also:
-
REMOTE_IP_FILTER_SECURE
The request attribute that is set to the value ofBoolean.TRUE
ifRemoteIpFilter
determines that this request was submitted via a secure channel.- See Also:
-
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 beString
that isFile.getCanonicalPath()
of the file to be served. Duplicated here for neater code in the catalina packages.- See Also:
-
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 beLong
. To serve complete file the value should beLong.valueOf(0)
. Duplicated here for neater code in the catalina packages.- See Also:
-
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 bejava.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.- See Also:
-
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:
-
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 typeString
).- See Also:
-
KEY_SIZE_ATTR
The request attribute under which we store the key size being used for this SSL connection (as an object of typeInteger
).- See Also:
-
SSL_SESSION_ID_ATTR
The request attribute under which we store the session id being used for this SSL connection (as an object of typeString
).- See Also:
-
SSL_SESSION_MGR_ATTR
The request attribute key for the session manager. This one is a Tomcat extension to the Servlet spec.- See Also:
-
SUBJECT_ATTR
The subject under which the AccessControlContext is running.- See Also:
-
ALT_DD_ATTR
The servlet context attribute under which we store the alternate deployment descriptor for this web application- See Also:
-
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:
-
CREDENTIAL_HANDLER
Name of the ServletContext attribute under which we store the context Realm's CredentialHandler (if both the Realm and the CredentialHandler exist).- See Also:
-
RESOURCES_ATTR
The WebResourceRoot which is associated with the context. This can be used to manipulate static files.- See Also:
-
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).- See Also:
-
SSI_FLAG_ATTR
Deprecated.Unused. This is no longer used as the CGIO servlet now has generic handling for when it is used as an include. This will be removed in Tomcat 10The 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:
-
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
- See Also:
-
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
- See Also:
-
CATALINA_HOME_PROP
Name of the system property containing the tomcat product installation path- See Also:
-
CATALINA_BASE_PROP
Name of the system property containing the tomcat instance installation path- See Also:
-
STRICT_SERVLET_COMPLIANCE
public static final boolean STRICT_SERVLET_COMPLIANCEThe flag which controls strict servlet specification compliance. Setting this flag totrue
will change the defaults for other settings. -
IS_SECURITY_ENABLED
public static final boolean IS_SECURITY_ENABLEDHas security been turned on? -
DEFAULT_MBEAN_DOMAIN
Default domain for MBeans if none can be determined- See Also:
-
-
Constructor Details
-
Globals
public Globals()
-