A B C D E F G H I J L M N O P Q 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

Adds the filter with the given name and class name to this servlet context.

addFilter(String, Filter) - Method in interface javax.servlet.ServletContext

Registers the given filter instance with this ServletContext under the given filterName.

addFilter(String, Class<? extends Filter>) - Method in interface javax.servlet.ServletContext

Adds the filter with the given name and class type to this servlet 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.

addHeader(String, String) - Method in interface javax.servlet.http.PushBuilder

Add a request header to be used for the push.

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.

addJspFile(String, String) - Method in interface javax.servlet.ServletContext

Adds the servlet with the given jsp file to this servlet context.

addListener(AsyncListener) - Method in interface javax.servlet.AsyncContext

Registers the given AsyncListener with the most recent asynchronous cycle that was started by a call to one of the ServletRequest.startAsync() methods.

addListener(AsyncListener, ServletRequest, ServletResponse) - Method in interface javax.servlet.AsyncContext

Registers the given AsyncListener with the most recent asynchronous cycle that was started by a call to one of the ServletRequest.startAsync() methods.

addListener(String) - Method in interface javax.servlet.ServletContext

Adds the listener with the given class name to this ServletContext.

addListener(T) - Method in interface javax.servlet.ServletContext

Adds the given listener to this ServletContext.

addListener(Class<? extends EventListener>) - Method in interface javax.servlet.ServletContext

Adds a listener of the given class type to this ServletContext.

addMapping(String...) - Method in interface javax.servlet.ServletRegistration

Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.

addMappingForServletNames(EnumSet<DispatcherType>, boolean, String...) - Method in interface javax.servlet.FilterRegistration

Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this FilterRegistration.

addMappingForUrlPatterns(EnumSet<DispatcherType>, boolean, String...) - Method in interface javax.servlet.FilterRegistration

Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this FilterRegistration.

addServlet(String, String) - Method in interface javax.servlet.ServletContext

Adds the servlet with the given name and class name to this servlet context.

addServlet(String, Servlet) - Method in interface javax.servlet.ServletContext

Registers the given servlet instance with this ServletContext under the given servletName.

addServlet(String, Class<? extends Servlet>) - Method in interface javax.servlet.ServletContext

Adds the servlet with the given name and class type to this servlet context.

ASYNC_CONTEXT_PATH - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original context path is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

ASYNC_MAPPING - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original HttpServletMapping is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

ASYNC_PATH_INFO - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original path info is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

ASYNC_QUERY_STRING - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original query string is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

ASYNC_REQUEST_URI - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original request URI is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

ASYNC_SERVLET_PATH - Static variable in interface javax.servlet.AsyncContext

The name of the request attribute under which the original servlet path is made available to the target of a AsyncContext.dispatch(String) or AsyncContext.dispatch(ServletContext,String)

AsyncContext - Interface in javax.servlet

Class representing the execution context for an asynchronous operation that was initiated on a ServletRequest.

AsyncEvent - Class in javax.servlet

Event that gets fired when the asynchronous operation initiated on a ServletRequest (via a call to ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse)) has completed, timed out, or produced an error.

AsyncEvent(AsyncContext) - Constructor for class javax.servlet.AsyncEvent

Constructs an AsyncEvent from the given AsyncContext.

AsyncEvent(AsyncContext, ServletRequest, ServletResponse) - Constructor for class javax.servlet.AsyncEvent

Constructs an AsyncEvent from the given AsyncContext, ServletRequest, and ServletResponse.

AsyncEvent(AsyncContext, Throwable) - Constructor for class javax.servlet.AsyncEvent

Constructs an AsyncEvent from the given AsyncContext and Throwable.

AsyncEvent(AsyncContext, ServletRequest, ServletResponse, Throwable) - Constructor for class javax.servlet.AsyncEvent

Constructs an AsyncEvent from the given AsyncContext, ServletRequest, ServletResponse, and Throwable.

AsyncListener - Interface in javax.servlet

Listener that will be notified in the event that an asynchronous operation initiated on a ServletRequest to which the listener had been added has completed, timed out, or resulted in an error.

