- GenericFilter - Class in jakarta.servlet
-
Defines a generic, protocol-independent filter.
- GenericFilter() - Constructor for class jakarta.servlet.GenericFilter
-
Does nothing.
- GenericServlet - Class in jakarta.servlet
-
Defines a generic, protocol-independent servlet.
- GenericServlet() - Constructor for class jakarta.servlet.GenericServlet
-
Does nothing.
- getAsyncContext() - Method in class jakarta.servlet.AsyncEvent
-
Gets the AsyncContext from this AsyncEvent.
- getAsyncContext() - Method in interface jakarta.servlet.ServletRequest
-
- getAsyncContext() - Method in class jakarta.servlet.ServletRequestWrapper
-
- getAttribute(String) - Method in interface jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to call getAttribute(String name) on the wrapped request object.
- getAttributeNames() - Method in interface jakarta.servlet.http.HttpSession
-
Returns an Enumeration
of String
objects containing the names of all the objects bound to
this session.
- getAttributeNames() - Method in interface jakarta.servlet.ServletContext
-
Returns an Enumeration
containing the attribute names available within this ServletContext.
- getAttributeNames() - Method in interface jakarta.servlet.ServletRequest
-
Returns an Enumeration
containing the names of the attributes available to this request.
- getAttributeNames() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getAttributeNames() on the wrapped request object.
- getAuthType() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the name of the authentication scheme used to protect the servlet.
- getAuthType() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getAuthType() on the wrapped request object.
- getBuffer() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the buffer
configuration, which specifies the default size of the response buffer for
any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
- getBufferSize() - Method in interface jakarta.servlet.ServletResponse
-
Returns the actual buffer size used for the response.
- getBufferSize() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getBufferSize() on the wrapped response object.
- getCharacterEncoding() - Method in interface jakarta.servlet.ServletRequest
-
Returns the name of the character encoding used in the body of this request.
- getCharacterEncoding() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getCharacterEncoding() on the wrapped request object.
- getCharacterEncoding() - Method in interface jakarta.servlet.ServletResponse
-
Returns the name of the character encoding (MIME charset) used for the body sent in this response.
- getCharacterEncoding() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getCharacterEncoding() on the wrapped response object.
- getClassLoader() - Method in interface jakarta.servlet.ServletContext
-
Gets the class loader of the web application represented by this ServletContext.
- getClassName() - Method in interface jakarta.servlet.Registration
-
Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.
- getComment() - Method in class jakarta.servlet.http.Cookie
-
Returns the comment describing the purpose of this cookie, or null
if the cookie has no comment.
- getComment() - Method in interface jakarta.servlet.SessionCookieConfig
-
Gets the comment that will be assigned to any session tracking cookies created on behalf of the application
represented by the ServletContext from which this SessionCookieConfig was acquired.
- getContentLength() - Method in interface jakarta.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 or is greater than Integer.MAX_VALUE.
- getContentLength() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getContentLength() on the wrapped request object.
- getContentLengthLong() - Method in interface jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getContentLengthLong() on the wrapped request object.
- getContentType() - Method in interface jakarta.servlet.http.Part
-
Gets the content type of this part.
- getContentType() - Method in interface jakarta.servlet.ServletRequest
-
Returns the MIME type of the body of the request, or null
if the type is not known.
- getContentType() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getContentType() on the wrapped request object.
- getContentType() - Method in interface jakarta.servlet.ServletResponse
-
Returns the content type used for the MIME body sent in this response.
- getContentType() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getContentType() on the wrapped response object.
- getContext(String) - Method in interface jakarta.servlet.ServletContext
-
Returns a ServletContext
object that corresponds to a specified URL on the server.
- getContextPath() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the portion of the request URI that indicates the context of the request.
- getContextPath() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getContextPath() on the wrapped request object.
- getContextPath() - Method in interface jakarta.servlet.ServletContext
-
Returns the context path of the web application.
- getCookies() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns an array containing all of the Cookie
objects the client sent with this request.
- getCookies() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getCookies() on the wrapped request object.
- getCreationTime() - Method in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getDateHeader(String name) on the wrapped request object.
- getDefaultContentType() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the default-content-type
configuration, which specifies the default response content
type for any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
- getDefaultSessionTrackingModes() - Method in interface jakarta.servlet.ServletContext
-
Gets the session tracking modes that are supported by default for this ServletContext.
- getDeferredSyntaxAllowedAsLiteral() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the deferred-syntax-allowed-as-literal
configuration, which specifies whether the
character sequence "#{"
, which is normally reserved for Expression Language (EL) expressions,
will cause a translation error if it appears as a String literal in any JSP pages mapped to the JSP property group
represented by this JspPropertyGroupDescriptor
.
- getDispatcherType() - Method in interface jakarta.servlet.ServletRequest
-
Gets the dispatcher type of this request.
- getDispatcherType() - Method in class jakarta.servlet.ServletRequestWrapper
-
Gets the dispatcher type of the wrapped request.
- getDomain() - Method in class jakarta.servlet.http.Cookie
-
Gets the domain name of this Cookie.
- getDomain() - Method in interface jakarta.servlet.SessionCookieConfig
-
Gets the domain name that will be assigned to any session tracking cookies created on behalf of the application
represented by the ServletContext from which this SessionCookieConfig was acquired.
- getEffectiveMajorVersion() - Method in interface jakarta.servlet.ServletContext
-
Gets the major version of the Servlet specification that the application represented by this ServletContext is based
on.
- getEffectiveMinorVersion() - Method in interface jakarta.servlet.ServletContext
-
Gets the minor version of the Servlet specification that the application represented by this ServletContext is based
on.
- getEffectiveSessionTrackingModes() - Method in interface jakarta.servlet.ServletContext
-
Gets the session tracking modes that are in effect for this ServletContext.
- getElIgnored() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the el-ignored
configuration, which specifies whether Expression Language (EL)
evaluation is enabled for any JSP pages mapped to the JSP property group represented by this
JspPropertyGroupDescriptor
.
- getEmptyRoleSemantic() - Method in class jakarta.servlet.HttpConstraintElement
-
Gets the default authorization semantic.
- getErrorOnUndeclaredNamespace() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the error-on-undeclared-namespace
configuration, which specifies whether an error will
be raised at translation time if tag with an undeclared namespace is used in any JSP pages mapped to the JSP property
group represented by this JspPropertyGroupDescriptor
.
- getFileSizeThreshold() - Method in class jakarta.servlet.MultipartConfigElement
-
Gets the size threshold after which files will be written to disk.
- getFilterConfig() - Method in class jakarta.servlet.GenericFilter
-
- getFilterName() - Method in interface jakarta.servlet.FilterConfig
-
Returns the filter-name of this filter as defined in the deployment descriptor.
- getFilterName() - Method in class jakarta.servlet.GenericFilter
-
Returns the name of this filter instance.
- getFilterRegistration(String) - Method in interface jakarta.servlet.ServletContext
-
Gets the FilterRegistration corresponding to the filter with the given filterName.
- getFilterRegistrations() - Method in interface jakarta.servlet.ServletContext
-
Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters
registered with this ServletContext.
- getHeader(String) - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the value of the specified request header as a String
.
- getHeader(String) - Method in class jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Gets the value of the response header with the given name.
- getHeader(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- getHeader(String) - Method in interface jakarta.servlet.http.Part
-
Returns the value of the specified mime header as a String
.
- getHeader(String) - Method in interface jakarta.servlet.http.PushBuilder
-
Return the header of the given name to be used for the push.
- getHeaderNames() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns an enumeration of all the header names this request contains.
- getHeaderNames() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getHeaderNames() on the wrapped request object.
- getHeaderNames() - Method in interface jakarta.servlet.http.HttpServletResponse
-
Gets the names of the headers of this response.
- getHeaderNames() - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- getHeaderNames() - Method in interface jakarta.servlet.http.Part
-
Gets the header names of this Part.
- getHeaderNames() - Method in interface jakarta.servlet.http.PushBuilder
-
Return the set of header to be used for the push.
- getHeaders(String) - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns all the values of the specified request header as an Enumeration
of String
objects.
- getHeaders(String) - Method in class jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Gets the values of the response header with the given name.
- getHeaders(String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- getHeaders(String) - Method in interface jakarta.servlet.http.Part
-
Gets the values of the Part header with the given name.
- getHttpMethodConstraints() - Method in class jakarta.servlet.ServletSecurityElement
-
Gets the (possibly empty) collection of HTTP Method specific constraint elements.
- getHttpServletMapping() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Return the HttpServletMapping of the request.
- getHttpServletMapping() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getServletMapping() on the wrapped request object.
- getId() - Method in interface jakarta.servlet.http.HttpSession
-
Returns a string containing the unique identifier assigned to this session.
- getIds() - Method in interface jakarta.servlet.http.HttpSessionContext
-
- getIncludeCodas() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the include-coda
configuration of the JSP property group represented by this
JspPropertyGroupDescriptor
.
- getIncludePreludes() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the include-prelude
configuration of the JSP property group represented by this
JspPropertyGroupDescriptor
.
- getInitParameter(String) - Method in interface jakarta.servlet.FilterConfig
-
Returns a String
containing the value of the named initialization parameter, or null
if the
initialization parameter does not exist.
- getInitParameter(String) - Method in class jakarta.servlet.GenericFilter
-
Returns a String
containing the value of the named initialization parameter, or null
if the
parameter does not exist.
- getInitParameter(String) - Method in class jakarta.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 jakarta.servlet.Registration
-
Gets the value of the initialization parameter with the given name that will be used to initialize the Servlet or
Filter represented by this Registration object.
- getInitParameter(String) - Method in interface jakarta.servlet.ServletConfig
-
Gets the value of the initialization parameter with the given name.
- getInitParameter(String) - Method in interface jakarta.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 jakarta.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 jakarta.servlet.GenericFilter
-
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 jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.Registration
-
Gets an immutable (and possibly empty) Map containing the currently available initialization parameters that will be
used to initialize the Servlet or Filter represented by this Registration object.
- getInputStream() - Method in interface jakarta.servlet.http.Part
-
Gets the content of this part as an InputStream
- getInputStream() - Method in interface jakarta.servlet.http.WebConnection
-
Returns an input stream for this web connection.
- getInputStream() - Method in interface jakarta.servlet.ServletRequest
-
- getInputStream() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getInputStream() on the wrapped request object.
- getIntHeader(String) - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the value of the specified request header as an int
.
- getIntHeader(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getIntHeader(String name) on the wrapped request object.
- getIsXml() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the is-xml
configuration, which specifies whether any JSP pages mapped to the JSP
property group represented by this JspPropertyGroupDescriptor
will be treated as JSP documents (XML
syntax).
- getJspConfigDescriptor() - Method in interface jakarta.servlet.ServletContext
-
Gets the <jsp-config>
related configuration that was aggregated from the web.xml
and
web-fragment.xml
descriptor files of the web application represented by this ServletContext.
- getJspPropertyGroups() - Method in interface jakarta.servlet.descriptor.JspConfigDescriptor
-
Gets the <jsp-property-group>
child elements of the <jsp-config>
element
represented by this JspConfigDescriptor
.
- getLastAccessedTime() - Method in interface jakarta.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 jakarta.servlet.http.HttpServlet
-
Returns the time the HttpServletRequest
object was last modified, in milliseconds since midnight January
1, 1970 GMT.
- getLocalAddr() - Method in interface jakarta.servlet.ServletRequest
-
Returns the Internet Protocol (IP) address of the interface on which the request was received.
- getLocalAddr() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getLocalAddr() on the wrapped request object.
- getLocale() - Method in interface jakarta.servlet.ServletRequest
-
Returns the preferred Locale
that the client will accept content in, based on the Accept-Language
header.
- getLocale() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getLocale() on the wrapped request object.
- getLocale() - Method in interface jakarta.servlet.ServletResponse
-
- getLocale() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getLocale() on the wrapped response object.
- getLocales() - Method in interface jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getLocales() on the wrapped request object.
- getLocalName() - Method in interface jakarta.servlet.ServletRequest
-
Returns the host name of the Internet Protocol (IP) interface on which the request was received.
- getLocalName() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getLocalName() on the wrapped request object.
- getLocalPort() - Method in interface jakarta.servlet.ServletRequest
-
Returns the Internet Protocol (IP) port number of the interface on which the request was received.
- getLocalPort() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getLocalPort() on the wrapped request object.
- getLocation() - Method in class jakarta.servlet.MultipartConfigElement
-
Gets the directory location where files will be stored.
- getMajorVersion() - Method in interface jakarta.servlet.ServletContext
-
Returns the major version of Jakarta Servlet that this container supports.
- getMappingMatch() - Method in interface jakarta.servlet.http.HttpServletMapping
-
- getMappings() - Method in interface jakarta.servlet.ServletRegistration
-
Gets the currently available mappings of the Servlet represented by this ServletRegistration
.
- getMatchValue() - Method in interface jakarta.servlet.http.HttpServletMapping
-
Return the portion of the URI path that caused this request to be matched.
- getMaxAge() - Method in class jakarta.servlet.http.Cookie
-
Gets the maximum age in seconds of this Cookie.
- getMaxAge() - Method in interface jakarta.servlet.SessionCookieConfig
-
Gets the lifetime (in seconds) of the session tracking cookies created on behalf of the application represented by
the ServletContext from which this SessionCookieConfig was acquired.
- getMaxFileSize() - Method in class jakarta.servlet.MultipartConfigElement
-
Gets the maximum size allowed for uploaded files.
- getMaxInactiveInterval() - Method in interface jakarta.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 jakarta.servlet.MultipartConfigElement
-
Gets the maximum size allowed for multipart/form-data requests.
- getMethod() - Method in interface jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getMethod() on the wrapped request object.
- getMethod() - Method in interface jakarta.servlet.http.PushBuilder
-
Return the method to be used for the push.
- getMethodName() - Method in class jakarta.servlet.HttpMethodConstraintElement
-
Gets the HTTP method name.
- getMethodNames() - Method in class jakarta.servlet.ServletSecurityElement
-
Gets the set of HTTP method names named by the HttpMethodConstraints.
- getMimeType(String) - Method in interface jakarta.servlet.ServletContext
-
Returns the MIME type of the specified file, or null
if the MIME type is not known.
- getMinorVersion() - Method in interface jakarta.servlet.ServletContext
-
Returns the minor version of Jakarta Servlet that this container supports.
- getName() - Method in class jakarta.servlet.http.Cookie
-
Returns the name of the cookie.
- getName() - Method in class jakarta.servlet.http.HttpSessionBindingEvent
-
Returns the name with which the attribute is bound to or unbound from the session.
- getName() - Method in interface jakarta.servlet.http.Part
-
Gets the name of this part
- getName() - Method in interface jakarta.servlet.Registration
-
Gets the name of the Servlet or Filter that is represented by this Registration.
- getName() - Method in class jakarta.servlet.ServletContextAttributeEvent
-
Gets the name of the ServletContext attribute that changed.
- getName() - Method in class jakarta.servlet.ServletRequestAttributeEvent
-
Return the name of the attribute that changed on the ServletRequest.
- getName() - Method in interface jakarta.servlet.SessionCookieConfig
-
Gets the name that will be assigned to any session tracking cookies created on behalf of the application represented
by the ServletContext from which this SessionCookieConfig was acquired.
- getNamedDispatcher(String) - Method in interface jakarta.servlet.ServletContext
-
- getOutputStream() - Method in interface jakarta.servlet.http.WebConnection
-
Returns an output stream for this web connection.
- getOutputStream() - Method in interface jakarta.servlet.ServletResponse
-
- getOutputStream() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getOutputStream() on the wrapped response object.
- getPageEncoding() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the page-encoding
configuration, which specifies the default page encoding for any JSP
pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
- getParameter(String) - Method in interface jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getParameter(String name) on the wrapped request object.
- getParameterMap() - Method in interface jakarta.servlet.ServletRequest
-
Returns a java.util.Map of the parameters of this request.
- getParameterMap() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getParameterMap() on the wrapped request object.
- getParameterNames() - Method in interface jakarta.servlet.ServletRequest
-
Returns an Enumeration
of String
objects containing the names of the parameters contained
in this request.
- getParameterNames() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getParameterNames() on the wrapped request object.
- getParameterValues(String) - Method in interface jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getParameterValues(String name) on the wrapped request object.
- getPart(String) - Method in interface jakarta.servlet.http.HttpServletRequest
-
Gets the
Part
with the given name.
- getPart(String) - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to call getPart on the wrapped request object.
- getParts() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Gets all the
Part
components of this request, provided that it is of type
multipart/form-data
.
- getParts() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to call getParts on the wrapped request object.
- getPath() - Method in class jakarta.servlet.http.Cookie
-
Returns the path on the server to which the browser returns this cookie.
- getPath() - Method in interface jakarta.servlet.http.PushBuilder
-
Return the URI path to be used for the push.
- getPath() - Method in interface jakarta.servlet.SessionCookieConfig
-
Gets the path that will be assigned to any session tracking cookies created on behalf of the application represented
by the ServletContext from which this SessionCookieConfig was acquired.
- getPathInfo() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns any extra path information associated with the URL the client sent when it made this request.
- getPathInfo() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getPathInfo() on the wrapped request object.
- getPathTranslated() - Method in interface jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getPathTranslated() on the wrapped request object.
- getPattern() - Method in interface jakarta.servlet.http.HttpServletMapping
-
Return the String representation for the url-pattern
for this mapping.
- getProtocol() - Method in interface jakarta.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 jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getProtocol() on the wrapped request object.
- getQueryString() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the query string that is contained in the request URL after the path.
- getQueryString() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getQueryString() on the wrapped request object.
- getQueryString() - Method in interface jakarta.servlet.http.PushBuilder
-
Return the query string to be used for the push.
- getReader() - Method in interface jakarta.servlet.ServletRequest
-
Retrieves the body of the request as character data using a BufferedReader
.
- getReader() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getReader() on the wrapped request object.
- getRealPath(String) - Method in interface jakarta.servlet.ServletContext
-
Gets the real path corresponding to the given virtual path.
- getRealPath(String) - Method in interface jakarta.servlet.ServletRequest
-
- getRealPath(String) - Method in class jakarta.servlet.ServletRequestWrapper
-
- getRemoteAddr() - Method in interface jakarta.servlet.ServletRequest
-
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
- getRemoteAddr() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getRemoteAddr() on the wrapped request object.
- getRemoteHost() - Method in interface jakarta.servlet.ServletRequest
-
Returns the fully qualified name of the client or the last proxy that sent the request.
- getRemoteHost() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getRemoteHost() on the wrapped request object.
- getRemotePort() - Method in interface jakarta.servlet.ServletRequest
-
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
- getRemotePort() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getRemotePort() on the wrapped request object.
- getRemoteUser() - Method in interface jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getRemoteUser() on the wrapped request object.
- getRequest() - Method in interface jakarta.servlet.AsyncContext
-
- getRequest() - Method in class jakarta.servlet.ServletRequestWrapper
-
Return the wrapped request object.
- getRequestCharacterEncoding() - Method in interface jakarta.servlet.ServletContext
-
Gets the request character encoding that are supported by default for this ServletContext.
- getRequestDispatcher(String) - Method in interface jakarta.servlet.ServletContext
-
Returns a
RequestDispatcher
object that acts as a wrapper for the resource located at the given path.
- getRequestDispatcher(String) - Method in interface jakarta.servlet.ServletRequest
-
Returns a
RequestDispatcher
object that acts as a wrapper for the resource located at the given path.
- getRequestDispatcher(String) - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getRequestDispatcher(String path) on the wrapped request object.
- getRequestedSessionId() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the session ID specified by the client.
- getRequestedSessionId() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getRequestedSessionId() on the wrapped request object.
- getRequestURI() - Method in interface jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getRequestURI() on the wrapped request object.
- getRequestURL() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Reconstructs the URL the client used to make the request.
- getRequestURL() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getRequestURL() on the wrapped request object.
- getRequestURL(HttpServletRequest) - Static method in class jakarta.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 jakarta.servlet.ServletContext
-
Returns a URL to the resource that is mapped to the given path.
- getResourceAsStream(String) - Method in interface jakarta.servlet.ServletContext
-
Returns the resource located at the named path as an InputStream
object.
- getResourcePaths(String) - Method in interface jakarta.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 jakarta.servlet.AsyncContext
-
- getResponse() - Method in class jakarta.servlet.ServletResponseWrapper
-
Return the wrapped ServletResponse object.
- getResponseCharacterEncoding() - Method in interface jakarta.servlet.ServletContext
-
Gets the response character encoding that are supported by default for this ServletContext.
- getRolesAllowed() - Method in class jakarta.servlet.HttpConstraintElement
-
Gets the names of the authorized roles.
- getRootCause() - Method in exception jakarta.servlet.ServletException
-
Returns the exception that caused this servlet exception.
- getRunAsRole() - Method in interface jakarta.servlet.ServletRegistration
-
Gets the name of the runAs role of the Servlet represented by this ServletRegistration
.
- getScheme() - Method in interface jakarta.servlet.ServletRequest
-
Returns the name of the scheme used to make this request, for example, http
, https
, or
ftp
.
- getScheme() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getScheme() on the wrapped request object.
- getScriptingInvalid() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the scripting-invalid
configuration, which specifies whether scripting is enabled for
any JSP pages mapped to the JSP property group represented by this JspPropertyGroupDescriptor
.
- getSecure() - Method in class jakarta.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 jakarta.servlet.ServletContext
-
Returns the name and version of the servlet container on which the servlet is running.
- getServerName() - Method in interface jakarta.servlet.ServletRequest
-
Returns the host name of the server to which the request was sent.
- getServerName() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getServerName() on the wrapped request object.
- getServerPort() - Method in interface jakarta.servlet.ServletRequest
-
Returns the port number to which the request was sent.
- getServerPort() - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to return getServerPort() on the wrapped request object.
- getServlet(String) - Method in interface jakarta.servlet.ServletContext
-
- getServlet() - Method in exception jakarta.servlet.UnavailableException
-
- getServletConfig() - Method in class jakarta.servlet.GenericServlet
-
- getServletConfig() - Method in interface jakarta.servlet.Servlet
-
Returns a
ServletConfig
object, which contains initialization and startup parameters for this servlet.
- getServletContext() - Method in interface jakarta.servlet.FilterConfig
-
Returns a reference to the
ServletContext
in which the caller is executing.
- getServletContext() - Method in class jakarta.servlet.GenericFilter
-
Returns a reference to the
ServletContext
in which this filter is running.
- getServletContext() - Method in class jakarta.servlet.GenericServlet
-
Returns a reference to the
ServletContext
in which this servlet is running.
- getServletContext() - Method in interface jakarta.servlet.http.HttpSession
-
Returns the ServletContext to which this session belongs.
- getServletContext() - Method in interface jakarta.servlet.ServletConfig
-
Returns a reference to the
ServletContext
in which the caller is executing.
- getServletContext() - Method in class jakarta.servlet.ServletContextEvent
-
Return the ServletContext that changed.
- getServletContext() - Method in interface jakarta.servlet.ServletRequest
-
Gets the servlet context to which this ServletRequest was last dispatched.
- getServletContext() - Method in class jakarta.servlet.ServletRequestEvent
-
Returns the ServletContext of this web application.
- getServletContext() - Method in class jakarta.servlet.ServletRequestWrapper
-
Gets the servlet context to which the wrapped servlet request was last dispatched.
- getServletContextName() - Method in interface jakarta.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 jakarta.servlet.GenericServlet
-
Returns information about the servlet, such as author, version, and copyright.
- getServletInfo() - Method in interface jakarta.servlet.Servlet
-
Returns information about the servlet, such as author, version, and copyright.
- getServletName() - Method in class jakarta.servlet.GenericServlet
-
Returns the name of this servlet instance.
- getServletName() - Method in interface jakarta.servlet.http.HttpServletMapping
-
Return the String representation for the servlet-name
for this mapping.
- getServletName() - Method in interface jakarta.servlet.ServletConfig
-
Returns the name of this servlet instance.
- getServletNameMappings() - Method in interface jakarta.servlet.FilterRegistration
-
Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration
.
- getServletNames() - Method in interface jakarta.servlet.ServletContext
-
- getServletPath() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns the part of this request's URL that calls the servlet.
- getServletPath() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getServletPath() on the wrapped request object.
- getServletRegistration(String) - Method in interface jakarta.servlet.ServletContext
-
Gets the ServletRegistration corresponding to the servlet with the given servletName.
- getServletRegistrations() - Method in interface jakarta.servlet.ServletContext
-
Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets
registered with this ServletContext.
- getServletRequest() - Method in class jakarta.servlet.ServletRequestEvent
-
Returns the ServletRequest that is changing.
- getServlets() - Method in interface jakarta.servlet.ServletContext
-
- getSession(boolean) - Method in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getSession(boolean create) on the wrapped request object.
- getSession() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getSession() on the wrapped request object.
- getSession(String) - Method in interface jakarta.servlet.http.HttpSessionContext
-
- getSession() - Method in class jakarta.servlet.http.HttpSessionEvent
-
Return the session that changed.
- getSessionContext() - Method in interface jakarta.servlet.http.HttpSession
-
- getSessionCookieConfig() - Method in interface jakarta.servlet.ServletContext
-
Gets the
SessionCookieConfig
object through which various properties of the session tracking cookies created
on behalf of this
ServletContext may be configured.
- getSessionId() - Method in interface jakarta.servlet.http.PushBuilder
-
Return the SessionID to be used for the push.
- getSessionTimeout() - Method in interface jakarta.servlet.ServletContext
-
Gets the session timeout in minutes that are supported by default for this ServletContext.
- getSize() - Method in interface jakarta.servlet.http.Part
-
Returns the size of this fille.
- getStatus() - Method in interface jakarta.servlet.http.HttpServletResponse
-
Gets the current status code of this response.
- getStatus() - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- getSubmittedFileName() - Method in interface jakarta.servlet.http.Part
-
Gets the file name specified by the client
- getSuppliedRequest() - Method in class jakarta.servlet.AsyncEvent
-
Gets the ServletRequest from this AsyncEvent.
- getSuppliedResponse() - Method in class jakarta.servlet.AsyncEvent
-
Gets the ServletResponse from this AsyncEvent.
- getTaglibLocation() - Method in interface jakarta.servlet.descriptor.TaglibDescriptor
-
Gets the location of the tag library represented by this TaglibDescriptor.
- getTaglibs() - Method in interface jakarta.servlet.descriptor.JspConfigDescriptor
-
Gets the <taglib>
child elements of the <jsp-config>
element represented by
this JspConfigDescriptor
.
- getTaglibURI() - Method in interface jakarta.servlet.descriptor.TaglibDescriptor
-
Gets the unique identifier of the tag library represented by this TaglibDescriptor.
- getThrowable() - Method in class jakarta.servlet.AsyncEvent
-
Gets the Throwable from this AsyncEvent.
- getTimeout() - Method in interface jakarta.servlet.AsyncContext
-
Gets the timeout (in milliseconds) for this AsyncContext.
- getTrailerFields() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Get the request trailer fields.
- getTrailerFields() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to call getTrailerFields on the wrapped request object.
- getTrailerFields() - Method in interface jakarta.servlet.http.HttpServletResponse
-
Gets the supplier of trailer headers.
- getTrailerFields() - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- getTransportGuarantee() - Method in class jakarta.servlet.HttpConstraintElement
-
Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the
transport connection.
- getTrimDirectiveWhitespaces() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the value of the trim-directive-whitespaces
configuration, which specifies whether template text
containing only whitespaces must be removed from the response output of any JSP pages mapped to the JSP property
group represented by this JspPropertyGroupDescriptor
.
- getUnavailableSeconds() - Method in exception jakarta.servlet.UnavailableException
-
Returns the number of seconds the servlet expects to be temporarily unavailable.
- getUrlPatternMappings() - Method in interface jakarta.servlet.FilterRegistration
-
Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration
.
- getUrlPatterns() - Method in interface jakarta.servlet.descriptor.JspPropertyGroupDescriptor
-
Gets the URL patterns of the JSP property group represented by this JspPropertyGroupDescriptor
.
- getUserPrincipal() - Method in interface jakarta.servlet.http.HttpServletRequest
-
Returns a java.security.Principal
object containing the name of the current authenticated user.
- getUserPrincipal() - Method in class jakarta.servlet.http.HttpServletRequestWrapper
-
The default behavior of this method is to return getUserPrincipal() on the wrapped request object.
- getValue() - Method in class jakarta.servlet.http.Cookie
-
Gets the current value of this Cookie.
- getValue(String) - Method in interface jakarta.servlet.http.HttpSession
-
- getValue() - Method in class jakarta.servlet.http.HttpSessionBindingEvent
-
Returns the value of the attribute that has been added, removed or replaced.
- getValue() - Method in class jakarta.servlet.ServletContextAttributeEvent
-
Gets the value of the ServletContext attribute that changed.
- getValue() - Method in class jakarta.servlet.ServletRequestAttributeEvent
-
Returns the value of the attribute that has been added, removed or replaced.
- getValueNames() - Method in interface jakarta.servlet.http.HttpSession
-
- getVersion() - Method in class jakarta.servlet.http.Cookie
-
Returns the version of the protocol this cookie complies with.
- getVirtualServerName() - Method in interface jakarta.servlet.ServletContext
-
Returns the configuration name of the logical host on which the ServletContext is deployed.
- getWriter() - Method in interface jakarta.servlet.ServletResponse
-
Returns a PrintWriter
object that can send character text to the client.
- getWriter() - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to return getWriter() on the wrapped response object.
- SC_ACCEPTED - Static variable in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (400) indicating the request sent by the client was syntactically incorrect.
- SC_CONFLICT - Static variable in interface jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (100) indicating the client can continue.
- SC_CREATED - Static variable in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (403) indicating the server understood the request but refused to fulfill it.
- SC_FOUND - Static variable in interface jakarta.servlet.http.HttpServletResponse
-
Status code (302) indicating that the resource reside temporarily under a different URI.
- SC_GATEWAY_TIMEOUT - Static variable in interface jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (404) indicating that the requested resource is not available.
- SC_NOT_IMPLEMENTED - Static variable in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (200) indicating the request succeeded normally.
- SC_PARTIAL_CONTENT - Static variable in interface jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (402) reserved for future use.
- SC_PRECONDITION_FAILED - Static variable in interface jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (416) indicating that the server cannot serve the requested byte range.
- SC_RESET_CONTENT - Static variable in interface jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Status code (101) indicating the server is switching protocols according to Upgrade header.
- SC_TEMPORARY_REDIRECT - Static variable in interface jakarta.servlet.http.HttpServletResponse
-
Status code (307) indicating that the requested resource resides temporarily under a different URI.
- SC_UNAUTHORIZED - Static variable in interface jakarta.servlet.http.HttpServletResponse
-
Status code (401) indicating that the request requires HTTP authentication.
- SC_UNSUPPORTED_MEDIA_TYPE - Static variable in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Sends an error response to the client using the specified status and clears the buffer.
- sendError(int) - Method in interface jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Sends a temporary redirect response to the client using the specified redirect location URL and clears the buffer.
- sendRedirect(String) - Method in class jakarta.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 jakarta.servlet.GenericServlet
-
Called by the servlet container to allow the servlet to respond to a request.
- service(HttpServletRequest, HttpServletResponse) - Method in class jakarta.servlet.http.HttpServlet
-
Receives standard HTTP requests from the public service
method and dispatches them to the
do
XXX methods defined in this class.
- service(ServletRequest, ServletResponse) - Method in class jakarta.servlet.http.HttpServlet
-
Dispatches client requests to the protected service
method.
- service(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.Servlet
-
Called by the servlet container to allow the servlet to respond to a request.
- Servlet - Interface in jakarta.servlet
-
Defines methods that all servlets must implement.
- ServletConfig - Interface in jakarta.servlet
-
A servlet configuration object used by a servlet container to pass information to a servlet during initialization.
- ServletContainerInitializer - Interface in jakarta.servlet
-
Interface which allows a library/runtime to be notified of a web application's startup phase and perform any required
programmatic registration of servlets, filters, and listeners in response to it.
- ServletContext - Interface in jakarta.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 jakarta.servlet
-
Event class for notifications about changes to the attributes of the ServletContext of a web application.
- ServletContextAttributeEvent(ServletContext, String, Object) - Constructor for class jakarta.servlet.ServletContextAttributeEvent
-
Constructs a ServletContextAttributeEvent from the given ServletContext, attribute name, and attribute value.
- ServletContextAttributeListener - Interface in jakarta.servlet
-
Interface for receiving notification events about ServletContext attribute changes.
- ServletContextEvent - Class in jakarta.servlet
-
This is the event class for notifications about changes to the servlet context of a web application.
- ServletContextEvent(ServletContext) - Constructor for class jakarta.servlet.ServletContextEvent
-
Construct a ServletContextEvent from the given context.
- ServletContextListener - Interface in jakarta.servlet
-
Interface for receiving notification events about ServletContext lifecycle changes.
- ServletException - Exception in jakarta.servlet
-
Defines a general exception a servlet can throw when it encounters difficulty.
- ServletException() - Constructor for exception jakarta.servlet.ServletException
-
Constructs a new servlet exception.
- ServletException(String) - Constructor for exception jakarta.servlet.ServletException
-
Constructs a new servlet exception with the specified message.
- ServletException(String, Throwable) - Constructor for exception jakarta.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 jakarta.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 jakarta.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 jakarta.servlet.ServletInputStream
-
Does nothing, because this is an abstract class.
- ServletOutputStream - Class in jakarta.servlet
-
Provides an output stream for sending binary data to the client.
- ServletOutputStream() - Constructor for class jakarta.servlet.ServletOutputStream
-
Does nothing, because this is an abstract class.
- ServletRegistration - Interface in jakarta.servlet
-
Interface through which a
Servlet
may be further configured.
- ServletRegistration.Dynamic - Interface in jakarta.servlet
-
Interface through which a
Servlet
registered via one of the
addServlet methods on
ServletContext
may be further configured.
- ServletRequest - Interface in jakarta.servlet
-
Defines an object to provide client request information to a servlet.
- ServletRequestAttributeEvent - Class in jakarta.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 jakarta.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 jakarta.servlet
-
Interface for receiving notification events about ServletRequest attribute changes.
- ServletRequestEvent - Class in jakarta.servlet
-
Events of this kind indicate lifecycle events for a ServletRequest.
- ServletRequestEvent(ServletContext, ServletRequest) - Constructor for class jakarta.servlet.ServletRequestEvent
-
Construct a ServletRequestEvent for the given ServletContext and ServletRequest.
- ServletRequestListener - Interface in jakarta.servlet
-
Interface for receiving notification events about requests coming into and going out of scope of a web application.
- ServletRequestWrapper - Class in jakarta.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 jakarta.servlet.ServletRequestWrapper
-
Creates a ServletRequest adaptor wrapping the given request object.
- ServletResponse - Interface in jakarta.servlet
-
Defines an object to assist a servlet in sending a response to the client.
- ServletResponseWrapper - Class in jakarta.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 jakarta.servlet.ServletResponseWrapper
-
Creates a ServletResponse adaptor wrapping the given response object.
- ServletSecurity - Annotation Type in jakarta.servlet.annotation
-
This annotation is used on a Servlet implementation class to specify security constraints to be enforced by a Servlet
container on HTTP protocol messages.
- ServletSecurity.EmptyRoleSemantic - Enum in jakarta.servlet.annotation
-
Defines the access semantic to be applied to an empty rolesAllowed array.
- ServletSecurity.TransportGuarantee - Enum in jakarta.servlet.annotation
-
Defines the data protection requirements that must be satisfied by the transport
- ServletSecurityElement - Class in jakarta.servlet
-
- ServletSecurityElement() - Constructor for class jakarta.servlet.ServletSecurityElement
-
Constructs an instance using the default HttpConstraintElement
value as the default Constraint element
and with no HTTP Method specific constraint elements.
- ServletSecurityElement(HttpConstraintElement) - Constructor for class jakarta.servlet.ServletSecurityElement
-
Constructs an instance with a default Constraint element and with no HTTP Method specific constraint elements.
- ServletSecurityElement(Collection<HttpMethodConstraintElement>) - Constructor for class jakarta.servlet.ServletSecurityElement
-
Constructs an instance using the default HttpConstraintElement
value as the default Constraint element
and with a collection of HTTP Method specific constraint elements.
- ServletSecurityElement(HttpConstraintElement, Collection<HttpMethodConstraintElement>) - Constructor for class jakarta.servlet.ServletSecurityElement
-
Constructs an instance with a default Constraint element and with a collection of HTTP Method specific constraint
elements.
- ServletSecurityElement(ServletSecurity) - Constructor for class jakarta.servlet.ServletSecurityElement
-
- SessionCookieConfig - Interface in jakarta.servlet
-
Class that may be used to configure various properties of cookies used for session tracking purposes.
- sessionCreated(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionListener
-
Receives notification that a session has been created.
- sessionDestroyed(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionListener
-
Receives notification that a session is about to be invalidated.
- sessionDidActivate(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionActivationListener
-
Notification that the session has just been activated.
- sessionId(String) - Method in interface jakarta.servlet.http.PushBuilder
-
Set the SessionID to be used for the push.
- sessionIdChanged(HttpSessionEvent, String) - Method in interface jakarta.servlet.http.HttpSessionIdListener
-
Receives notification that session id has been changed in a session.
- SessionTrackingMode - Enum in jakarta.servlet
-
Enumeration of session tracking modes.
- sessionWillPassivate(HttpSessionEvent) - Method in interface jakarta.servlet.http.HttpSessionActivationListener
-
Notification that the session is about to be passivated.
- setAsyncSupported(boolean) - Method in interface jakarta.servlet.Registration.Dynamic
-
Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or
not.
- setAttribute(String, Object) - Method in interface jakarta.servlet.http.HttpSession
-
Binds an object to this session, using the name specified.
- setAttribute(String, Object) - Method in interface jakarta.servlet.ServletContext
-
Binds an object to a given attribute name in this ServletContext.
- setAttribute(String, Object) - Method in interface jakarta.servlet.ServletRequest
-
Stores an attribute in this request.
- setAttribute(String, Object) - Method in class jakarta.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 jakarta.servlet.ServletResponse
-
Sets the preferred buffer size for the body of the response.
- setBufferSize(int) - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to call setBufferSize(int size) on the wrapped response object.
- setCharacterEncoding(String) - Method in interface jakarta.servlet.ServletRequest
-
Overrides the name of the character encoding used in the body of this request.
- setCharacterEncoding(String) - Method in class jakarta.servlet.ServletRequestWrapper
-
The default behavior of this method is to set the character encoding on the wrapped request object.
- setCharacterEncoding(String) - Method in interface jakarta.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 jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to call setCharacterEncoding(String charset) on the wrapped response object.
- setComment(String) - Method in class jakarta.servlet.http.Cookie
-
Specifies a comment that describes a cookie's purpose.
- setComment(String) - Method in interface jakarta.servlet.SessionCookieConfig
-
Sets the comment that will be assigned to any session tracking cookies created on behalf of the application
represented by the ServletContext from which this SessionCookieConfig was acquired.
- setContentLength(int) - Method in interface jakarta.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 jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to call setContentLength(int len) on the wrapped response object.
- setContentLengthLong(long) - Method in interface jakarta.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 jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to call setContentLengthLong(long len) on the wrapped response object.
- setContentType(String) - Method in interface jakarta.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 jakarta.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 jakarta.servlet.http.HttpServletResponse
-
Sets a response header with the given name and date-value.
- setDateHeader(String, long) - Method in class jakarta.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 jakarta.servlet.http.Cookie
-
Specifies the domain within which this cookie should be presented.
- setDomain(String) - Method in interface jakarta.servlet.SessionCookieConfig
-
Sets the domain name that will be assigned to any session tracking cookies created on behalf of the application
represented by the ServletContext from which this SessionCookieConfig was acquired.
- setHeader(String, String) - Method in interface jakarta.servlet.http.HttpServletResponse
-
Sets a response header with the given name and value.
- setHeader(String, String) - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
The default behavior of this method is to return setHeader(String name, String value) on the wrapped response object.
- setHeader(String, String) - Method in interface jakarta.servlet.http.PushBuilder
-
Set a request header to be used for the push.
- setHttpOnly(boolean) - Method in class jakarta.servlet.http.Cookie
-
Marks or unmarks this Cookie as HttpOnly.
- setHttpOnly(boolean) - Method in interface jakarta.servlet.SessionCookieConfig
-
Marks or unmarks the session tracking cookies created on behalf of the application represented by the
ServletContext from which this SessionCookieConfig was acquired as HttpOnly.
- setInitParameter(String, String) - Method in interface jakarta.servlet.Registration
-
Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this
Registration.
- setInitParameter(String, String) - Method in interface jakarta.servlet.ServletContext
-
Sets the context initialization parameter with the given name and value on this ServletContext.
- setInitParameters(Map<String, String>) - Method in interface jakarta.servlet.Registration
-
Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.
- setIntHeader(String, int) - Method in interface jakarta.servlet.http.HttpServletResponse
-
Sets a response header with the given name and integer value.
- setIntHeader(String, int) - Method in class jakarta.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 jakarta.servlet.ServletRegistration.Dynamic
-
Sets the loadOnStartup
priority on the Servlet represented by this dynamic ServletRegistration.
- setLocale(Locale) - Method in interface jakarta.servlet.ServletResponse
-
Sets the locale of the response, if the response has not been committed yet.
- setLocale(Locale) - Method in class jakarta.servlet.ServletResponseWrapper
-
The default behavior of this method is to call setLocale(Locale loc) on the wrapped response object.
- setMaxAge(int) - Method in class jakarta.servlet.http.Cookie
-
Sets the maximum age in seconds for this Cookie.
- setMaxAge(int) - Method in interface jakarta.servlet.SessionCookieConfig
-
Sets the lifetime (in seconds) for the session tracking cookies created on behalf of the application represented by
the ServletContext from which this SessionCookieConfig was acquired.
- setMaxInactiveInterval(int) - Method in interface jakarta.servlet.http.HttpSession
-
Specifies the time, in seconds, between client requests before the servlet container will invalidate this session.
- setMultipartConfig(MultipartConfigElement) - Method in interface jakarta.servlet.ServletRegistration.Dynamic
-
- setName(String) - Method in interface jakarta.servlet.SessionCookieConfig
-
Sets the name that will be assigned to any session tracking cookies created on behalf of the application represented
by the ServletContext from which this SessionCookieConfig was acquired.
- setPath(String) - Method in class jakarta.servlet.http.Cookie
-
Specifies a path for the cookie to which the client should return the cookie.
- setPath(String) - Method in interface jakarta.servlet.SessionCookieConfig
-
Sets the path that will be assigned to any session tracking cookies created on behalf of the application represented
by the ServletContext from which this SessionCookieConfig was acquired.
- setReadListener(ReadListener) - Method in class jakarta.servlet.ServletInputStream
-
Instructs the
ServletInputStream
to invoke the provided
ReadListener
when it is possible to read
- setRequest(ServletRequest) - Method in class jakarta.servlet.ServletRequestWrapper
-
Sets the request object being wrapped.
- setRequestCharacterEncoding(String) - Method in interface jakarta.servlet.ServletContext
-
Sets the request character encoding for this ServletContext.
- setResponse(ServletResponse) - Method in class jakarta.servlet.ServletResponseWrapper
-
Sets the response being wrapped.
- setResponseCharacterEncoding(String) - Method in interface jakarta.servlet.ServletContext
-
Sets the response character encoding for this ServletContext.
- setRunAsRole(String) - Method in interface jakarta.servlet.ServletRegistration.Dynamic
-
Sets the name of the runAs
role for this ServletRegistration
.
- setSecure(boolean) - Method in class jakarta.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 jakarta.servlet.SessionCookieConfig
-
Marks or unmarks the session tracking cookies created on behalf of the application represented by the
ServletContext from which this SessionCookieConfig was acquired as secure.
- setServletSecurity(ServletSecurityElement) - Method in interface jakarta.servlet.ServletRegistration.Dynamic
-
- setSessionTimeout(int) - Method in interface jakarta.servlet.ServletContext
-
Sets the session timeout in minutes for this ServletContext.
- setSessionTrackingModes(Set<SessionTrackingMode>) - Method in interface jakarta.servlet.ServletContext
-
Sets the session tracking modes that are to become effective for this ServletContext.
- setStatus(int) - Method in interface jakarta.servlet.http.HttpServletResponse
-
Sets the status code for this response.
- setStatus(int, String) - Method in interface jakarta.servlet.http.HttpServletResponse
-
- setStatus(int) - Method in class jakarta.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 jakarta.servlet.http.HttpServletResponseWrapper
-
- setTimeout(long) - Method in interface jakarta.servlet.AsyncContext
-
Sets the timeout (in milliseconds) for this AsyncContext.
- setTrailerFields(Supplier<Map<String, String>>) - Method in interface jakarta.servlet.http.HttpServletResponse
-
Sets the supplier of trailer headers.
- setTrailerFields(Supplier<Map<String, String>>) - Method in class jakarta.servlet.http.HttpServletResponseWrapper
-
- setValue(String) - Method in class jakarta.servlet.http.Cookie
-
Assigns a new value to this Cookie.
- setVersion(int) - Method in class jakarta.servlet.http.Cookie
-
Sets the version of the cookie protocol that this Cookie complies with.
- setWriteListener(WriteListener) - Method in class jakarta.servlet.ServletOutputStream
-
Instructs the
ServletOutputStream
to invoke the provided
WriteListener
when it is possible to
write
- SingleThreadModel - Interface in jakarta.servlet
-
- start(Runnable) - Method in interface jakarta.servlet.AsyncContext
-
Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified
Runnable.
- startAsync() - Method in interface jakarta.servlet.ServletRequest
-
Puts this request into asynchronous mode, and initializes its
AsyncContext
with the original (unwrapped)
ServletRequest and ServletResponse objects.
- startAsync(ServletRequest, ServletResponse) - Method in interface jakarta.servlet.ServletRequest
-
Puts this request into asynchronous mode, and initializes its
AsyncContext
with the given request and
response objects.
- startAsync() - Method in class jakarta.servlet.ServletRequestWrapper
-
- startAsync(ServletRequest, ServletResponse) - Method in class jakarta.servlet.ServletRequestWrapper
-