Index (Servlet 3.1 API Documentation - Apache Tomcat 8.5.57)

A B C D E F G H I J L M O P R S T U V W

## A

addCookie(Cookie) - Method in interface javax.servlet.http.HttpServletResponse
  Adds the specified cookie to the response.
addCookie(Cookie) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call addCookie(Cookie cookie) on the wrapped response object.
addDateHeader(String, long) - Method in interface javax.servlet.http.HttpServletResponse
  Adds a response header with the given name and date-value.
addDateHeader(String, long) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call addDateHeader(String name, long date) on the wrapped response object.
addFilter(String, String) - Method in interface javax.servlet.ServletContext
  Add filter to context.
addFilter(String, Filter) - Method in interface javax.servlet.ServletContext
  Add filter to context.
addFilter(String, Class<? extends Filter>) - Method in interface javax.servlet.ServletContext
  Add filter to context.
addHeader(String, String) - Method in interface javax.servlet.http.HttpServletResponse
  Adds a response header with the given name and value.
addHeader(String, String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to return addHeader(String name, String value) on the wrapped response object.
addIntHeader(String, int) - Method in interface javax.servlet.http.HttpServletResponse
  Adds a response header with the given name and integer value.
addIntHeader(String, int) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call addIntHeader(String name, int value) on the wrapped response object.
addListener(AsyncListener) - Method in interface javax.servlet.AsyncContext
addListener(AsyncListener, ServletRequest, ServletResponse) - Method in interface javax.servlet.AsyncContext
addListener(String) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
addListener(T) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
addListener(Class<? extends EventListener>) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
addMapping(String...) - Method in interface javax.servlet.ServletRegistration
  TODO
addMappingForServletNames(EnumSet<DispatcherType>, boolean, String...) - Method in interface javax.servlet.FilterRegistration
  Add a mapping for this filter to one or more named Servlets.
addMappingForUrlPatterns(EnumSet<DispatcherType>, boolean, String...) - Method in interface javax.servlet.FilterRegistration
  Add a mapping for this filter to one or more URL patterns.
addServlet(String, String) - Method in interface javax.servlet.ServletContext
  Register a servlet implementation for use in this ServletContext.
addServlet(String, Servlet) - Method in interface javax.servlet.ServletContext
  Register a servlet instance for use in this ServletContext.
addServlet(String, Class<? extends Servlet>) - Method in interface javax.servlet.ServletContext
  Add servlet to context.
ASYNC_CONTEXT_PATH - Static variable in interface javax.servlet.AsyncContext
ASYNC_PATH_INFO - Static variable in interface javax.servlet.AsyncContext
ASYNC_QUERY_STRING - Static variable in interface javax.servlet.AsyncContext
ASYNC_REQUEST_URI - Static variable in interface javax.servlet.AsyncContext
ASYNC_SERVLET_PATH - Static variable in interface javax.servlet.AsyncContext
AsyncContext - Interface in javax.servlet
  TODO SERVLET3 - Add comments
AsyncEvent - Class in javax.servlet
  TODO SERVLET3 - Add comments
AsyncEvent(AsyncContext) - Constructor for class javax.servlet.AsyncEvent
AsyncEvent(AsyncContext, ServletRequest, ServletResponse) - Constructor for class javax.servlet.AsyncEvent
AsyncEvent(AsyncContext, Throwable) - Constructor for class javax.servlet.AsyncEvent
AsyncEvent(AsyncContext, ServletRequest, ServletResponse, Throwable) - Constructor for class javax.servlet.AsyncEvent
AsyncListener - Interface in javax.servlet
  TODO SERVLET3 - Add comments
attributeAdded(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener
  Notification that an attribute has been added to a session.
attributeAdded(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener
  Notification that a new attribute was added to the servlet context.
attributeAdded(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener
  Notification that a new attribute was added to the servlet request.
attributeRemoved(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener
  Notification that an attribute has been removed from a session.
attributeRemoved(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener
  Notification that an existing attribute has been removed from the servlet context.
attributeRemoved(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener
  Notification that an existing attribute has been removed from the servlet request.
attributeReplaced(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener
  Notification that an attribute has been replaced in a session.
attributeReplaced(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener
  Notification that an attribute on the servlet context has been replaced.
attributeReplaced(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener
  Notification that an attribute was replaced on the servlet request.
authenticate(HttpServletResponse) - Method in interface javax.servlet.http.HttpServletRequest
  Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.
authenticate(HttpServletResponse) - Method in class javax.servlet.http.HttpServletRequestWrapper
  Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.

## B

BASIC_AUTH - Static variable in interface javax.servlet.http.HttpServletRequest
  String identifier for Basic authentication.

## C

changeSessionId() - Method in interface javax.servlet.http.HttpServletRequest
  Changes the session ID of the session associated with this request.
changeSessionId() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to call changeSessionId() on the wrapped request object.
CLIENT_CERT_AUTH - Static variable in interface javax.servlet.http.HttpServletRequest
  String identifier for Client Certificate authentication.
clone() - Method in class javax.servlet.http.Cookie
  Overrides the standard `java.lang.Object.clone` method to return a copy of this cookie.
complete() - Method in interface javax.servlet.AsyncContext
containsHeader(String) - Method in interface javax.servlet.http.HttpServletResponse
  Returns a boolean indicating whether the named response header has already been set.
containsHeader(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call containsHeader(String name) on the wrapped response object.
contextDestroyed(ServletContextEvent) - Method in interface javax.servlet.ServletContextListener
  Notification that the servlet context is about to be shut down.
contextInitialized(ServletContextEvent) - Method in interface javax.servlet.ServletContextListener
  Notification that the web application initialization process is starting.
Cookie - Class in javax.servlet.http
  Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server.
Cookie(String, String) - Constructor for class javax.servlet.http.Cookie
  Constructs a cookie with a specified name and value.
createFilter(Class<T>) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
createListener(Class<T>) - Method in interface javax.servlet.AsyncContext
createListener(Class<T>) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
createServlet(Class<T>) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments

## D

declareRoles(String...) - Method in interface javax.servlet.ServletContext
  Add to the declared roles for this ServletContext.
delete() - Method in interface javax.servlet.http.Part
  Deletes the underlying storage for a part, including deleting any associated temporary disk file.
destroy() - Method in interface javax.servlet.Filter
  Called by the web container to indicate to a filter that it is being taken out of service.
destroy() - Method in class javax.servlet.GenericServlet
  Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
destroy() - Method in interface javax.servlet.http.HttpUpgradeHandler
  This method is called after the upgraded connection has been closed.
destroy() - Method in interface javax.servlet.Servlet
  Called by the servlet container to indicate to a servlet that the servlet is being taken out of service.
DIGEST_AUTH - Static variable in interface javax.servlet.http.HttpServletRequest
  String identifier for Digest authentication.
dispatch() - Method in interface javax.servlet.AsyncContext
dispatch(String) - Method in interface javax.servlet.AsyncContext
dispatch(ServletContext, String) - Method in interface javax.servlet.AsyncContext
DispatcherType - Enum in javax.servlet
doDelete(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle a DELETE request.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in interface javax.servlet.Filter
  The `doFilter` method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
doFilter(ServletRequest, ServletResponse) - Method in interface javax.servlet.FilterChain
  Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the resource at the end of the chain to be invoked.
doGet(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle a GET request.
doHead(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Receives an HTTP HEAD request from the protected `service` method and handles the request.
doOptions(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle an OPTIONS request.
doPost(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle a POST request.
doPut(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle a PUT request.
doTrace(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Called by the server (via the `service` method) to allow a servlet to handle a TRACE request.

## E

encodeRedirectURL(String) - Method in interface javax.servlet.http.HttpServletResponse
  Encodes the specified URL for use in the `sendRedirect` method or, if encoding is not needed, returns the URL unchanged.
encodeRedirectUrl(String) - Method in interface javax.servlet.http.HttpServletResponse
  Deprecated.
  As of version 2.1, use encodeRedirectURL(String url) instead
encodeRedirectURL(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to return encodeRedirectURL(String url) on the wrapped response object.
encodeRedirectUrl(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  Deprecated.
  As of Version 3.0 of the Java Servlet API
encodeURL(String) - Method in interface javax.servlet.http.HttpServletResponse
  Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.
encodeUrl(String) - Method in interface javax.servlet.http.HttpServletResponse
  Deprecated.
  As of version 2.1, use encodeURL(String url) instead
encodeURL(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call encodeURL(String url) on the wrapped response object.
encodeUrl(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  Deprecated.
  As of Version 3.0 of the Java Servlet API
ERROR_EXCEPTION - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_EXCEPTION_TYPE - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_MESSAGE - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_SERVLET_NAME - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.
ERROR_STATUS_CODE - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when custom error-handling servlet or JSP page is invoked.

## F

Filter - Interface in javax.servlet
  A filter is an object that performs filtering tasks on either the request to a resource (a servlet or static content), or on the response from a resource, or both.
FilterChain - Interface in javax.servlet
  A FilterChain is an object provided by the servlet container to the developer giving a view into the invocation chain of a filtered request for a resource.
FilterConfig - Interface in javax.servlet
  A filter configuration object used by a servlet container to pass information to a filter during initialization.
FilterRegistration - Interface in javax.servlet
FilterRegistration.Dynamic - Interface in javax.servlet
flushBuffer() - Method in interface javax.servlet.ServletResponse
  Forces any content in the buffer to be written to the client.
flushBuffer() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call flushBuffer() on the wrapped response object.
FORM_AUTH - Static variable in interface javax.servlet.http.HttpServletRequest
  String identifier for Form authentication.
forward(ServletRequest, ServletResponse) - Method in interface javax.servlet.RequestDispatcher
  Forwards a request from a servlet to another resource (servlet, JSP file, or HTML file) on the server.
FORWARD_CONTEXT_PATH - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.forward(ServletRequest, ServletResponse)` method is called.
FORWARD_PATH_INFO - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.forward(ServletRequest, ServletResponse)` method is called.
FORWARD_QUERY_STRING - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.forward(ServletRequest, ServletResponse)` method is called.
FORWARD_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.forward(ServletRequest, ServletResponse)` method is called.
FORWARD_SERVLET_PATH - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.forward(ServletRequest, ServletResponse)` method is called.

## G

GenericServlet - Class in javax.servlet
  Defines a generic, protocol-independent servlet.
GenericServlet() - Constructor for class javax.servlet.GenericServlet
  Does nothing.
getAsyncContext() - Method in class javax.servlet.AsyncEvent
getAsyncContext() - Method in interface javax.servlet.ServletRequest
  Get the current AsyncContext.
getAsyncContext() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getAsyncContext() on the wrapped request object.
getAttribute(String) - Method in interface javax.servlet.http.HttpSession
  Returns the object bound with the specified name in this session, or `null` if no object is bound under the name.
getAttribute(String) - Method in interface javax.servlet.ServletContext
  Returns the servlet container attribute with the given name, or `null` if there is no attribute by that name.
getAttribute(String) - Method in interface javax.servlet.ServletRequest
  Returns the value of the named attribute as an `Object`, or `null` if no attribute of the given name exists.
getAttribute(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
getAttributeNames() - Method in interface javax.servlet.http.HttpSession
  Returns an `Enumeration` of `String` objects containing the names of all the objects bound to this session.
getAttributeNames() - Method in interface javax.servlet.ServletContext
  Returns an `Enumeration` containing the attribute names available within this servlet context.
getAttributeNames() - Method in interface javax.servlet.ServletRequest
  Returns an `Enumeration` containing the names of the attributes available to this request.
getAttributeNames() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getAttributeNames() on the wrapped request object.
getAuthType() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the name of the authentication scheme used to protect the servlet.
getAuthType() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getAuthType() on the wrapped request object.
getBuffer() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getBufferSize() - Method in interface javax.servlet.ServletResponse
  Returns the actual buffer size used for the response.
getBufferSize() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getBufferSize() on the wrapped response object.
getCharacterEncoding() - Method in interface javax.servlet.ServletRequest
  Returns the name of the character encoding used in the body of this request.
getCharacterEncoding() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
getCharacterEncoding() - Method in interface javax.servlet.ServletResponse
  Returns the name of the character encoding (MIME charset) used for the body sent in this response.
getCharacterEncoding() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
getClassLoader() - Method in interface javax.servlet.ServletContext
  Get the web application class loader associated with this ServletContext.
getClassName() - Method in interface javax.servlet.Registration
getComment() - Method in class javax.servlet.http.Cookie
  Returns the comment describing the purpose of this cookie, or `null` if the cookie has no comment.
getComment() - Method in interface javax.servlet.SessionCookieConfig
getContentLength() - Method in interface javax.servlet.ServletRequest
  Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
getContentLength() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getContentLength() on the wrapped request object.
getContentLengthLong() - Method in interface javax.servlet.ServletRequest
  Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
getContentLengthLong() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
getContentType() - Method in interface javax.servlet.http.Part
  Obtain the content type passed by the browser.
getContentType() - Method in interface javax.servlet.ServletRequest
  Returns the MIME type of the body of the request, or `null` if the type is not known.
getContentType() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getContentType() on the wrapped request object.
getContentType() - Method in interface javax.servlet.ServletResponse
  Returns the content type used for the MIME body sent in this response.
getContentType() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getContentType() on the wrapped response object.
getContext(String) - Method in interface javax.servlet.ServletContext
  Returns a `ServletContext` object that corresponds to a specified URL on the server.
getContextPath() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the portion of the request URI that indicates the context of the request.
getContextPath() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getContextPath() on the wrapped request object.
getContextPath() - Method in interface javax.servlet.ServletContext
  Return the main path associated with this context.
getCookies() - Method in interface javax.servlet.http.HttpServletRequest
  Returns an array containing all of the `Cookie` objects the client sent with this request.
getCookies() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getCookies() on the wrapped request object.
getCreationTime() - Method in interface javax.servlet.http.HttpSession
  Returns the time when this session was created, measured in milliseconds since midnight January 1, 1970 GMT.
getDateHeader(String) - Method in interface javax.servlet.http.HttpServletRequest
  Returns the value of the specified request header as a `long` value that represents a `Date` object.
getDateHeader(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
getDefaultContentType() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getDefaultSessionTrackingModes() - Method in interface javax.servlet.ServletContext
  Obtains the default session tracking modes for this web application.
getDeferredSyntaxAllowedAsLiteral() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getDispatcherType() - Method in interface javax.servlet.ServletRequest
getDispatcherType() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to call getDispatcherType() on the wrapped request object.
getDomain() - Method in class javax.servlet.http.Cookie
  Returns the domain name set for this cookie.
getDomain() - Method in interface javax.servlet.SessionCookieConfig
getEffectiveMajorVersion() - Method in interface javax.servlet.ServletContext
getEffectiveMinorVersion() - Method in interface javax.servlet.ServletContext
getEffectiveSessionTrackingModes() - Method in interface javax.servlet.ServletContext
  Obtains the currently enabled session tracking modes for this web application.
getElIgnored() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getEmptyRoleSemantic() - Method in class javax.servlet.HttpConstraintElement
  TODO
getErrorOnUndeclaredNamespace() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getFileSizeThreshold() - Method in class javax.servlet.MultipartConfigElement
getFilterName() - Method in interface javax.servlet.FilterConfig
  Get the name of the filter.
getFilterRegistration(String) - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
getFilterRegistrations() - Method in interface javax.servlet.ServletContext
getHeader(String) - Method in interface javax.servlet.http.HttpServletRequest
  Returns the value of the specified request header as a `String`.
getHeader(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getHeader(String name) on the wrapped request object.
getHeader(String) - Method in interface javax.servlet.http.HttpServletResponse
  Return the value for the specified header, or `null` if this header has not been set.
getHeader(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  Return the value for the specified header, or `null` if this header has not been set.
getHeader(String) - Method in interface javax.servlet.http.Part
  Obtains the value of the specified part header as a String.
getHeaderNames() - Method in interface javax.servlet.http.HttpServletRequest
  Returns an enumeration of all the header names this request contains.
getHeaderNames() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getHeaderNames() on the wrapped request object.
getHeaderNames() - Method in interface javax.servlet.http.HttpServletResponse
  Get the header names set for this HTTP response.
getHeaderNames() - Method in class javax.servlet.http.HttpServletResponseWrapper
  Get the header names set for this HTTP response.
getHeaderNames() - Method in interface javax.servlet.http.Part
  Get the header names provided for this part.
getHeaders(String) - Method in interface javax.servlet.http.HttpServletRequest
  Returns all the values of the specified request header as an `Enumeration` of `String` objects.
getHeaders(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getHeaders(String name) on the wrapped request object.
getHeaders(String) - Method in interface javax.servlet.http.HttpServletResponse
  Return a Collection of all the header values associated with the specified header name.
getHeaders(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  Return a Collection of all the header values associated with the specified header name.
getHeaders(String) - Method in interface javax.servlet.http.Part
  Obtain all the values of the specified part header.
getHttpMethodConstraints() - Method in class javax.servlet.ServletSecurityElement
getId() - Method in interface javax.servlet.http.HttpSession
  Returns a string containing the unique identifier assigned to this session.
getIds() - Method in interface javax.servlet.http.HttpSessionContext
  Deprecated.
  As of Java Servlet API 2.1 with no replacement. This method must return an empty `Enumeration` and will be removed in a future version of this API.
getIncludeCodas() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getIncludePreludes() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getInitParameter(String) - Method in interface javax.servlet.FilterConfig
  Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
getInitParameter(String) - Method in class javax.servlet.GenericServlet
  Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
getInitParameter(String) - Method in interface javax.servlet.Registration
  Get the value of an initialisation parameter.
getInitParameter(String) - Method in interface javax.servlet.ServletConfig
  Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
getInitParameter(String) - Method in interface javax.servlet.ServletContext
  Returns a `String` containing the value of the named context-wide initialization parameter, or `null` if the parameter does not exist.
getInitParameterNames() - Method in interface javax.servlet.FilterConfig
  Returns the names of the filter's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the filter has no initialization parameters.
getInitParameterNames() - Method in class javax.servlet.GenericServlet
  Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters.
getInitParameterNames() - Method in interface javax.servlet.ServletConfig
  Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters.
getInitParameterNames() - Method in interface javax.servlet.ServletContext
  Returns the names of the context's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the context has no initialization parameters.
getInitParameters() - Method in interface javax.servlet.Registration
  Get the names and values of all the initialisation parameters.
getInputStream() - Method in interface javax.servlet.http.Part
  Obtain an `InputStream` that can be used to retrieve the contents of the file.
getInputStream() - Method in interface javax.servlet.http.WebConnection
  Provides access to the `ServletInputStream` for reading data from the client.
getInputStream() - Method in interface javax.servlet.ServletRequest
  Retrieves the body of the request as binary data using a `ServletInputStream`.
getInputStream() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getInputStream() on the wrapped request object.
getIntHeader(String) - Method in interface javax.servlet.http.HttpServletRequest
  Returns the value of the specified request header as an `int`.
getIntHeader(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
getIsXml() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getJspConfigDescriptor() - Method in interface javax.servlet.ServletContext
getJspPropertyGroups() - Method in interface javax.servlet.descriptor.JspConfigDescriptor
getLastAccessedTime() - Method in interface javax.servlet.http.HttpSession
  Returns the last time the client sent a request associated with this session, as the number of milliseconds since midnight January 1, 1970 GMT, and marked by the time the container received the request.
getLastModified(HttpServletRequest) - Method in class javax.servlet.http.HttpServlet
  Returns the time the `HttpServletRequest` object was last modified, in milliseconds since midnight January 1, 1970 GMT.
getLocalAddr() - Method in interface javax.servlet.ServletRequest
  Returns the Internet Protocol (IP) address of the interface on which the request was received.
getLocalAddr() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getLocalAddr() on the wrapped request object.
getLocale() - Method in interface javax.servlet.ServletRequest
  Returns the preferred `Locale` that the client will accept content in, based on the Accept-Language header.
getLocale() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getLocale() on the wrapped request object.
getLocale() - Method in interface javax.servlet.ServletResponse
  Returns the locale specified for this response using the `ServletResponse.setLocale(java.util.Locale)` method.
getLocale() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getLocale() on the wrapped response object.
getLocales() - Method in interface javax.servlet.ServletRequest
  Returns an `Enumeration` of `Locale` objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
getLocales() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getLocales() on the wrapped request object.
getLocalName() - Method in interface javax.servlet.ServletRequest
  Returns the host name of the Internet Protocol (IP) interface on which the request was received.
getLocalName() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getLocalName() on the wrapped request object.
getLocalPort() - Method in interface javax.servlet.ServletRequest
  Returns the Internet Protocol (IP) port number of the interface on which the request was received.
getLocalPort() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getLocalPort() on the wrapped request object.
getLocation() - Method in class javax.servlet.MultipartConfigElement
getMajorVersion() - Method in interface javax.servlet.ServletContext
  Returns the major version of the Java Servlet API that this servlet container supports.
getMappings() - Method in interface javax.servlet.ServletRegistration
getMaxAge() - Method in class javax.servlet.http.Cookie
  Returns the maximum age of the cookie, specified in seconds, By default, `-1` indicating the cookie will persist until browser shutdown.
getMaxAge() - Method in interface javax.servlet.SessionCookieConfig
getMaxFileSize() - Method in class javax.servlet.MultipartConfigElement
getMaxInactiveInterval() - Method in interface javax.servlet.http.HttpSession
  Returns the maximum time interval, in seconds, that the servlet container will keep this session open between client accesses.
getMaxRequestSize() - Method in class javax.servlet.MultipartConfigElement
getMethod() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
getMethod() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getMethod() on the wrapped request object.
getMethodName() - Method in class javax.servlet.HttpMethodConstraintElement
getMethodNames() - Method in class javax.servlet.ServletSecurityElement
getMimeType(String) - Method in interface javax.servlet.ServletContext
  Returns the MIME type of the specified file, or `null` if the MIME type is not known.
getMinorVersion() - Method in interface javax.servlet.ServletContext
  Returns the minor version of the Servlet API that this servlet container supports.
getName() - Method in class javax.servlet.http.Cookie
  Returns the name of the cookie.
getName() - Method in class javax.servlet.http.HttpSessionBindingEvent
  Returns the name with which the attribute is bound to or unbound from the session.
getName() - Method in interface javax.servlet.http.Part
  Obtain the name of the field in the multipart form corresponding to this part.
getName() - Method in interface javax.servlet.Registration
getName() - Method in class javax.servlet.ServletContextAttributeEvent
  Return the name of the attribute that changed on the ServletContext.
getName() - Method in class javax.servlet.ServletRequestAttributeEvent
  Return the name of the attribute that changed on the ServletRequest.
getName() - Method in interface javax.servlet.SessionCookieConfig
getNamedDispatcher(String) - Method in interface javax.servlet.ServletContext
  Returns a `RequestDispatcher` object that acts as a wrapper for the named servlet.
getOutputStream() - Method in interface javax.servlet.http.WebConnection
  Provides access to the `ServletOutputStream` for writing data to the client.
getOutputStream() - Method in interface javax.servlet.ServletResponse
  Returns a `ServletOutputStream` suitable for writing binary data in the response.
getOutputStream() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getOutputStream() on the wrapped response object.
getPageEncoding() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getParameter(String) - Method in interface javax.servlet.ServletRequest
  Returns the value of a request parameter as a `String`, or `null` if the parameter does not exist.
getParameter(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getParameter(String name) on the wrapped request object.
getParameterMap() - Method in interface javax.servlet.ServletRequest
  Returns a java.util.Map of the parameters of this request.
getParameterMap() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getParameterMap() on the wrapped request object.
getParameterNames() - Method in interface javax.servlet.ServletRequest
  Returns an `Enumeration` of `String` objects containing the names of the parameters contained in this request.
getParameterNames() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getParameterNames() on the wrapped request object.
getParameterValues(String) - Method in interface javax.servlet.ServletRequest
  Returns an array of `String` objects containing all of the values the given request parameter has, or `null` if the parameter does not exist.
getParameterValues(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
getPart(String) - Method in interface javax.servlet.http.HttpServletRequest
  Gets the named Part or null if the Part does not exist.
getPart(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  Gets the named Part or null if the Part does not exist.
getParts() - Method in interface javax.servlet.http.HttpServletRequest
  Return a collection of all uploaded Parts.
getParts() - Method in class javax.servlet.http.HttpServletRequestWrapper
  Return a collection of all uploaded Parts.
getPath() - Method in class javax.servlet.http.Cookie
  Returns the path on the server to which the browser returns this cookie.
getPath() - Method in interface javax.servlet.SessionCookieConfig
getPathInfo() - Method in interface javax.servlet.http.HttpServletRequest
  Returns any extra path information associated with the URL the client sent when it made this request.
getPathInfo() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getPathInfo() on the wrapped request object.
getPathTranslated() - Method in interface javax.servlet.http.HttpServletRequest
  Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
getPathTranslated() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getPathTranslated() on the wrapped request object.
getProtocol() - Method in interface javax.servlet.ServletRequest
  Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
getProtocol() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getProtocol() on the wrapped request object.
getQueryString() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the query string that is contained in the request URL after the path.
getQueryString() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getQueryString() on the wrapped request object.
getReader() - Method in interface javax.servlet.ServletRequest
  Retrieves the body of the request as character data using a `BufferedReader`.
getReader() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getReader() on the wrapped request object.
getRealPath(String) - Method in interface javax.servlet.ServletContext
  Returns a `String` containing the real path for a given virtual path.
getRealPath(String) - Method in interface javax.servlet.ServletRequest
  Deprecated.
  As of Version 2.1 of the Java Servlet API, use `ServletContext.getRealPath(java.lang.String)` instead.
getRealPath(String) - Method in class javax.servlet.ServletRequestWrapper
  Deprecated.
  As of Version 3.0 of the Java Servlet API
getRemoteAddr() - Method in interface javax.servlet.ServletRequest
  Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
getRemoteAddr() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
getRemoteHost() - Method in interface javax.servlet.ServletRequest
  Returns the fully qualified name of the client or the last proxy that sent the request.
getRemoteHost() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getRemoteHost() on the wrapped request object.
getRemotePort() - Method in interface javax.servlet.ServletRequest
  Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
getRemotePort() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getRemotePort() on the wrapped request object.
getRemoteUser() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the login of the user making this request, if the user has been authenticated, or `null` if the user has not been authenticated.
getRemoteUser() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getRemoteUser() on the wrapped request object.
getRequest() - Method in interface javax.servlet.AsyncContext
getRequest() - Method in class javax.servlet.ServletRequestWrapper
  Get the wrapped request.
getRequestDispatcher(String) - Method in interface javax.servlet.ServletContext
  Returns a `RequestDispatcher` object that acts as a wrapper for the resource located at the given path.
getRequestDispatcher(String) - Method in interface javax.servlet.ServletRequest
  Returns a `RequestDispatcher` object that acts as a wrapper for the resource located at the given path.
getRequestDispatcher(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
getRequestedSessionId() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the session ID specified by the client.
getRequestedSessionId() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
getRequestURI() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
getRequestURI() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getRequestURI() on the wrapped request object.
getRequestURL() - Method in interface javax.servlet.http.HttpServletRequest
  Reconstructs the URL the client used to make the request.
getRequestURL() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getRequestURL() on the wrapped request object.
getRequestURL(HttpServletRequest) - Static method in class javax.servlet.http.HttpUtils
  Deprecated.
  Reconstructs the URL the client used to make the request, using information in the `HttpServletRequest` object.
getResource(String) - Method in interface javax.servlet.ServletContext
  Returns a URL to the resource that is mapped to a specified path.
getResourceAsStream(String) - Method in interface javax.servlet.ServletContext
  Returns the resource located at the named path as an `InputStream` object.
getResourcePaths(String) - Method in interface javax.servlet.ServletContext
  Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.
getResponse() - Method in interface javax.servlet.AsyncContext
getResponse() - Method in class javax.servlet.ServletResponseWrapper
  Return the wrapped ServletResponse object.
getRolesAllowed() - Method in class javax.servlet.HttpConstraintElement
  TODO
getRootCause() - Method in exception javax.servlet.ServletException
  Returns the exception that caused this servlet exception.
getRunAsRole() - Method in interface javax.servlet.ServletRegistration
getScheme() - Method in interface javax.servlet.ServletRequest
  Returns the name of the scheme used to make this request, for example, `http`, `https`, or `ftp`.
getScheme() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getScheme() on the wrapped request object.
getScriptingInvalid() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getSecure() - Method in class javax.servlet.http.Cookie
  Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
getServerInfo() - Method in interface javax.servlet.ServletContext
  Returns the name and version of the servlet container on which the servlet is running.
getServerName() - Method in interface javax.servlet.ServletRequest
  Returns the host name of the server to which the request was sent.
getServerName() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getServerName() on the wrapped request object.
getServerPort() - Method in interface javax.servlet.ServletRequest
  Returns the port number to which the request was sent.
getServerPort() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getServerPort() on the wrapped request object.
getServlet(String) - Method in interface javax.servlet.ServletContext
  Deprecated.
  As of Java Servlet API 2.1, with no direct replacement.
getServlet() - Method in exception javax.servlet.UnavailableException
  Deprecated.
  As of Java Servlet API 2.2, with no replacement.
getServletConfig() - Method in class javax.servlet.GenericServlet
  Returns this servlet's `ServletConfig` object.
getServletConfig() - Method in interface javax.servlet.Servlet
  Returns a `ServletConfig` object, which contains initialization and startup parameters for this servlet.
getServletContext() - Method in interface javax.servlet.FilterConfig
  Returns a reference to the `ServletContext` in which the caller is executing.
getServletContext() - Method in class javax.servlet.GenericServlet
  Returns a reference to the `ServletContext` in which this servlet is running.
getServletContext() - Method in interface javax.servlet.http.HttpSession
  Returns the ServletContext to which this session belongs.
getServletContext() - Method in interface javax.servlet.ServletConfig
  Returns a reference to the `ServletContext` in which the caller is executing.
getServletContext() - Method in class javax.servlet.ServletContextEvent
  Return the ServletContext that changed.
getServletContext() - Method in interface javax.servlet.ServletRequest
getServletContext() - Method in class javax.servlet.ServletRequestEvent
  Get the associated ServletContext.
getServletContext() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return getServletContext() on the wrapped request object.
getServletContextName() - Method in interface javax.servlet.ServletContext
  Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.
getServletInfo() - Method in class javax.servlet.GenericServlet
  Returns information about the servlet, such as author, version, and copyright.
getServletInfo() - Method in interface javax.servlet.Servlet
  Returns information about the servlet, such as author, version, and copyright.
getServletName() - Method in class javax.servlet.GenericServlet
  Returns the name of this servlet instance.
getServletName() - Method in interface javax.servlet.ServletConfig
  Returns the name of this servlet instance.
getServletNameMappings() - Method in interface javax.servlet.FilterRegistration
getServletNames() - Method in interface javax.servlet.ServletContext
  Deprecated.
  As of Java Servlet API 2.1, with no replacement.
getServletPath() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the part of this request's URL that calls the servlet.
getServletPath() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getServletPath() on the wrapped request object.
getServletRegistration(String) - Method in interface javax.servlet.ServletContext
  Obtain the details of the named servlet.
getServletRegistrations() - Method in interface javax.servlet.ServletContext
  TODO SERVLET3 - Add comments
getServletRequest() - Method in class javax.servlet.ServletRequestEvent
  Get the associated ServletRequest.
getServlets() - Method in interface javax.servlet.ServletContext
  Deprecated.
  As of Java Servlet API 2.0, with no replacement.
getSession(boolean) - Method in interface javax.servlet.http.HttpServletRequest
  Returns the current `HttpSession` associated with this request or, if there is no current session and `create` is true, returns a new session.
getSession() - Method in interface javax.servlet.http.HttpServletRequest
  Returns the current session associated with this request, or if the request does not have a session, creates one.
getSession(boolean) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getSession(boolean create) on the wrapped request object.
getSession() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getSession() on the wrapped request object.
getSession() - Method in class javax.servlet.http.HttpSessionBindingEvent
  Get the session that changed.
getSession(String) - Method in interface javax.servlet.http.HttpSessionContext
  Deprecated.
  As of Java Servlet API 2.1 with no replacement. This method must return null and will be removed in a future version of this API.
getSession() - Method in class javax.servlet.http.HttpSessionEvent
  Get the session that changed.
getSessionContext() - Method in interface javax.servlet.http.HttpSession
  Deprecated.
  As of Version 2.1, this method is deprecated and has no replacement. It will be removed in a future version of the Java Servlet API.
getSessionCookieConfig() - Method in interface javax.servlet.ServletContext
getSize() - Method in interface javax.servlet.http.Part
  Obtain the size of this part.
getStatus() - Method in interface javax.servlet.http.HttpServletResponse
  Get the HTTP status code for this Response.
getStatus() - Method in class javax.servlet.http.HttpServletResponseWrapper
  Get the HTTP status code for this Response.
getSubmittedFileName() - Method in interface javax.servlet.http.Part
  If this part represents an uploaded file, gets the file name submitted in the upload.
getSuppliedRequest() - Method in class javax.servlet.AsyncEvent
getSuppliedResponse() - Method in class javax.servlet.AsyncEvent
getTaglibLocation() - Method in interface javax.servlet.descriptor.TaglibDescriptor
getTaglibs() - Method in interface javax.servlet.descriptor.JspConfigDescriptor
getTaglibURI() - Method in interface javax.servlet.descriptor.TaglibDescriptor
getThrowable() - Method in class javax.servlet.AsyncEvent
getTimeout() - Method in interface javax.servlet.AsyncContext
  Get the current timeout.
getTransportGuarantee() - Method in class javax.servlet.HttpConstraintElement
  TODO
getTrimDirectiveWhitespaces() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getUnavailableSeconds() - Method in exception javax.servlet.UnavailableException
  Returns the number of seconds the servlet expects to be temporarily unavailable.
getUrlPatternMappings() - Method in interface javax.servlet.FilterRegistration
getUrlPatterns() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor
getUserPrincipal() - Method in interface javax.servlet.http.HttpServletRequest
  Returns a `java.security.Principal` object containing the name of the current authenticated user.
getUserPrincipal() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
getValue() - Method in class javax.servlet.http.Cookie
  Returns the value of the cookie.
getValue(String) - Method in interface javax.servlet.http.HttpSession
  Deprecated.
  As of Version 2.2, this method is replaced by `HttpSession.getAttribute(java.lang.String)`.
getValue() - Method in class javax.servlet.http.HttpSessionBindingEvent
  Returns the value of the attribute that has been added, removed or replaced.
getValue() - Method in class javax.servlet.ServletContextAttributeEvent
  Returns the value of the attribute that has been added, removed, or replaced.
getValue() - Method in class javax.servlet.ServletRequestAttributeEvent
  Returns the value of the attribute that has been added, removed or replaced.
getValueNames() - Method in interface javax.servlet.http.HttpSession
  Deprecated.
  As of Version 2.2, this method is replaced by `HttpSession.getAttributeNames()`
getVersion() - Method in class javax.servlet.http.Cookie
  Returns the version of the protocol this cookie complies with.
getVirtualServerName() - Method in interface javax.servlet.ServletContext
  Get the primary name of the virtual host on which this context is deployed.
getWriter() - Method in interface javax.servlet.ServletResponse
  Returns a `PrintWriter` object that can send character text to the client.
getWriter() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return getWriter() on the wrapped response object.

## H

HandlesTypes - Annotation Type in javax.servlet.annotation
  This annotation is used to declare an array of application classes which are passed to a `ServletContainerInitializer`.
hasOriginalRequestAndResponse() - Method in interface javax.servlet.AsyncContext
HttpConstraint - Annotation Type in javax.servlet.annotation
  This annotation represents the security constraints that are applied to all requests with HTTP protocol method types that are not otherwise represented by a corresponding `HttpMethodConstraint` in a `ServletSecurity` annotation.
HttpConstraintElement - Class in javax.servlet
  Equivalent of `HttpConstraint` for programmatic configuration of security constraints.
HttpConstraintElement() - Constructor for class javax.servlet.HttpConstraintElement
  Default constraint is permit with no transport guarantee.
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic) - Constructor for class javax.servlet.HttpConstraintElement
  Construct a constraint with an empty role semantic.
HttpConstraintElement(ServletSecurity.TransportGuarantee, String...) - Constructor for class javax.servlet.HttpConstraintElement
  Construct a constraint with a transport guarantee and roles.
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic, ServletSecurity.TransportGuarantee, String...) - Constructor for class javax.servlet.HttpConstraintElement
  Construct a constraint with an empty role semantic, a transport guarantee and roles.
HttpMethodConstraint - Annotation Type in javax.servlet.annotation
  Specific security constraints can be applied to different types of request, differentiated by the HTTP protocol method type by using this annotation inside the `ServletSecurity` annotation.
HttpMethodConstraintElement - Class in javax.servlet
HttpMethodConstraintElement(String) - Constructor for class javax.servlet.HttpMethodConstraintElement
HttpMethodConstraintElement(String, HttpConstraintElement) - Constructor for class javax.servlet.HttpMethodConstraintElement
HttpServlet - Class in javax.servlet.http
  Provides an abstract class to be subclassed to create an HTTP servlet suitable for a Web site.
HttpServlet() - Constructor for class javax.servlet.http.HttpServlet
  Does nothing, because this is an abstract class.
HttpServletRequest - Interface in javax.servlet.http
  Extends the `ServletRequest` interface to provide request information for HTTP servlets.
HttpServletRequestWrapper - Class in javax.servlet.http
  Provides a convenient implementation of the HttpServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
HttpServletRequestWrapper(HttpServletRequest) - Constructor for class javax.servlet.http.HttpServletRequestWrapper
  Constructs a request object wrapping the given request.
HttpServletResponse - Interface in javax.servlet.http
  Extends the `ServletResponse` interface to provide HTTP-specific functionality in sending a response.
HttpServletResponseWrapper - Class in javax.servlet.http
  Provides a convenient implementation of the HttpServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
HttpServletResponseWrapper(HttpServletResponse) - Constructor for class javax.servlet.http.HttpServletResponseWrapper
  Constructs a response adaptor wrapping the given response.
HttpSession - Interface in javax.servlet.http
  Provides a way to identify a user across more than one page request or visit to a Web site and to store information about that user.
HttpSessionActivationListener - Interface in javax.servlet.http
  Objects that are bound to a session may listen to container events notifying them that sessions will be passivated and that session will be activated.
HttpSessionAttributeListener - Interface in javax.servlet.http
  This listener interface can be implemented in order to get notifications of changes to the attribute lists of sessions within this web application.
HttpSessionBindingEvent - Class in javax.servlet.http
  Events of this type are either sent to an object that implements `HttpSessionBindingListener` when it is bound or unbound from a session, or to a `HttpSessionAttributeListener` that has been configured in the deployment descriptor when any attribute is bound, unbound or replaced in a session.
HttpSessionBindingEvent(HttpSession, String) - Constructor for class javax.servlet.http.HttpSessionBindingEvent
  Constructs an event that notifies an object that it has been bound to or unbound from a session.
HttpSessionBindingEvent(HttpSession, String, Object) - Constructor for class javax.servlet.http.HttpSessionBindingEvent
  Constructs an event that notifies an object that it has been bound to or unbound from a session.
HttpSessionBindingListener - Interface in javax.servlet.http
  Causes an object to be notified when it is bound to or unbound from a session.
HttpSessionContext - Interface in javax.servlet.http
  Deprecated.
  As of Java(tm) Servlet API 2.1 for security reasons, with no replacement. This interface will be removed in a future version of this API.
HttpSessionEvent - Class in javax.servlet.http
  This is the class representing event notifications for changes to sessions within a web application.
HttpSessionEvent(HttpSession) - Constructor for class javax.servlet.http.HttpSessionEvent
  Construct a session event from the given source.
HttpSessionIdListener - Interface in javax.servlet.http
  Implementations of this interface are notified when an `HttpSession`'s ID changes.
HttpSessionListener - Interface in javax.servlet.http
  Implementations of this interface are notified of changes to the list of active sessions in a web application.
HttpUpgradeHandler - Interface in javax.servlet.http
  Interface between the HTTP upgrade process and the new protocol.
HttpUtils - Class in javax.servlet.http
  Deprecated.
  As of Java(tm) Servlet API 2.3. These methods were only useful with the default encoding and have been moved to the request interfaces.
HttpUtils() - Constructor for class javax.servlet.http.HttpUtils
  Deprecated.
  Constructs an empty `HttpUtils` object.

## I

include(ServletRequest, ServletResponse) - Method in interface javax.servlet.RequestDispatcher
  Includes the content of a resource (servlet, JSP page, HTML file) in the response.
INCLUDE_CONTEXT_PATH - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.include(ServletRequest, ServletResponse)` method is called on the `RequestDispatcher` obtained by a path and not by a name.
INCLUDE_PATH_INFO - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.include(ServletRequest, ServletResponse)` method is called on the `RequestDispatcher` obtained by a path and not by a name.
INCLUDE_QUERY_STRING - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.include(ServletRequest, ServletResponse)` method is called on the `RequestDispatcher` obtained by a path and not by a name.
INCLUDE_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.include(ServletRequest, ServletResponse)` method is called on the `RequestDispatcher` obtained by a path and not by a name.
INCLUDE_SERVLET_PATH - Static variable in interface javax.servlet.RequestDispatcher
  The name of the request attribute that should be set by the container when the `RequestDispatcher.include(ServletRequest, ServletResponse)` method is called on the `RequestDispatcher` obtained by a path and not by a name.
init(FilterConfig) - Method in interface javax.servlet.Filter
  Called by the web container to indicate to a filter that it is being placed into service.
init(ServletConfig) - Method in class javax.servlet.GenericServlet
  Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
init() - Method in class javax.servlet.GenericServlet
  A convenience method which can be overridden so that there's no need to call `super.init(config)`.
init(WebConnection) - Method in interface javax.servlet.http.HttpUpgradeHandler
  This method is called once the request/response pair where `HttpServletRequest.upgrade(Class)` is called has completed processing and is the point where control of the connection passes from the container to the `HttpUpgradeHandler`.
init(ServletConfig) - Method in interface javax.servlet.Servlet
  Called by the servlet container to indicate to a servlet that the servlet is being placed into service.
invalidate() - Method in interface javax.servlet.http.HttpSession
  Invalidates this session then unbinds any objects bound to it.
isAsyncStarted() - Method in interface javax.servlet.ServletRequest
isAsyncStarted() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return isAsyncStarted() on the wrapped request object.
isAsyncSupported() - Method in interface javax.servlet.ServletRequest
isAsyncSupported() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return isAsyncSupported() on the wrapped request object.
isCommitted() - Method in interface javax.servlet.ServletResponse
  Returns a boolean indicating if the response has been committed.
isCommitted() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to return isCommitted() on the wrapped response object.
isFinished() - Method in class javax.servlet.ServletInputStream
  Has the end of this InputStream been reached?
isHttpOnly() - Method in class javax.servlet.http.Cookie
  Gets the flag that controls if this cookie will be hidden from scripts on the client side.
isHttpOnly() - Method in interface javax.servlet.SessionCookieConfig
isNew() - Method in interface javax.servlet.http.HttpSession
  Returns `true` if the client does not yet know about the session or if the client chooses not to join the session.
isPermanent() - Method in exception javax.servlet.UnavailableException
  Returns a `boolean` indicating whether the servlet is permanently unavailable.
isReady() - Method in class javax.servlet.ServletInputStream
  Can data be read from this InputStream without blocking?
isReady() - Method in class javax.servlet.ServletOutputStream
  Checks if a non-blocking write will succeed.
isRequestedSessionIdFromCookie() - Method in interface javax.servlet.http.HttpServletRequest
  Checks whether the requested session ID came in as a cookie.
isRequestedSessionIdFromCookie() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return isRequestedSessionIdFromCookie() on the wrapped request object.
isRequestedSessionIdFromURL() - Method in interface javax.servlet.http.HttpServletRequest
  Checks whether the requested session ID came in as part of the request URL.
isRequestedSessionIdFromUrl() - Method in interface javax.servlet.http.HttpServletRequest
  Deprecated.
  As of Version 2.1 of the Java Servlet API, use `HttpServletRequest.isRequestedSessionIdFromURL()` instead.
isRequestedSessionIdFromURL() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return isRequestedSessionIdFromURL() on the wrapped request object.
isRequestedSessionIdFromUrl() - Method in class javax.servlet.http.HttpServletRequestWrapper
  Deprecated.
  As of Version 3.0 of the Java Servlet API
isRequestedSessionIdValid() - Method in interface javax.servlet.http.HttpServletRequest
  Checks whether the requested session ID is still valid.
isRequestedSessionIdValid() - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return isRequestedSessionIdValid() on the wrapped request object.
isSecure() - Method in interface javax.servlet.ServletRequest
  Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
isSecure() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return isSecure() on the wrapped request object.
isSecure() - Method in interface javax.servlet.SessionCookieConfig
isUserInRole(String) - Method in interface javax.servlet.http.HttpServletRequest
  Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
isUserInRole(String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  The default behavior of this method is to return isUserInRole(String role) on the wrapped request object.
isWrapperFor(ServletRequest) - Method in class javax.servlet.ServletRequestWrapper
  TODO SERVLET3 - Add comments
isWrapperFor(Class<?>) - Method in class javax.servlet.ServletRequestWrapper
  TODO SERVLET3 - Add comments
isWrapperFor(ServletResponse) - Method in class javax.servlet.ServletResponseWrapper
  TODO SERVLET3 - Add comments
isWrapperFor(Class<?>) - Method in class javax.servlet.ServletResponseWrapper
  TODO SERVLET3 - Add comments

## J

javax.servlet - package javax.servlet
  The javax.servlet package contains a number of classes and interfaces that describe and define the contracts between a servlet class and the runtime environment provided for an instance of such a class by a conforming servlet container.
javax.servlet.annotation - package javax.servlet.annotation
javax.servlet.descriptor - package javax.servlet.descriptor
javax.servlet.http - package javax.servlet.http
  The javax.servlet.http package contains a number of classes and interfaces that describe and define the contracts between a servlet class running under the HTTP protocol and the runtime environment provided for an instance of such a class by a conforming servlet container.
JspConfigDescriptor - Interface in javax.servlet.descriptor
JspPropertyGroupDescriptor - Interface in javax.servlet.descriptor

## L

log(String) - Method in class javax.servlet.GenericServlet
  Writes the specified message to a servlet log file, prepended by the servlet's name.
log(String, Throwable) - Method in class javax.servlet.GenericServlet
  Writes an explanatory message and a stack trace for a given `Throwable` exception to the servlet log file, prepended by the servlet's name.
log(String) - Method in interface javax.servlet.ServletContext
  Writes the specified message to a servlet log file, usually an event log.
log(Exception, String) - Method in interface javax.servlet.ServletContext
  Deprecated.
  As of Java Servlet API 2.1, use `ServletContext.log(String message, Throwable throwable)` instead.

  This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.

log(String, Throwable) - Method in interface javax.servlet.ServletContext
  Writes an explanatory message and a stack trace for a given `Throwable` exception to the servlet log file.
login(String, String) - Method in interface javax.servlet.http.HttpServletRequest
  Authenticate the provided user name and password and then associated the authenticated user with the request.
login(String, String) - Method in class javax.servlet.http.HttpServletRequestWrapper
  Authenticate the provided user name and password and then associated the authenticated user with the request.
logout() - Method in interface javax.servlet.http.HttpServletRequest
  Removes any authenticated user from the request.
logout() - Method in class javax.servlet.http.HttpServletRequestWrapper
  Removes any authenticated user from the request.

## M

MultipartConfig - Annotation Type in javax.servlet.annotation
  This annotation is used to indicate that the `Servlet` on which it is declared expects requests to made using the `multipart/form-data` MIME type.
MultipartConfigElement - Class in javax.servlet
MultipartConfigElement(String) - Constructor for class javax.servlet.MultipartConfigElement
MultipartConfigElement(String, long, long, int) - Constructor for class javax.servlet.MultipartConfigElement
MultipartConfigElement(MultipartConfig) - Constructor for class javax.servlet.MultipartConfigElement

## O

onAllDataRead() - Method in interface javax.servlet.ReadListener
  Invoked when the request body has been fully read.
onComplete(AsyncEvent) - Method in interface javax.servlet.AsyncListener
onDataAvailable() - Method in interface javax.servlet.ReadListener
  Invoked when data is available to read.
onError(AsyncEvent) - Method in interface javax.servlet.AsyncListener
onError(Throwable) - Method in interface javax.servlet.ReadListener
  Invoked if an error occurs while reading the request body.
onError(Throwable) - Method in interface javax.servlet.WriteListener
  Invoked if an error occurs while writing the response.
onStartAsync(AsyncEvent) - Method in interface javax.servlet.AsyncListener
onStartup(Set<Class<?>>, ServletContext) - Method in interface javax.servlet.ServletContainerInitializer
  Receives notification during startup of a web application of the classes within the web application that matched the criteria defined via the `HandlesTypes` annotation.
onTimeout(AsyncEvent) - Method in interface javax.servlet.AsyncListener
onWritePossible() - Method in interface javax.servlet.WriteListener
  Invoked when it it possible to write data without blocking.
ORDERED_LIBS - Static variable in interface javax.servlet.ServletContext

## P

parsePostData(int, ServletInputStream) - Static method in class javax.servlet.http.HttpUtils
  Deprecated.
  Parses data from an HTML form that the client sends to the server using the HTTP POST method and the application/x-www-form-urlencoded MIME type.
parseQueryString(String) - Static method in class javax.servlet.http.HttpUtils
  Deprecated.
  Parses a query string passed from the client to the server and builds a `HashTable` object with key-value pairs.
Part - Interface in javax.servlet.http
  This class represents a part as uploaded to the server as part of a `multipart/form-data` request body.
print(String) - Method in class javax.servlet.ServletOutputStream
  Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end.
print(boolean) - Method in class javax.servlet.ServletOutputStream
  Writes a `boolean` value to the client, with no carriage return-line feed (CRLF) character at the end.
print(char) - Method in class javax.servlet.ServletOutputStream
  Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
print(int) - Method in class javax.servlet.ServletOutputStream
  Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
print(long) - Method in class javax.servlet.ServletOutputStream
  Writes a `long` value to the client, with no carriage return-line feed (CRLF) at the end.
print(float) - Method in class javax.servlet.ServletOutputStream
  Writes a `float` value to the client, with no carriage return-line feed (CRLF) at the end.
print(double) - Method in class javax.servlet.ServletOutputStream
  Writes a `double` value to the client, with no carriage return-line feed (CRLF) at the end.
println() - Method in class javax.servlet.ServletOutputStream
  Writes a carriage return-line feed (CRLF) to the client.
println(String) - Method in class javax.servlet.ServletOutputStream
  Writes a `String` to the client, followed by a carriage return-line feed (CRLF).
println(boolean) - Method in class javax.servlet.ServletOutputStream
  Writes a `boolean` value to the client, followed by a carriage return-line feed (CRLF).
println(char) - Method in class javax.servlet.ServletOutputStream
  Writes a character to the client, followed by a carriage return-line feed (CRLF).
println(int) - Method in class javax.servlet.ServletOutputStream
  Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
println(long) - Method in class javax.servlet.ServletOutputStream
  Writes a `long` value to the client, followed by a carriage return-line feed (CRLF).
println(float) - Method in class javax.servlet.ServletOutputStream
  Writes a `float` value to the client, followed by a carriage return-line feed (CRLF).
println(double) - Method in class javax.servlet.ServletOutputStream
  Writes a `double` value to the client, followed by a carriage return-line feed (CRLF).
putValue(String, Object) - Method in interface javax.servlet.http.HttpSession
  Deprecated.
  As of Version 2.2, this method is replaced by `HttpSession.setAttribute(java.lang.String, java.lang.Object)`

## R

readLine(byte[], int, int) - Method in class javax.servlet.ServletInputStream
  Reads the input stream, one line at a time.
ReadListener - Interface in javax.servlet
  Receives notification of read events when using non-blocking IO.
Registration - Interface in javax.servlet
  Common interface for the registration of Filters and Servlets.
Registration.Dynamic - Interface in javax.servlet
removeAttribute(String) - Method in interface javax.servlet.http.HttpSession
  Removes the object bound with the specified name from this session.
removeAttribute(String) - Method in interface javax.servlet.ServletContext
  Removes the attribute with the given name from the servlet context.
removeAttribute(String) - Method in interface javax.servlet.ServletRequest
  Removes an attribute from this request.
removeAttribute(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to call removeAttribute(String name) on the wrapped request object.
removeValue(String) - Method in interface javax.servlet.http.HttpSession
  Deprecated.
  As of Version 2.2, this method is replaced by `HttpSession.removeAttribute(java.lang.String)`
requestDestroyed(ServletRequestEvent) - Method in interface javax.servlet.ServletRequestListener
  The request is about to go out of scope of the web application.
RequestDispatcher - Interface in javax.servlet
  Defines an object that receives requests from the client and sends them to any resource (such as a servlet, HTML file, or JSP file) on the server.
requestInitialized(ServletRequestEvent) - Method in interface javax.servlet.ServletRequestListener
  The request is about to come into scope of the web application.
reset() - Method in interface javax.servlet.ServletResponse
  Clears any data that exists in the buffer as well as the status code and headers.
reset() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call reset() on the wrapped response object.
resetBuffer() - Method in interface javax.servlet.ServletResponse
  Clears the content of the underlying buffer in the response without clearing headers or status code.
resetBuffer() - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call resetBuffer() on the wrapped response object.

## S

SC_ACCEPTED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (202) indicating that a request was accepted for processing, but was not completed.
SC_BAD_GATEWAY - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway.
SC_BAD_REQUEST - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (400) indicating the request sent by the client was syntactically incorrect.
SC_CONFLICT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.
SC_CONTINUE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (100) indicating the client can continue.
SC_CREATED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (201) indicating the request succeeded and created a new resource on the server.
SC_EXPECTATION_FAILED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (417) indicating that the server could not meet the expectation given in the Expect request header.
SC_FORBIDDEN - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (403) indicating the server understood the request but refused to fulfill it.
SC_FOUND - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (302) indicating that the resource reside temporarily under a different URI.
SC_GATEWAY_TIMEOUT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy.
SC_GONE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known.
SC_HTTP_VERSION_NOT_SUPPORTED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message.
SC_INTERNAL_SERVER_ERROR - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.
SC_LENGTH_REQUIRED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (411) indicating that the request cannot be handled without a defined `Content-Length`.
SC_METHOD_NOT_ALLOWED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (405) indicating that the method specified in the `Request-Line` is not allowed for the resource identified by the `Request-URI`.
SC_MOVED_PERMANENTLY - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests.
SC_MOVED_TEMPORARILY - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource.
SC_MULTIPLE_CHOICES - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location.
SC_NO_CONTENT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (204) indicating that the request succeeded but that there was no new information to return.
SC_NON_AUTHORITATIVE_INFORMATION - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (203) indicating that the meta information presented by the client did not originate from the server.
SC_NOT_ACCEPTABLE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.
SC_NOT_FOUND - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (404) indicating that the requested resource is not available.
SC_NOT_IMPLEMENTED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.
SC_NOT_MODIFIED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.
SC_OK - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (200) indicating the request succeeded normally.
SC_PARTIAL_CONTENT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (206) indicating that the server has fulfilled the partial GET request for the resource.
SC_PAYMENT_REQUIRED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (402) reserved for future use.
SC_PRECONDITION_FAILED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server.
SC_PROXY_AUTHENTICATION_REQUIRED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (407) indicating that the client MUST first authenticate itself with the proxy.
SC_REQUEST_ENTITY_TOO_LARGE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process.
SC_REQUEST_TIMEOUT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait.
SC_REQUEST_URI_TOO_LONG - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (414) indicating that the server is refusing to service the request because the `Request-URI` is longer than the server is willing to interpret.
SC_REQUESTED_RANGE_NOT_SATISFIABLE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (416) indicating that the server cannot serve the requested byte range.
SC_RESET_CONTENT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.
SC_SEE_OTHER - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (303) indicating that the response to the request can be found under a different URI.
SC_SERVICE_UNAVAILABLE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.
SC_SWITCHING_PROTOCOLS - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (101) indicating the server is switching protocols according to Upgrade header.
SC_TEMPORARY_REDIRECT - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (307) indicating that the requested resource resides temporarily under a different URI.
SC_UNAUTHORIZED - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (401) indicating that the request requires HTTP authentication.
SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
SC_USE_PROXY - Static variable in interface javax.servlet.http.HttpServletResponse
  Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the `Location` field.
sendError(int, String) - Method in interface javax.servlet.http.HttpServletResponse
  Sends an error response to the client using the specified status code and clears the output buffer.
sendError(int) - Method in interface javax.servlet.http.HttpServletResponse
  Sends an error response to the client using the specified status code and clears the buffer.
sendError(int, String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call sendError(int sc, String msg) on the wrapped response object.
sendError(int) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call sendError(int sc) on the wrapped response object.
sendRedirect(String) - Method in interface javax.servlet.http.HttpServletResponse
  Sends a temporary redirect response to the client using the specified redirect location URL.
sendRedirect(String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to return sendRedirect(String location) on the wrapped response object.
service(ServletRequest, ServletResponse) - Method in class javax.servlet.GenericServlet
  Called by the servlet container to allow the servlet to respond to a request.
service(HttpServletRequest, HttpServletResponse) - Method in class javax.servlet.http.HttpServlet
  Receives standard HTTP requests from the public `service` method and dispatches them to the `do`Method methods defined in this class.
service(ServletRequest, ServletResponse) - Method in class javax.servlet.http.HttpServlet
  Dispatches client requests to the protected `service` method.
service(ServletRequest, ServletResponse) - Method in interface javax.servlet.Servlet
  Called by the servlet container to allow the servlet to respond to a request.
Servlet - Interface in javax.servlet
  Defines methods that all servlets must implement.
ServletConfig - Interface in javax.servlet
  A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
ServletContainerInitializer - Interface in javax.servlet
  ServletContainerInitializers (SCIs) are registered via an entry in the file META-INF/services/javax.servlet.ServletContainerInitializer that must be included in the JAR file that contains the SCI implementation.
ServletContext - Interface in javax.servlet
  Defines a set of methods that a servlet uses to communicate with its servlet container, for example, to get the MIME type of a file, dispatch requests, or write to a log file.
ServletContextAttributeEvent - Class in javax.servlet
  This is the event class for notifications about changes to the attributes of the servlet context of a web application.
ServletContextAttributeEvent(ServletContext, String, Object) - Constructor for class javax.servlet.ServletContextAttributeEvent
  Construct a ServletContextAttributeEvent from the given context for the given attribute name and attribute value.
ServletContextAttributeListener - Interface in javax.servlet
  Implementations of this interface receive notifications of changes to the attribute list on the servlet context of a web application.
ServletContextEvent - Class in javax.servlet
  This is the event class for notifications about changes to the servlet context of a web application.
ServletContextEvent(ServletContext) - Constructor for class javax.servlet.ServletContextEvent
  Construct a ServletContextEvent from the given context.
ServletContextListener - Interface in javax.servlet
  Implementations of this interface receive notifications about changes to the servlet context of the web application they are part of.
ServletException - Exception in javax.servlet
  Defines a general exception a servlet can throw when it encounters difficulty.
ServletException() - Constructor for exception javax.servlet.ServletException
  Constructs a new servlet exception.
ServletException(String) - Constructor for exception javax.servlet.ServletException
  Constructs a new servlet exception with the specified message.
ServletException(String, Throwable) - Constructor for exception javax.servlet.ServletException
  Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root cause" exception that interfered with its normal operation, including a description message.
ServletException(Throwable) - Constructor for exception javax.servlet.ServletException
  Constructs a new servlet exception when the servlet needs to throw an exception and include a message about the "root cause" exception that interfered with its normal operation.
ServletInputStream - Class in javax.servlet
  Provides an input stream for reading binary data from a client request, including an efficient `readLine` method for reading data one line at a time.
ServletInputStream() - Constructor for class javax.servlet.ServletInputStream
  Does nothing, because this is an abstract class.
ServletOutputStream - Class in javax.servlet
  Provides an output stream for sending binary data to the client.
ServletOutputStream() - Constructor for class javax.servlet.ServletOutputStream
  Does nothing, because this is an abstract class.
ServletRegistration - Interface in javax.servlet
  TODO SERVLET3 - Add comments
ServletRegistration.Dynamic - Interface in javax.servlet
ServletRequest - Interface in javax.servlet
  Defines an object to provide client request information to a servlet.
ServletRequestAttributeEvent - Class in javax.servlet
  This is the event class for notifications of changes to the attributes of the servlet request in an application.
ServletRequestAttributeEvent(ServletContext, ServletRequest, String, Object) - Constructor for class javax.servlet.ServletRequestAttributeEvent
  Construct a ServletRequestAttributeEvent giving the servlet context of this web application, the ServletRequest whose attributes are changing and the name and value of the attribute.
ServletRequestAttributeListener - Interface in javax.servlet
  A ServletRequestAttributeListener can be implemented by the developer interested in being notified of request attribute changes.
ServletRequestEvent - Class in javax.servlet
  Events of this kind indicate lifecycle events for a ServletRequest.
ServletRequestEvent(ServletContext, ServletRequest) - Constructor for class javax.servlet.ServletRequestEvent
  Construct a ServletRequestEvent for the given ServletContext and ServletRequest.
ServletRequestListener - Interface in javax.servlet
  A ServletRequestListener can be implemented by the developer interested in being notified of requests coming in and out of scope in a web component.
ServletRequestWrapper - Class in javax.servlet
  Provides a convenient implementation of the ServletRequest interface that can be subclassed by developers wishing to adapt the request to a Servlet.
ServletRequestWrapper(ServletRequest) - Constructor for class javax.servlet.ServletRequestWrapper
  Creates a ServletRequest adaptor wrapping the given request object.
ServletResponse - Interface in javax.servlet
  Defines an object to assist a servlet in sending a response to the client.
ServletResponseWrapper - Class in javax.servlet
  Provides a convenient implementation of the ServletResponse interface that can be subclassed by developers wishing to adapt the response from a Servlet.
ServletResponseWrapper(ServletResponse) - Constructor for class javax.servlet.ServletResponseWrapper
  Creates a ServletResponse adaptor wrapping the given response object.
ServletSecurity - Annotation Type in javax.servlet.annotation
  Declare this annotation on a `Servlet` implementation class to enforce security constraints on HTTP protocol requests.
ServletSecurity.EmptyRoleSemantic - Enum in javax.servlet.annotation
  Represents the two possible values of the empty role semantic, active when a list of role names is empty.
ServletSecurity.TransportGuarantee - Enum in javax.servlet.annotation
  Represents the two possible values of data transport, encrypted or not.
ServletSecurityElement - Class in javax.servlet
ServletSecurityElement() - Constructor for class javax.servlet.ServletSecurityElement
  Use default HttpConstraint.
ServletSecurityElement(HttpConstraintElement) - Constructor for class javax.servlet.ServletSecurityElement
  Use specified HttpConstraintElement.
ServletSecurityElement(Collection<HttpMethodConstraintElement>) - Constructor for class javax.servlet.ServletSecurityElement
  Use specific constraints for specified methods and default HttpConstraintElement for all other methods.
ServletSecurityElement(HttpConstraintElement, Collection<HttpMethodConstraintElement>) - Constructor for class javax.servlet.ServletSecurityElement
  Use specified HttpConstraintElement as default and specific constraints for specified methods.
ServletSecurityElement(ServletSecurity) - Constructor for class javax.servlet.ServletSecurityElement
  Create from an annotation.
SessionCookieConfig - Interface in javax.servlet
  Configures the session cookies used by the web application associated with the ServletContext from which this SessionCookieConfig was obtained.
sessionCreated(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionListener
  Notification that a session was created.
sessionDestroyed(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionListener
  Notification that a session is about to be invalidated.
sessionDidActivate(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionActivationListener
  Notification that the session has just been activated.
sessionIdChanged(HttpSessionEvent, String) - Method in interface javax.servlet.http.HttpSessionIdListener
  Notification that a session ID has been changed.
SessionTrackingMode - Enum in javax.servlet
sessionWillPassivate(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionActivationListener
  Notification that the session is about to be passivated.
setAsyncSupported(boolean) - Method in interface javax.servlet.Registration.Dynamic
  Mark this Servlet/Filter as supported asynchronous processing.
setAttribute(String, Object) - Method in interface javax.servlet.http.HttpSession
  Binds an object to this session, using the name specified.
setAttribute(String, Object) - Method in interface javax.servlet.ServletContext
  Binds an object to a given attribute name in this servlet context.
setAttribute(String, Object) - Method in interface javax.servlet.ServletRequest
  Stores an attribute in this request.
setAttribute(String, Object) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return setAttribute(String name, Object o) on the wrapped request object.
setBufferSize(int) - Method in interface javax.servlet.ServletResponse
  Sets the preferred buffer size for the body of the response.
setBufferSize(int) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
setCharacterEncoding(String) - Method in interface javax.servlet.ServletRequest
  Overrides the name of the character encoding used in the body of this request.
setCharacterEncoding(String) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to set the character encoding on the wrapped request object.
setCharacterEncoding(String) - Method in interface javax.servlet.ServletResponse
  Sets the character encoding (MIME charset) of the response being sent to the client, for example, to UTF-8.
setCharacterEncoding(String) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
setComment(String) - Method in class javax.servlet.http.Cookie
  Specifies a comment that describes a cookie's purpose.
setComment(String) - Method in interface javax.servlet.SessionCookieConfig
  Sets the comment for the session cookie
setContentLength(int) - Method in interface javax.servlet.ServletResponse
  Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
setContentLength(int) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
setContentLengthLong(long) - Method in interface javax.servlet.ServletResponse
  Sets the length of the content body in the response In HTTP servlets, this method sets the HTTP Content-Length header.
setContentLengthLong(long) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
setContentType(String) - Method in interface javax.servlet.ServletResponse
  Sets the content type of the response being sent to the client, if the response has not been committed yet.
setContentType(String) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setContentType(String type) on the wrapped response object.
setDateHeader(String, long) - Method in interface javax.servlet.http.HttpServletResponse
  Sets a response header with the given name and date-value.
setDateHeader(String, long) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call setDateHeader(String name, long date) on the wrapped response object.
setDomain(String) - Method in class javax.servlet.http.Cookie
  Specifies the domain within which this cookie should be presented.
setDomain(String) - Method in interface javax.servlet.SessionCookieConfig
  Sets the domain for the session cookie
setHeader(String, String) - Method in interface javax.servlet.http.HttpServletResponse
  Sets a response header with the given name and value.
setHeader(String, String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
setHttpOnly(boolean) - Method in class javax.servlet.http.Cookie
  Sets the flag that controls if this cookie will be hidden from scripts on the client side.
setHttpOnly(boolean) - Method in interface javax.servlet.SessionCookieConfig
  Sets the httpOnly flag for the session cookie.
setInitParameter(String, String) - Method in interface javax.servlet.Registration
  Add an initialisation parameter if not already added.
setInitParameter(String, String) - Method in interface javax.servlet.ServletContext
  Set the given initialisation parameter to the given value.
setInitParameters(Map<String, String>) - Method in interface javax.servlet.Registration
  Add multiple initialisation parameters.
setIntHeader(String, int) - Method in interface javax.servlet.http.HttpServletResponse
  Sets a response header with the given name and integer value.
setIntHeader(String, int) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call setIntHeader(String name, int value) on the wrapped response object.
setLoadOnStartup(int) - Method in interface javax.servlet.ServletRegistration.Dynamic
setLocale(Locale) - Method in interface javax.servlet.ServletResponse
  Sets the locale of the response, if the response has not been committed yet.
setLocale(Locale) - Method in class javax.servlet.ServletResponseWrapper
  The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
setMaxAge(int) - Method in class javax.servlet.http.Cookie
  Sets the maximum age of the cookie in seconds.
setMaxAge(int) - Method in interface javax.servlet.SessionCookieConfig
  Sets the maximum age.
setMaxInactiveInterval(int) - Method in interface javax.servlet.http.HttpSession
  Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
setMultipartConfig(MultipartConfigElement) - Method in interface javax.servlet.ServletRegistration.Dynamic
setName(String) - Method in interface javax.servlet.SessionCookieConfig
  Sets the session cookie name.
setPath(String) - Method in class javax.servlet.http.Cookie
  Specifies a path for the cookie to which the client should return the cookie.
setPath(String) - Method in interface javax.servlet.SessionCookieConfig
  Sets the path of the session cookie.
setReadListener(ReadListener) - Method in class javax.servlet.ServletInputStream
  Sets the `ReadListener` for this `ServletInputStream` and thereby switches to non-blocking IO.
setRequest(ServletRequest) - Method in class javax.servlet.ServletRequestWrapper
  Sets the request object being wrapped.
setResponse(ServletResponse) - Method in class javax.servlet.ServletResponseWrapper
  Sets the response being wrapped.
setRunAsRole(String) - Method in interface javax.servlet.ServletRegistration.Dynamic
setSecure(boolean) - Method in class javax.servlet.http.Cookie
  Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
setSecure(boolean) - Method in interface javax.servlet.SessionCookieConfig
  Sets the secure flag for the session cookie.
setServletSecurity(ServletSecurityElement) - Method in interface javax.servlet.ServletRegistration.Dynamic
setSessionTrackingModes(Set<SessionTrackingMode>) - Method in interface javax.servlet.ServletContext
  Configures the available session tracking modes for this web application.
setStatus(int) - Method in interface javax.servlet.http.HttpServletResponse
  Sets the status code for this response.
setStatus(int, String) - Method in interface javax.servlet.http.HttpServletResponse
  Deprecated.
  As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use `setStatus(int)`, to send an error with a description use `sendError(int, String)`.
setStatus(int) - Method in class javax.servlet.http.HttpServletResponseWrapper
  The default behavior of this method is to call setStatus(int sc) on the wrapped response object.
setStatus(int, String) - Method in class javax.servlet.http.HttpServletResponseWrapper
  Deprecated.
  As of Version 3.0 of the Java Servlet API
setTimeout(long) - Method in interface javax.servlet.AsyncContext
  Set the timeout.
setValue(String) - Method in class javax.servlet.http.Cookie
  Assigns a new value to a cookie after the cookie is created.
setVersion(int) - Method in class javax.servlet.http.Cookie
  Sets the version of the cookie protocol this cookie complies with.
setWriteListener(WriteListener) - Method in class javax.servlet.ServletOutputStream
  Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO.
SingleThreadModel - Interface in javax.servlet
  Deprecated.
  As of Java Servlet API 2.4, with no direct replacement.
start(Runnable) - Method in interface javax.servlet.AsyncContext
startAsync() - Method in interface javax.servlet.ServletRequest
startAsync(ServletRequest, ServletResponse) - Method in interface javax.servlet.ServletRequest
startAsync() - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return startAsync() on the wrapped request object.
startAsync(ServletRequest, ServletResponse) - Method in class javax.servlet.ServletRequestWrapper
  The default behavior of this method is to return startAsync(Runnable) on the wrapped request object.

## T

TaglibDescriptor - Interface in javax.servlet.descriptor
TEMPDIR - Static variable in interface javax.servlet.ServletContext

## U

UnavailableException - Exception in javax.servlet
  Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.
UnavailableException(Servlet, String) - Constructor for exception javax.servlet.UnavailableException
  Deprecated.
  As of Java Servlet API 2.2, use `UnavailableException.UnavailableException(String)` instead.
UnavailableException(int, Servlet, String) - Constructor for exception javax.servlet.UnavailableException
  Deprecated.
  As of Java Servlet API 2.2, use `UnavailableException.UnavailableException(String, int)` instead.
UnavailableException(String) - Constructor for exception javax.servlet.UnavailableException
  Constructs a new exception with a descriptive message indicating that the servlet is permanently unavailable.
UnavailableException(String, int) - Constructor for exception javax.servlet.UnavailableException
  Constructs a new exception with a descriptive message indicating that the servlet is temporarily unavailable and giving an estimate of how long it will be unavailable.
upgrade(Class<T>) - Method in interface javax.servlet.http.HttpServletRequest
  Start the HTTP upgrade process and pass the connection to the provided protocol handler once the current request/response pair has completed processing.
upgrade(Class<T>) - Method in class javax.servlet.http.HttpServletRequestWrapper
  Start the HTTP upgrade process and pass the connection to the provided protocol handler once the current request/response pair has completed processing.

## V

valueBound(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionBindingListener
  Notifies the object that it is being bound to a session and identifies the session.
valueOf(String) - Static method in enum javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.servlet.annotation.ServletSecurity.TransportGuarantee
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.servlet.DispatcherType
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum javax.servlet.SessionTrackingMode
  Returns the enum constant of this type with the specified name.
values() - Static method in enum javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.servlet.annotation.ServletSecurity.TransportGuarantee
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.servlet.DispatcherType
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum javax.servlet.SessionTrackingMode
  Returns an array containing the constants of this enum type, in the order they are declared.
valueUnbound(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionBindingListener
  Notifies the object that it is being unbound from a session and identifies the session.

## W

WebConnection - Interface in javax.servlet.http
  The interface used by a `HttpUpgradeHandler` to interact with an upgraded HTTP connection.
WebFilter - Annotation Type in javax.servlet.annotation
  The annotation used to declare a Servlet `Filter`.
WebInitParam - Annotation Type in javax.servlet.annotation
  The annotation used to declare an initialization parameter on a `Servlet` or `Filter`, within a `WebFilter` or `WebServlet` annotation.
WebListener - Annotation Type in javax.servlet.annotation
  The annotation used to declare a listener for various types of event, in a given web application context.
WebServlet - Annotation Type in javax.servlet.annotation
  This annotation is used to declare the configuration of a `Servlet`.
write(String) - Method in interface javax.servlet.http.Part
  A convenience method to write an uploaded part to disk.
WriteListener - Interface in javax.servlet
  Receives notification of write events when using non-blocking IO.

A B C D E F G H I J L M O P R S T U V W

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.