attributeAdded(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener

Receives notification that an attribute has been added to a session.

attributeAdded(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener

Receives notification that an attribute has been added to the ServletContext.

attributeAdded(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener

Receives notification that an attribute has been added to the ServletRequest.

attributeRemoved(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener

Receives notification that an attribute has been removed from a session.

attributeRemoved(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener

Receives notification that an attribute has been removed from the ServletContext.

attributeRemoved(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener

Receives notification that an attribute has been removed from the ServletRequest.

attributeReplaced(HttpSessionBindingEvent) - Method in interface javax.servlet.http.HttpSessionAttributeListener

Receives notification that an attribute has been replaced in a session.

attributeReplaced(ServletContextAttributeEvent) - Method in interface javax.servlet.ServletContextAttributeListener

Receives notification that an attribute has been replaced in the ServletContext.

attributeReplaced(ServletRequestAttributeEvent) - Method in interface javax.servlet.ServletRequestAttributeListener

Receives notification that an attribute has been replaced on the ServletRequest.

authenticate(HttpServletResponse) - Method in interface javax.servlet.http.HttpServletRequest

Use the container login mechanism configured for the ServletContext to authenticate the user making this request.

authenticate(HttpServletResponse) - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call authenticate on the wrapped request object.

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

Change the session id of the current session associated with this request and return the new session id.

changeSessionId() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to return 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

Completes the asynchronous operation that was started on the request that was used to initialze this AsyncContext, closing the response that was used to initialize this 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

Receives notification that the ServletContext is about to be shut down.

contextInitialized(ServletContextEvent) - Method in interface javax.servlet.ServletContextListener

Receives 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 the specified name and value.

createFilter(Class<T>) - Method in interface javax.servlet.ServletContext

Instantiates the given Filter class.

createListener(Class<T>) - Method in interface javax.servlet.AsyncContext

Instantiates the given AsyncListener class.

createListener(Class<T>) - Method in interface javax.servlet.ServletContext

Instantiates the given EventListener class.

createServlet(Class<T>) - Method in interface javax.servlet.ServletContext

Instantiates the given Servlet class.

D

declareRoles(String...) - Method in interface javax.servlet.ServletContext

Declares role names that are tested using isUserInRole.

delete() - Method in interface javax.servlet.http.Part

Deletes the underlying storage for a file item, 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

It is called when the client is disconnected.

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

Dispatches the request and response objects of this AsyncContext to the servlet container.

dispatch(String) - Method in interface javax.servlet.AsyncContext

Dispatches the request and response objects of this AsyncContext to the given path.

dispatch(ServletContext, String) - Method in interface javax.servlet.AsyncContext

Dispatches the request and response objects of this AsyncContext to the given path scoped to the given context.

DispatcherType - Enum in javax.servlet

Enumeration of filter dispatcher types.

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.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class javax.servlet.http.HttpFilter

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(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class javax.servlet.http.HttpFilter

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.

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 a 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 2.1, use HttpServletResponseWrapper.encodeRedirectURL(String url) instead

encodeURL(String) - Method in interface javax.servlet.http.HttpServletResponse

Encodes the specified URL by including the session ID, 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 2.1, use HttpServletResponseWrapper.encodeURL(String url) instead

ERROR_EXCEPTION - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the exception object is propagated during an error dispatch

ERROR_EXCEPTION_TYPE - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the type of the exception object is propagated during an error dispatch

ERROR_MESSAGE - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the exception message is propagated during an error dispatch

ERROR_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the request URI whose processing caused the error is propagated during an error dispatch

ERROR_SERVLET_NAME - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the name of the servlet in which the error occurred is propagated during an error dispatch

ERROR_STATUS_CODE - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the response status is propagated during an error dispatch

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

Interface through which a Filter may be further configured.

FilterRegistration.Dynamic - Interface in javax.servlet

Interface through which a Filter registered via one of the addFilter methods on ServletContext may be further configured.

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 under which the original context path is made available to the target of a forward

FORWARD_MAPPING - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the original HttpServletMapping is made available to the target of a forward

FORWARD_PATH_INFO - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the original path info is made available to the target of a forward

FORWARD_QUERY_STRING - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the original query string is made available to the target of a forward

FORWARD_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the original request URI is made available to the target of a forward

FORWARD_SERVLET_PATH - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the original servlet path is made available to the target of a forward

G

GenericFilter - Class in javax.servlet

Defines a generic, protocol-independent filter.

GenericFilter() - Constructor for class javax.servlet.GenericFilter

Does nothing.

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

Gets the AsyncContext from this AsyncEvent.

getAsyncContext() - Method in interface javax.servlet.ServletRequest

Gets the AsyncContext that was created or reinitialized by the most recent invocation of ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest,ServletResponse) on this request.

getAsyncContext() - Method in class javax.servlet.ServletRequestWrapper

Gets the AsyncContext that was created or reinitialized by the most recent invocation of ServletRequestWrapper.startAsync() or ServletRequestWrapper.startAsync(ServletRequest,ServletResponse) on the wrapped request.

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 ServletContext.

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

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 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

Gets the class loader of the web application represented by this ServletContext.

getClassName() - Method in interface javax.servlet.Registration

Gets the fully qualified class name of the Servlet or Filter that is represented by this 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

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 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 or is greater than Integer.MAX_VALUE.

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

Gets the content type of this part.

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

Returns the context path of the web application.

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

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 javax.servlet.ServletContext

Gets the session tracking modes that are supported by default for this ServletContext.

getDeferredSyntaxAllowedAsLiteral() - Method in interface javax.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 javax.servlet.ServletRequest

Gets the dispatcher type of this request.

getDispatcherType() - Method in class javax.servlet.ServletRequestWrapper

Gets the dispatcher type of the wrapped request.

getDomain() - Method in class javax.servlet.http.Cookie

Gets the domain name of this Cookie.

getDomain() - Method in interface javax.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 javax.servlet.ServletContext

Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.

getEffectiveMinorVersion() - Method in interface javax.servlet.ServletContext

Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.

getEffectiveSessionTrackingModes() - Method in interface javax.servlet.ServletContext

Gets the session tracking modes that are in effect for this ServletContext.

getElIgnored() - Method in interface javax.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 javax.servlet.HttpConstraintElement

Gets the default authorization semantic.

getErrorOnUndeclaredNamespace() - Method in interface javax.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 javax.servlet.MultipartConfigElement

Gets the size threshold after which files will be written to disk.

getFilterConfig() - Method in class javax.servlet.GenericFilter

Returns this servlet's ServletConfig object.

getFilterName() - Method in interface javax.servlet.FilterConfig

Returns the filter-name of this filter as defined in the deployment descriptor.

getFilterName() - Method in class javax.servlet.GenericFilter

Returns the name of this filter instance.

getFilterRegistration(String) - Method in interface javax.servlet.ServletContext

Gets the FilterRegistration corresponding to the filter with the given filterName.

getFilterRegistrations() - Method in interface javax.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 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

Gets the value of the response header with the given name.

getHeader(String) - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getHeader(java.lang.String) on the wrapped response object.

getHeader(String) - Method in interface javax.servlet.http.Part

Returns the value of the specified mime header as a String.

getHeader(String) - Method in interface javax.servlet.http.PushBuilder

Return the header of the given name to be used for the push.

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

Gets the names of the headers of this response.

getHeaderNames() - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getHeaderNames() on the wrapped response object.

getHeaderNames() - Method in interface javax.servlet.http.Part

Gets the header names of this Part.

getHeaderNames() - Method in interface javax.servlet.http.PushBuilder

Return the set of header to be used for the push.

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

Gets the values of the response header with the given name.

getHeaders(String) - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getHeaders(java.lang.String) on the wrapped response object.

getHeaders(String) - Method in interface javax.servlet.http.Part

Gets the values of the Part header with the given name.

getHttpMethodConstraints() - Method in class javax.servlet.ServletSecurityElement

Gets the (possibly empty) collection of HTTP Method specific constraint elements.

getHttpServletMapping() - Method in interface javax.servlet.http.HttpServletRequest

Return the HttpServletMapping by which the HttpServlet for this HttpServletRequest was invoked.

getHttpServletMapping() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to return getServletMapping() on the wrapped request object.

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

Gets the include-coda configuration of the JSP property group represented by this JspPropertyGroupDescriptor.

getIncludePreludes() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor

Gets the include-prelude configuration of the JSP property group represented by this JspPropertyGroupDescriptor.

getInitParameter(String) - Method in interface javax.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 javax.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 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

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 javax.servlet.ServletConfig

Gets the value of the initialization parameter with the given name.

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.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 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

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 javax.servlet.http.Part

Gets the content of this part as an InputStream

getInputStream() - Method in interface javax.servlet.http.WebConnection

Returns an input stream for this web connection.

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

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 javax.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 javax.servlet.descriptor.JspConfigDescriptor

Gets the <jsp-property-group> child elements of the <jsp-config> element represented by this 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

Gets the directory location where files will be stored.

getMajorVersion() - Method in interface javax.servlet.ServletContext

Returns the major version of Jakarta Servlet that this container supports.

getMappingMatch() - Method in interface javax.servlet.http.HttpServletMapping

Return the MappingMatch for this instance

getMappings() - Method in interface javax.servlet.ServletRegistration

Gets the currently available mappings of the Servlet represented by this ServletRegistration.

getMatchValue() - Method in interface javax.servlet.http.HttpServletMapping

Return the portion of the URI path that caused this request to be matched.

getMaxAge() - Method in class javax.servlet.http.Cookie

Gets the maximum age in seconds of this Cookie.

getMaxAge() - Method in interface javax.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 javax.servlet.MultipartConfigElement

Gets the maximum size allowed for uploaded files.

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

Gets the maximum size allowed for multipart/form-data requests.

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.

getMethod() - Method in interface javax.servlet.http.PushBuilder

Return the method to be used for the push.

getMethodName() - Method in class javax.servlet.HttpMethodConstraintElement

Gets the HTTP method name.

getMethodNames() - Method in class javax.servlet.ServletSecurityElement

Gets the set of HTTP method names named by the HttpMethodConstraints.

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 Jakarta Servlet that this 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

Gets the name of this part

getName() - Method in interface javax.servlet.Registration

Gets the name of the Servlet or Filter that is represented by this Registration.

getName() - Method in class javax.servlet.ServletContextAttributeEvent

Gets the name of the ServletContext attribute that changed.

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

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 javax.servlet.ServletContext

Returns a RequestDispatcher object that acts as a wrapper for the named servlet.

getOutputStream() - Method in interface javax.servlet.http.WebConnection

Returns an output stream for this web connection.

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

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 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 Part with the given name.

getPart(String) - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call getPart on the wrapped request object.

getParts() - Method in interface javax.servlet.http.HttpServletRequest

Gets all the Part components of this request, provided that it is of type multipart/form-data.

getParts() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call getParts on the wrapped request object.

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.http.PushBuilder

Return the URI path to be used for the push.

getPath() - Method in interface javax.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 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.

getPattern() - Method in interface javax.servlet.http.HttpServletMapping

Return the String representation for the url-pattern for this mapping.

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.

getQueryString() - Method in interface javax.servlet.http.PushBuilder

Return the query string to be used for the push.

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

Gets the real path corresponding to the 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 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead

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

Gets the request that was used to initialize this AsyncContext by calling ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse).

getRequest() - Method in class javax.servlet.ServletRequestWrapper

Return the wrapped request object.

getRequestCharacterEncoding() - Method in interface javax.servlet.ServletContext

Gets the request character encoding that are supported by default for this ServletContext.

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 the given 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

Gets the response that was used to initialize this AsyncContext by calling ServletRequest.startAsync() or ServletRequest.startAsync(ServletRequest, ServletResponse).

getResponse() - Method in class javax.servlet.ServletResponseWrapper

Return the wrapped ServletResponse object.

getResponseCharacterEncoding() - Method in interface javax.servlet.ServletContext

Gets the response character encoding that are supported by default for this ServletContext.

getRolesAllowed() - Method in class javax.servlet.HttpConstraintElement

Gets the names of the authorized roles.

getRootCause() - Method in exception javax.servlet.ServletException

Returns the exception that caused this servlet exception.

getRunAsRole() - Method in interface javax.servlet.ServletRegistration

Gets the name of the runAs role of the Servlet represented by this 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

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 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.

This method was originally defined to retrieve a servlet from a ServletContext. In this version, this method always returns null and remains only to preserve binary compatibility. This method will be permanently removed in a future version of Jakarta Servlets.

In lieu of this method, servlets can share information using the ServletContext class and can perform shared business logic by invoking methods on common non-servlet classes.

getServlet() - Method in exception javax.servlet.UnavailableException

Deprecated.

As of Java Servlet API 2.2, with no replacement. Returns the servlet that is reporting its unavailability.

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.GenericFilter

Returns a reference to the ServletContext in which this filter is running.

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

Gets the servlet context to which this ServletRequest was last dispatched.

getServletContext() - Method in class javax.servlet.ServletRequestEvent

Returns the ServletContext of this web application.

getServletContext() - Method in class javax.servlet.ServletRequestWrapper

Gets the servlet context to which the wrapped servlet request was last dispatched.

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.http.HttpServletMapping

Return the String representation for the servlet-name for this mapping.

getServletName() - Method in interface javax.servlet.ServletConfig

Returns the name of this servlet instance.

getServletNameMappings() - Method in interface javax.servlet.FilterRegistration

Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.

getServletNames() - Method in interface javax.servlet.ServletContext

Deprecated.

As of Java Servlet API 2.1, with no replacement.

This method was originally defined to return an Enumeration of all the servlet names known to this context. In this version, this method always returns an empty Enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of Jakarta Servlets.

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

Gets the ServletRegistration corresponding to the servlet with the given servletName.

getServletRegistrations() - Method in interface javax.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 javax.servlet.ServletRequestEvent

Returns the ServletRequest that is changing.

getServlets() - Method in interface javax.servlet.ServletContext

Deprecated.

As of Java Servlet API 2.0, with no replacement.

This method was originally defined to return an Enumeration of all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of Jakarta Servlets.

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

Return 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

Return 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 Jakarta Servlets.

getSessionCookieConfig() - Method in interface javax.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 javax.servlet.http.PushBuilder

Return the SessionID to be used for the push.

getSessionTimeout() - Method in interface javax.servlet.ServletContext

Gets the session timeout in minutes that are supported by default for this ServletContext.

getSize() - Method in interface javax.servlet.http.Part

Returns the size of this fille.

getStatus() - Method in interface javax.servlet.http.HttpServletResponse

Gets the current status code of this response.

getStatus() - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getStatus() on the wrapped response object.

getSubmittedFileName() - Method in interface javax.servlet.http.Part

Gets the file name specified by the client

getSuppliedRequest() - Method in class javax.servlet.AsyncEvent

Gets the ServletRequest from this AsyncEvent.

getSuppliedResponse() - Method in class javax.servlet.AsyncEvent

Gets the ServletResponse from this AsyncEvent.

getTaglibLocation() - Method in interface javax.servlet.descriptor.TaglibDescriptor

Gets the location of the tag library represented by this TaglibDescriptor.

getTaglibs() - Method in interface javax.servlet.descriptor.JspConfigDescriptor

Gets the <taglib> child elements of the <jsp-config> element represented by this JspConfigDescriptor.

getTaglibURI() - Method in interface javax.servlet.descriptor.TaglibDescriptor

Gets the unique identifier of the tag library represented by this TaglibDescriptor.

getThrowable() - Method in class javax.servlet.AsyncEvent

Gets the Throwable from this AsyncEvent.

getTimeout() - Method in interface javax.servlet.AsyncContext

Gets the timeout (in milliseconds) for this AsyncContext.

getTrailerFields() - Method in interface javax.servlet.http.HttpServletRequest

Get the request trailer fields.

getTrailerFields() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call getTrailerFields on the wrapped request object.

getTrailerFields() - Method in interface javax.servlet.http.HttpServletResponse

Gets the supplier of trailer headers.

getTrailerFields() - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.getTrailerFields() on the wrapped response object.

getTransportGuarantee() - Method in class javax.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 javax.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 javax.servlet.UnavailableException

Returns the number of seconds the servlet expects to be temporarily unavailable.

getUrlPatternMappings() - Method in interface javax.servlet.FilterRegistration

Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.

getUrlPatterns() - Method in interface javax.servlet.descriptor.JspPropertyGroupDescriptor

Gets the URL patterns of the JSP property group represented by this 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

Gets the current value of this 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

Gets the value of the ServletContext attribute that changed.

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

Returns the configuration name of the logical host on which the ServletContext 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 the class types that a ServletContainerInitializer can handle.

hasOriginalRequestAndResponse() - Method in interface javax.servlet.AsyncContext

Checks if this AsyncContext was initialized with the original or application-wrapped request and response objects.

HttpConstraint - Annotation Type in javax.servlet.annotation

This annotation is used within the ServletSecurity annotation to represent the security constraints to be applied to all HTTP protocol methods for which a corresponding HttpMethodConstraint element does NOT occur within the ServletSecurity annotation.

HttpConstraintElement - Class in javax.servlet

Java Class representation of an HttpConstraint annotation value.

HttpConstraintElement() - Constructor for class javax.servlet.HttpConstraintElement

Constructs a default HTTP constraint element

HttpConstraintElement(ServletSecurity.EmptyRoleSemantic) - Constructor for class javax.servlet.HttpConstraintElement

Convenience constructor to establish EmptyRoleSemantic.DENY

HttpConstraintElement(ServletSecurity.TransportGuarantee, String...) - Constructor for class javax.servlet.HttpConstraintElement

Constructor to establish non-empty getRolesAllowed and/or TransportGuarantee.CONFIDENTIAL.

HttpConstraintElement(ServletSecurity.EmptyRoleSemantic, ServletSecurity.TransportGuarantee, String...) - Constructor for class javax.servlet.HttpConstraintElement

Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee.

HttpFilter - Class in javax.servlet.http

Provides an abstract class to be subclassed to create an HTTP filter suitable for a Web site.

HttpFilter() - Constructor for class javax.servlet.http.HttpFilter

Does nothing, because this is an abstract class.

HttpMethodConstraint - Annotation Type in javax.servlet.annotation

This annotation is used within the ServletSecurity annotation to represent security constraints on specific HTTP protocol messages.

HttpMethodConstraintElement - Class in javax.servlet

Java Class represntation of an HttpMethodConstraint annotation value.

HttpMethodConstraintElement(String) - Constructor for class javax.servlet.HttpMethodConstraintElement

Constructs an instance with default HttpConstraintElement value.

HttpMethodConstraintElement(String, HttpConstraintElement) - Constructor for class javax.servlet.HttpMethodConstraintElement

Constructs an instance with specified HttpConstraintElement value.

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.

HttpServletMapping - Interface in javax.servlet.http

Allows runtime discovery of the manner in which the HttpServlet for the current HttpServletRequest was invoked.

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

Interface for receiving notification events about HttpSession attribute changes.

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

Interface for receiving notification events about HttpSession id changes.

HttpSessionListener - Interface in javax.servlet.http

Interface for receiving notification events about HttpSession lifecycle changes.

HttpUpgradeHandler - Interface in javax.servlet.http

This interface encapsulates the upgrade protocol processing.

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 under which the context path of the target of an include is stored

INCLUDE_MAPPING - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the HttpServletMapping of the target of an include is stored

INCLUDE_PATH_INFO - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the path info of the target of an include is stored

INCLUDE_QUERY_STRING - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the query string of the target of an include is stored

INCLUDE_REQUEST_URI - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the request URI of the target of an include is stored

INCLUDE_SERVLET_PATH - Static variable in interface javax.servlet.RequestDispatcher

The name of the request attribute under which the servlet path of the target of an include is stored

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(FilterConfig) - Method in class javax.servlet.GenericFilter

Called by the servlet container to indicate to a filter that it is being placed into service.

init() - Method in class javax.servlet.GenericFilter

A convenience method which can be overridden so that there's no need to call super.init(config).

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

It is called once the HTTP Upgrade process has been completed and the upgraded connection is ready to start using the new protocol.

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

Checks if this request has been put into asynchronous mode.

isAsyncStarted() - Method in class javax.servlet.ServletRequestWrapper

Checks if the wrapped request has been put into asynchronous mode.

isAsyncSupported() - Method in interface javax.servlet.ServletRequest

Checks if this request supports asynchronous operation.

isAsyncSupported() - Method in class javax.servlet.ServletRequestWrapper

Checks if the wrapped request supports asynchronous operation.

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

Returns true when all the data from the stream has been read else it returns false.

isHttpOnly() - Method in class javax.servlet.http.Cookie

Checks whether this Cookie has been marked as HttpOnly.

isHttpOnly() - Method in interface javax.servlet.SessionCookieConfig

Checks if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as HttpOnly.

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

Returns true if data can be read without blocking else returns false.

isReady() - Method in class javax.servlet.ServletOutputStream

This method can be used to determine if data can be written without blocking.

isRequestedSessionIdFromCookie() - Method in interface javax.servlet.http.HttpServletRequest

Checks whether the requested session ID was conveyed to the server as an HTTP 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 was conveyed to the server 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 4.0 of the Java Servlet API, use HttpServletRequestWrapper.isRequestedSessionIdFromURL() instead.

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

Checks if the session tracking cookies created on behalf of the application represented by the ServletContext from which this SessionCookieConfig was acquired will be marked as secure even if the request that initiated the corresponding session is using plain HTTP instead of HTTPS.

isTrailerFieldsReady() - Method in interface javax.servlet.http.HttpServletRequest

Return a boolean indicating whether trailer fields are ready to read using HttpServletRequest.getTrailerFields().

isTrailerFieldsReady() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call isTrailerFieldsReady on the wrapped request object.

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

Checks (recursively) if this ServletRequestWrapper wraps the given ServletRequest instance.

isWrapperFor(Class<?>) - Method in class javax.servlet.ServletRequestWrapper

Checks (recursively) if this ServletRequestWrapper wraps a ServletRequest of the given class type.

isWrapperFor(ServletResponse) - Method in class javax.servlet.ServletResponseWrapper

Checks (recursively) if this ServletResponseWrapper wraps the given ServletResponse instance.

isWrapperFor(Class<?>) - Method in class javax.servlet.ServletResponseWrapper

Checks (recursively) if this ServletResponseWrapper wraps a ServletResponse of the given class type.

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

The javax.servlet.annotation package contains a number of annotations that allow users to use annotations to declare servlets, filters, listeners and specify the metadata for the declared component.

javax.servlet.descriptor - package javax.servlet.descriptor

Provides programmatic access to a web application's configuration information that was aggregated from the web.xml and web-fragment.xml descriptors.

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

This interface provides access to the <jsp-config> related configuration of a web application.

JspPropertyGroupDescriptor - Interface in javax.servlet.descriptor

This interface provides access to the <jsp-property-group> related configuration of a web application.

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

Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.

login(String, String) - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call login on the wrapped request object.

logout() - Method in interface javax.servlet.http.HttpServletRequest

Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.

logout() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call login on the wrapped request object.

M

MappingMatch - Enum in javax.servlet.http

Enumeration of Servlet mapping types.

method(String) - Method in interface javax.servlet.http.PushBuilder

Set the method to be used for the push.

MultipartConfig - Annotation Type in javax.servlet.annotation

Annotation that may be specified on a Servlet class, indicating that instances of the Servlet expect requests that conform to the multipart/form-data MIME type.

MultipartConfigElement - Class in javax.servlet

Java Class represntation of an MultipartConfig annotation value.

MultipartConfigElement(String) - Constructor for class javax.servlet.MultipartConfigElement

Constructs an instance with defaults for all but location.

MultipartConfigElement(String, long, long, int) - Constructor for class javax.servlet.MultipartConfigElement

Constructs an instance with all values specified.

MultipartConfigElement(MultipartConfig) - Constructor for class javax.servlet.MultipartConfigElement

Constructs an instance from a MultipartConfig annotation value.

N

newPushBuilder() - Method in interface javax.servlet.http.HttpServletRequest

Instantiates a new instance of PushBuilder for issuing server push responses from the current request.

newPushBuilder() - Method in class javax.servlet.http.HttpServletRequestWrapper

The default behavior of this method is to call newPushBuilder on the wrapped request object.

O

onAllDataRead() - Method in interface javax.servlet.ReadListener

Invoked when all data for the current request has been read.

onComplete(AsyncEvent) - Method in interface javax.servlet.AsyncListener

Notifies this AsyncListener that an asynchronous operation has been completed.

onDataAvailable() - Method in interface javax.servlet.ReadListener

When an instance of the ReadListener is registered with a ServletInputStream, this method will be invoked by the container the first time when it is possible to read data.

onError(AsyncEvent) - Method in interface javax.servlet.AsyncListener

Notifies this AsyncListener that an asynchronous operation has failed to complete.

onError(Throwable) - Method in interface javax.servlet.ReadListener

Invoked when an error occurs processing the request.

onError(Throwable) - Method in interface javax.servlet.WriteListener

Invoked when an error occurs writing data using the non-blocking APIs.

onStartAsync(AsyncEvent) - Method in interface javax.servlet.AsyncListener

Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the ServletRequest.startAsync() methods.

onStartup(Set<Class<?>>, ServletContext) - Method in interface javax.servlet.ServletContainerInitializer

Notifies this ServletContainerInitializer of the startup of the application represented by the given ServletContext.

onTimeout(AsyncEvent) - Method in interface javax.servlet.AsyncListener

Notifies this AsyncListener that an asynchronous operation has timed out.

onWritePossible() - Method in interface javax.servlet.WriteListener

When an instance of the WriteListener is registered with a ServletOutputStream, this method will be invoked by the container the first time when it is possible to write data.

ORDERED_LIBS - Static variable in interface javax.servlet.ServletContext

The name of the ServletContext attribute whose value (of type java.util.List<java.lang.String>) contains the list of names of JAR files in WEB-INF/lib ordered by their web fragment names (with possible exclusions if <absolute-ordering> without any <others/> is being used), or null if no absolute or relative ordering has been specified

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 or form item that was received within a multipart/form-data POST request.

path(String) - Method in interface javax.servlet.http.PushBuilder

Set the URI path to be used for the push.

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).

push() - Method in interface javax.servlet.http.PushBuilder

Push a resource given the current state of the builder, the method must be non-blocking.

PushBuilder - Interface in javax.servlet.http

Build a request to be pushed.

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)

Q

queryString(String) - Method in interface javax.servlet.http.PushBuilder

Set the query string to be used for the push.

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

This class represents a call-back mechanism that will notify implementations as HTTP request data becomes available to be read without blocking.

Registration - Interface in javax.servlet

Interface through which a Servlet or Filter may be further configured.

Registration.Dynamic - Interface in javax.servlet

Interface through which a Servlet or Filter registered via one of the addServlet or addFilter methods, respectively, on ServletContext may be further configured.

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 this ServletContext.

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.

removeHeader(String) - Method in interface javax.servlet.http.PushBuilder

Remove the named request header.

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

Receives notification that a ServletRequest 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

Receives notification that a ServletRequest 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, 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 and clears the 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 and clears the buffer.

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 doXXX 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

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 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

Event class for notifications about changes to the attributes of the ServletContext of a web application.

ServletContextAttributeEvent(ServletContext, String, Object) - Constructor for class javax.servlet.ServletContextAttributeEvent

Constructs a ServletContextAttributeEvent from the given ServletContext, attribute name, and attribute value.

ServletContextAttributeListener - Interface in javax.servlet

Interface for receiving notification events about ServletContext attribute changes.

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

Interface for receiving notification events about ServletContext lifecycle changes.

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

Interface through which a Servlet may be further configured.

ServletRegistration.Dynamic - Interface in javax.servlet

Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.

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

Interface for receiving notification events about ServletRequest 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

Interface for receiving notification events about requests coming into and going out of scope of a web application.

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

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 javax.servlet.annotation

Defines the access semantic to be applied to an empty rolesAllowed array.

ServletSecurity.TransportGuarantee - Enum in javax.servlet.annotation

Defines the data protection requirements that must be satisfied by the transport

ServletSecurityElement - Class in javax.servlet

Java Class representation of a ServletSecurity annotation value.

ServletSecurityElement() - Constructor for class javax.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 javax.servlet.ServletSecurityElement

Constructs an instance with a default Constraint element and with no HTTP Method specific constraint elements.

ServletSecurityElement(Collection<HttpMethodConstraintElement>) - Constructor for class javax.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 javax.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 javax.servlet.ServletSecurityElement

Constructs an instance from a ServletSecurity annotation value.

SessionCookieConfig - Interface in javax.servlet

Class that may be used to configure various properties of cookies used for session tracking purposes.

sessionCreated(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionListener

Receives notification that a session has been created.

sessionDestroyed(HttpSessionEvent) - Method in interface javax.servlet.http.HttpSessionListener

Receives 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.

sessionId(String) - Method in interface javax.servlet.http.PushBuilder

Set the SessionID to be used for the push.

sessionIdChanged(HttpSessionEvent, String) - Method in interface javax.servlet.http.HttpSessionIdListener

Receives notification that session id has been changed in a session.

SessionTrackingMode - Enum in javax.servlet

Enumeration of session tracking modes.

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

Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not.

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 ServletContext.

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 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 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 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 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.

setHeader(String, String) - Method in interface javax.servlet.http.PushBuilder

Set a request header to be used for the push.

setHttpOnly(boolean) - Method in class javax.servlet.http.Cookie

Marks or unmarks this Cookie as HttpOnly.

setHttpOnly(boolean) - Method in interface javax.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 javax.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 javax.servlet.ServletContext

Sets the context initialization parameter with the given name and value on this ServletContext.

setInitParameters(Map<String, String>) - Method in interface javax.servlet.Registration

Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.

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

Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration.

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 in seconds for this Cookie.

setMaxAge(int) - Method in interface javax.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 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

Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration.

setName(String) - Method in interface javax.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 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 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 javax.servlet.ServletInputStream

Instructs the ServletInputStream to invoke the provided ReadListener when it is possible to read

setRequest(ServletRequest) - Method in class javax.servlet.ServletRequestWrapper

Sets the request object being wrapped.

setRequestCharacterEncoding(String) - Method in interface javax.servlet.ServletContext

Sets the request character encoding for this ServletContext.

setResponse(ServletResponse) - Method in class javax.servlet.ServletResponseWrapper

Sets the response being wrapped.

setResponseCharacterEncoding(String) - Method in interface javax.servlet.ServletContext

Sets the response character encoding for this ServletContext.

setRunAsRole(String) - Method in interface javax.servlet.ServletRegistration.Dynamic

Sets the name of the runAs role for this ServletRegistration.

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

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 javax.servlet.ServletRegistration.Dynamic

Sets the ServletSecurityElement to be applied to the mappings defined for this ServletRegistration.

setSessionTimeout(int) - Method in interface javax.servlet.ServletContext

Sets the session timeout in minutes for this ServletContext.

setSessionTrackingModes(Set<SessionTrackingMode>) - Method in interface javax.servlet.ServletContext

Sets the session tracking modes that are to become effective for this ServletContext.

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). Sets the status code and message for this response.

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 2.1, due to ambiguous meaning of the message parameter. To set a status code use HttpServletResponseWrapper.setStatus(int), to send an error with a description use HttpServletResponseWrapper.sendError(int, String)

setTimeout(long) - Method in interface javax.servlet.AsyncContext

Sets the timeout (in milliseconds) for this AsyncContext.

setTrailerFields(Supplier<Map<String, String>>) - Method in interface javax.servlet.http.HttpServletResponse

Sets the supplier of trailer headers.

setTrailerFields(Supplier<Map<String, String>>) - Method in class javax.servlet.http.HttpServletResponseWrapper

The default behaviour of this method is to call HttpServletResponse.setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String, java.lang.String>>) on the wrapped response object.

setValue(String) - Method in class javax.servlet.http.Cookie

Assigns a new value to this Cookie.

setVersion(int) - Method in class javax.servlet.http.Cookie

Sets the version of the cookie protocol that this Cookie complies with.

setWriteListener(WriteListener) - Method in class javax.servlet.ServletOutputStream

Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write

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

Causes the container to dispatch a thread, possibly from a managed thread pool, to run the specified Runnable.

startAsync() - Method in interface javax.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 javax.servlet.ServletRequest

Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects.

startAsync() - Method in class javax.servlet.ServletRequestWrapper

The default behavior of this method is to invoke ServletRequest.startAsync() on the wrapped request object.

startAsync(ServletRequest, ServletResponse) - Method in class javax.servlet.ServletRequestWrapper

The default behavior of this method is to invoke ServletRequest.startAsync(ServletRequest, ServletResponse) on the wrapped request object.

T

TaglibDescriptor - Interface in javax.servlet.descriptor

This interface provides access to the <taglib> related configuration of a web application.

TEMPDIR - Static variable in interface javax.servlet.ServletContext

The name of the ServletContext attribute which stores the private temporary directory (of type java.io.File) provided by the servlet container for the 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

Creates an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade processing.

upgrade(Class<T>) - Method in class javax.servlet.http.HttpServletRequestWrapper

Create an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade 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.http.MappingMatch

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.http.MappingMatch

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

This interface encapsulates the connection for an upgrade request.

WebFilter - Annotation Type in javax.servlet.annotation

Annotation used to declare a servlet filter.

WebInitParam - Annotation Type in javax.servlet.annotation

This annotation is used on a Servlet or Filter implementation class to specify an initialization parameter.

WebListener - Annotation Type in javax.servlet.annotation

This annotation is used to declare a WebListener.

WebServlet - Annotation Type in javax.servlet.annotation

Annotation used to declare a servlet.

write(String) - Method in interface javax.servlet.http.Part

A convenience method to write this uploaded item to disk.

WriteListener - Interface in javax.servlet

Callback notification mechanism that signals to the developer it's possible to write content without blocking.

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