org.apache.catalina.connector.RequestFacade
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class RequestFacade
Facade class that wraps a Coyote request object. All methods are delegated to the wrapped request.
| Field Summary | |
|---|---|
protected Request |
request
The wrapped request. |
protected static StringManager |
sm
The string manager for this package. |
| Fields inherited from interface javax.servlet.http.HttpServletRequest |
|---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
| Constructor Summary | |
|---|---|
RequestFacade(Request request)
Construct a wrapper for the specified request. |
|
| Method Summary | |
|---|---|
boolean |
authenticate(javax.servlet.http.HttpServletResponse response)
Use the container login mechanism configured for the ServletContext to authenticate the user making
this request. |
void |
clear()
Clear facade. |
protected java.lang.Object |
clone()
Prevent cloning the facade. |
javax.servlet.AsyncContext |
getAsyncContext()
Gets the AsyncContext that was created or reinitialized by the most recent invocation of ServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on this request. |
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of the named attribute as an Object,
or null if no attribute of the given name exists. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration containing the
names of the attributes available to this request. |
java.lang.String |
getAuthType()
Returns the name of the authentication scheme used to protect the servlet. |
java.lang.String |
getCharacterEncoding()
Returns the name of the character encoding used in the body of this request. |
int |
getContentLength()
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. |
java.lang.String |
getContentType()
Returns the MIME type of the body of the request, or null if the type is not known. |
java.lang.String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request. |
javax.servlet.http.Cookie[] |
getCookies()
Returns an array containing all of the Cookie
objects the client sent with this request. |
long |
getDateHeader(java.lang.String name)
Returns the value of the specified request header as a long value that represents a
Date object. |
javax.servlet.DispatcherType |
getDispatcherType()
Gets the dispatcher type of this request. |
ApplicationFilterChain |
getFilterChain()
Get filter chain associated with the request. |
java.lang.String |
getHeader(java.lang.String name)
Returns the value of the specified request header as a String. |
java.util.Enumeration |
getHeaderNames()
Returns an enumeration of all the header names this request contains. |
java.util.Enumeration |
getHeaders(java.lang.String name)
Returns all the values of the specified request header as an Enumeration of String objects. |
javax.servlet.ServletInputStream |
getInputStream()
Retrieves the body of the request as binary data using a ServletInputStream. |
int |
getIntHeader(java.lang.String name)
Returns the value of the specified request header as an int. |
java.lang.String |
getLocalAddr()
Returns the Internet Protocol (IP) address of the interface on which the request was received. |
java.util.Locale |
getLocale()
Returns the preferred Locale that the client will
accept content in, based on the Accept-Language header. |
java.util.Enumeration |
getLocales()
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. |
java.lang.String |
getLocalName()
Returns the host name of the Internet Protocol (IP) interface on which the request was received. |
int |
getLocalPort()
Returns the Internet Protocol (IP) port number of the interface on which the request was received. |
java.lang.String |
getMethod()
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. |
java.lang.String |
getParameter(java.lang.String name)
Returns the value of a request parameter as a String,
or null if the parameter does not exist. |
java.util.Map |
getParameterMap()
Returns a java.util.Map of the parameters of this request. |
java.util.Enumeration |
getParameterNames()
Returns an Enumeration of String
objects containing the names of the parameters contained
in this request. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Returns an array of String objects containing
all of the values the given request parameter has, or
null if the parameter does not exist. |
javax.servlet.http.Part |
getPart(java.lang.String name)
Gets the Part with the given name. |
java.util.Collection<javax.servlet.http.Part> |
getParts()
Gets all the Part components of this request, provided
that it is of type multipart/form-data. |
java.lang.String |
getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. |
java.lang.String |
getPathTranslated()
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. |
java.lang.String |
getProtocol()
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. |
java.lang.String |
getQueryString()
Returns the query string that is contained in the request URL after the path. |
java.io.BufferedReader |
getReader()
Retrieves the body of the request as character data using a BufferedReader. |
java.lang.String |
getRealPath(java.lang.String path)
|
java.lang.String |
getRemoteAddr()
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. |
java.lang.String |
getRemoteHost()
Returns the fully qualified name of the client or the last proxy that sent the request. |
int |
getRemotePort()
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. |
java.lang.String |
getRemoteUser()
Returns the login of the user making this request, if the user has been authenticated, or null if the user
has not been authenticated. |
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
Returns a RequestDispatcher object that acts as a wrapper for
the resource located at the given path. |
java.lang.String |
getRequestedSessionId()
Returns the session ID specified by the client. |
java.lang.String |
getRequestURI()
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. |
java.lang.StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the request. |
java.lang.String |
getScheme()
Returns the name of the scheme used to make this request, for example, http, https, or ftp. |
java.lang.String |
getServerName()
Returns the host name of the server to which the request was sent. |
int |
getServerPort()
Returns the port number to which the request was sent. |
javax.servlet.ServletContext |
getServletContext()
Gets the servlet context to which this ServletRequest was last dispatched. |
java.lang.String |
getServletPath()
Returns the part of this request's URL that calls the servlet. |
javax.servlet.http.HttpSession |
getSession()
Returns the current session associated with this request, or if the request does not have a session, creates one. |
javax.servlet.http.HttpSession |
getSession(boolean create)
Returns the current HttpSession
associated with this request or, if there is no
current session and create is true, returns
a new session. |
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal object containing
the name of the current authenticated user. |
boolean |
isAsyncStarted()
Checks if this request has been put into asynchronous mode. |
boolean |
isAsyncSupported()
Checks if this request supports asynchronous operation. |
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie. |
boolean |
isRequestedSessionIdFromUrl()
|
boolean |
isRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the request URL. |
boolean |
isRequestedSessionIdValid()
Checks whether the requested session ID is still valid. |
boolean |
isSecure()
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. |
boolean |
isUserInRole(java.lang.String role)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". |
void |
login(java.lang.String username,
java.lang.String password)
Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext. |
void |
logout()
Establish null as the value returned when
getUserPrincipal, getRemoteUser,
and getAuthType is called on the request. |
void |
nextFilterChain()
Next filter chain. |
void |
releaseFilterChain()
Release the current filter chain. |
void |
removeAttribute(java.lang.String name)
Removes an attribute from this request. |
void |
setAttribute(java.lang.String name,
java.lang.Object o)
Stores an attribute in this request. |
void |
setCharacterEncoding(java.lang.String env)
Overrides the name of the character encoding used in the body of this request. |
void |
setFilterChain(ApplicationFilterChain filterChain)
Set filter chain associated with the request. |
javax.servlet.AsyncContext |
startAsync()
Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest
and ServletResponse objects. |
javax.servlet.AsyncContext |
startAsync(javax.servlet.ServletRequest servletRequest,
javax.servlet.ServletResponse servletResponse)
Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects. |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected Request request
protected static StringManager sm
| Constructor Detail |
|---|
public RequestFacade(Request request)
request - The request to be wrapped| Method Detail |
|---|
public void clear()
protected java.lang.Object clone()
throws java.lang.CloneNotSupportedException
clone in class java.lang.Objectjava.lang.CloneNotSupportedExceptionpublic java.lang.Object getAttribute(java.lang.String name)
javax.servlet.ServletRequestObject,
or null if no attribute of the given name exists.
Attributes can be set two ways. The servlet container may set
attributes to make available custom information about a request.
For example, for requests made using HTTPS, the attribute
javax.servlet.request.X509Certificate can be used to
retrieve information on the certificate of the client. Attributes
can also be set programatically using
ServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be
embedded into a request before a RequestDispatcher call.
Attribute names should follow the same conventions as package
names. This specification reserves names matching java.*,
javax.*, and sun.*.
getAttribute in interface javax.servlet.ServletRequestname - a String specifying the name of
the attribute
Object containing the value
of the attribute, or null if
the attribute does not existpublic java.util.Enumeration getAttributeNames()
javax.servlet.ServletRequestEnumeration containing the
names of the attributes available to this request.
This method returns an empty Enumeration
if the request has no attributes available to it.
getAttributeNames in interface javax.servlet.ServletRequestEnumeration of strings
containing the names
of the request's attributespublic java.lang.String getCharacterEncoding()
javax.servlet.ServletRequestnull if the request
does not specify a character encoding
getCharacterEncoding in interface javax.servlet.ServletRequestString containing the name of
the character encoding, or null
if the request does not specify a character encoding
public void setCharacterEncoding(java.lang.String env)
throws java.io.UnsupportedEncodingException
javax.servlet.ServletRequest
setCharacterEncoding in interface javax.servlet.ServletRequestenv - String containing the name of
the character encoding.
java.io.UnsupportedEncodingException - if this
ServletRequest is still in a state where a
character encoding may be set, but the specified
encoding is invalidpublic int getContentLength()
javax.servlet.ServletRequest
getContentLength in interface javax.servlet.ServletRequestpublic java.lang.String getContentType()
javax.servlet.ServletRequestnull if the type is not known. For HTTP servlets,
same as the value of the CGI variable CONTENT_TYPE.
getContentType in interface javax.servlet.ServletRequestString containing the name
of the MIME type of
the request, or null if the type is not known
public javax.servlet.ServletInputStream getInputStream()
throws java.io.IOException
javax.servlet.ServletRequestServletInputStream. Either this method or
ServletRequest.getReader() may be called to read the body, not both.
getInputStream in interface javax.servlet.ServletRequestServletInputStream object containing
the body of the request
java.io.IOException - if an input or output exception occurredpublic java.lang.String getParameter(java.lang.String name)
javax.servlet.ServletRequestString,
or null if the parameter does not exist. Request parameters
are extra information sent with the request. For HTTP servlets,
parameters are contained in the query string or posted form data.
You should only use this method when you are sure the
parameter has only one value. If the parameter might have
more than one value, use ServletRequest.getParameterValues(java.lang.String).
If you use this method with a multivalued
parameter, the value returned is equal to the first value
in the array returned by getParameterValues.
If the parameter data was sent in the request body, such as occurs
with an HTTP POST request, then reading the body directly via ServletRequest.getInputStream() or ServletRequest.getReader() can interfere
with the execution of this method.
getParameter in interface javax.servlet.ServletRequestname - a String specifying the
name of the parameter
String representing the
single value of the parameterServletRequest.getParameterValues(java.lang.String)public java.util.Enumeration getParameterNames()
javax.servlet.ServletRequestEnumeration of String
objects containing the names of the parameters contained
in this request. If the request has
no parameters, the method returns an
empty Enumeration.
getParameterNames in interface javax.servlet.ServletRequestEnumeration of String
objects, each String containing
the name of a request parameter; or an
empty Enumeration if the
request has no parameterspublic java.lang.String[] getParameterValues(java.lang.String name)
javax.servlet.ServletRequestString objects containing
all of the values the given request parameter has, or
null if the parameter does not exist.
If the parameter has a single value, the array has a length of 1.
getParameterValues in interface javax.servlet.ServletRequestname - a String containing the name of
the parameter whose value is requested
String objects
containing the parameter's valuesServletRequest.getParameter(java.lang.String)public java.util.Map getParameterMap()
javax.servlet.ServletRequestRequest parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.
getParameterMap in interface javax.servlet.ServletRequestpublic java.lang.String getProtocol()
javax.servlet.ServletRequestSERVER_PROTOCOL.
getProtocol in interface javax.servlet.ServletRequestString containing the protocol
name and version numberpublic java.lang.String getScheme()
javax.servlet.ServletRequesthttp, https, or ftp.
Different schemes have different rules for constructing URLs,
as noted in RFC 1738.
getScheme in interface javax.servlet.ServletRequestString containing the name
of the scheme used to make this requestpublic java.lang.String getServerName()
javax.servlet.ServletRequestHost
header value, if any, or the resolved server name, or the server IP
address.
getServerName in interface javax.servlet.ServletRequestString containing the name
of the serverpublic int getServerPort()
javax.servlet.ServletRequestHost
header value, if any, or the server port where the client connection
was accepted on.
getServerPort in interface javax.servlet.ServletRequest
public java.io.BufferedReader getReader()
throws java.io.IOException
javax.servlet.ServletRequestBufferedReader. The reader translates the character
data according to the character encoding used on the body.
Either this method or ServletRequest.getInputStream() may be called to read the
body, not both.
getReader in interface javax.servlet.ServletRequestBufferedReader
containing the body of the request
java.io.UnsupportedEncodingException - if the character set encoding
used is not supported and the
text cannot be decoded
java.io.IOException - if an input or output exception occurredServletRequest.getInputStream()public java.lang.String getRemoteAddr()
javax.servlet.ServletRequestREMOTE_ADDR.
getRemoteAddr in interface javax.servlet.ServletRequestString containing the
IP address of the client that sent the requestpublic java.lang.String getRemoteHost()
javax.servlet.ServletRequestREMOTE_HOST.
getRemoteHost in interface javax.servlet.ServletRequestString containing the fully
qualified name of the client
public void setAttribute(java.lang.String name,
java.lang.Object o)
javax.servlet.ServletRequestRequestDispatcher.
Attribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as
calling ServletRequest.removeAttribute(java.lang.String).
It is warned that when the request is dispatched from the
servlet resides in a different web application by
RequestDispatcher, the object set by this method
may not be correctly retrieved in the caller servlet.
setAttribute in interface javax.servlet.ServletRequestname - a String specifying
the name of the attributeo - the Object to be storedpublic void removeAttribute(java.lang.String name)
javax.servlet.ServletRequestAttribute names should follow the same conventions as
package names. Names beginning with java.*,
javax.*, and com.sun.*, are
reserved for use by Sun Microsystems.
removeAttribute in interface javax.servlet.ServletRequestname - a String specifying
the name of the attribute to removepublic java.util.Locale getLocale()
javax.servlet.ServletRequestLocale that the client will
accept content in, based on the Accept-Language header.
If the client request doesn't provide an Accept-Language header,
this method returns the default locale for the server.
getLocale in interface javax.servlet.ServletRequestLocale for the clientpublic java.util.Enumeration getLocales()
javax.servlet.ServletRequestEnumeration 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.
If the client request doesn't provide an Accept-Language header,
this method returns an Enumeration containing one
Locale, the default locale for the server.
getLocales in interface javax.servlet.ServletRequestEnumeration of preferred
Locale objects for the clientpublic boolean isSecure()
javax.servlet.ServletRequest
isSecure in interface javax.servlet.ServletRequestpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
javax.servlet.ServletRequestRequestDispatcher object that acts as a wrapper for
the resource located at the given path.
A RequestDispatcher object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend
outside the current servlet context. If the path begins with
a "/" it is interpreted as relative to the current context root.
This method returns null if the servlet container
cannot return a RequestDispatcher.
The difference between this method and ServletContext.getRequestDispatcher(java.lang.String) is that this method can take a
relative path.
getRequestDispatcher in interface javax.servlet.ServletRequestpath - a String specifying the pathname
to the resource. If it is relative, it must be
relative against the current servlet.
RequestDispatcher object
that acts as a wrapper for the resource
at the specified path, or null
if the servlet container cannot return a
RequestDispatcherRequestDispatcher,
ServletContext.getRequestDispatcher(java.lang.String)public java.lang.String getRealPath(java.lang.String path)
getRealPath in interface javax.servlet.ServletRequestpublic java.lang.String getAuthType()
javax.servlet.http.HttpServletRequestnull is returned.
Same as the value of the CGI variable AUTH_TYPE.
getAuthType in interface javax.servlet.http.HttpServletRequestnull if the request was
not authenticated.public javax.servlet.http.Cookie[] getCookies()
javax.servlet.http.HttpServletRequestCookie
objects the client sent with this request.
This method returns null if no cookies were sent.
getCookies in interface javax.servlet.http.HttpServletRequestCookies
included with this request, or null
if the request has no cookiespublic long getDateHeader(java.lang.String name)
javax.servlet.http.HttpServletRequestlong value that represents a
Date object. Use this method with
headers that contain dates, such as
If-Modified-Since.
The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
If the request did not have a header of the
specified name, this method returns -1. If the header
can't be converted to a date, the method throws
an IllegalArgumentException.
getDateHeader in interface javax.servlet.http.HttpServletRequestname - a String specifying the
name of the header
long value
representing the date specified
in the header expressed as
the number of milliseconds
since January 1, 1970 GMT,
or -1 if the named header
was not included with the
requestpublic java.lang.String getHeader(java.lang.String name)
javax.servlet.http.HttpServletRequestString. If the request did not include a header
of the specified name, this method returns null.
If there are multiple headers with the same name, this method
returns the first head in the request.
The header name is case insensitive. You can use
this method with any request header.
getHeader in interface javax.servlet.http.HttpServletRequestname - a String specifying the
header name
String containing the
value of the requested
header, or null
if the request does not
have a header of that namepublic java.util.Enumeration getHeaders(java.lang.String name)
javax.servlet.http.HttpServletRequestEnumeration of String objects.
Some headers, such as Accept-Language can be sent
by clients as several headers each with a different value rather than
sending the header as a comma separated list.
If the request did not include any headers
of the specified name, this method returns an empty
Enumeration.
The header name is case insensitive. You can use
this method with any request header.
getHeaders in interface javax.servlet.http.HttpServletRequestname - a String specifying the
header name
Enumeration containing
the values of the requested header. If
the request does not have any headers of
that name return an empty
enumeration. If
the container does not allow access to
header information, return nullpublic java.util.Enumeration getHeaderNames()
javax.servlet.http.HttpServletRequestSome servlet containers do not allow
servlets to access headers using this method, in
which case this method returns null
getHeaderNames in interface javax.servlet.http.HttpServletRequestnullpublic int getIntHeader(java.lang.String name)
javax.servlet.http.HttpServletRequestint. If the request does not have a header
of the specified name, this method returns -1. If the
header cannot be converted to an integer, this method
throws a NumberFormatException.
The header name is case insensitive.
getIntHeader in interface javax.servlet.http.HttpServletRequestname - a String specifying the name
of a request header
public java.lang.String getMethod()
javax.servlet.http.HttpServletRequest
getMethod in interface javax.servlet.http.HttpServletRequestString
specifying the name
of the method with which
this request was madepublic java.lang.String getPathInfo()
javax.servlet.http.HttpServletRequestThis method returns null if there
was no extra path information.
Same as the value of the CGI variable PATH_INFO.
getPathInfo in interface javax.servlet.http.HttpServletRequestString, decoded by the
web container, specifying
extra path information that comes
after the servlet path but before
the query string in the request URL;
or null if the URL does not have
any extra path informationpublic java.lang.String getPathTranslated()
javax.servlet.http.HttpServletRequestIf the URL does not have any extra path information,
this method returns null or the servlet container
cannot translate the virtual path to a real path for any reason
(such as when the web application is executed from an archive).
The web container does not decode this string.
getPathTranslated in interface javax.servlet.http.HttpServletRequestString specifying the
real path, or null if
the URL does not have any extra path
informationpublic java.lang.String getContextPath()
javax.servlet.http.HttpServletRequestIt is possible that a servlet container may match a context by
more than one context path. In such cases this method will return the
actual context path used by the request and it may differ from the
path returned by the
ServletContext.getContextPath() method.
The context path returned by
ServletContext.getContextPath()
should be considered as the prime or preferred context path of the
application.
getContextPath in interface javax.servlet.http.HttpServletRequestString specifying the
portion of the request URI that indicates the context
of the requestServletContext.getContextPath()public java.lang.String getQueryString()
javax.servlet.http.HttpServletRequestnull
if the URL does not have a query string. Same as the value
of the CGI variable QUERY_STRING.
getQueryString in interface javax.servlet.http.HttpServletRequestString containing the query
string or null if the URL
contains no query string. The value is not
decoded by the container.public java.lang.String getRemoteUser()
javax.servlet.http.HttpServletRequestnull if the user
has not been authenticated.
Whether the user name is sent with each subsequent request
depends on the browser and type of authentication. Same as the
value of the CGI variable REMOTE_USER.
getRemoteUser in interface javax.servlet.http.HttpServletRequestString specifying the login
of the user making this request, or null
if the user login is not knownpublic boolean isUserInRole(java.lang.String role)
javax.servlet.http.HttpServletRequestfalse.
isUserInRole in interface javax.servlet.http.HttpServletRequestrole - a String specifying the name
of the role
boolean indicating whether
the user making this request belongs to a given role;
false if the user has not been
authenticatedpublic java.security.Principal getUserPrincipal()
javax.servlet.http.HttpServletRequestjava.security.Principal object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null.
getUserPrincipal in interface javax.servlet.http.HttpServletRequestjava.security.Principal containing
the name of the user making this request;
null if the user has not been
authenticatedpublic java.lang.String getRequestedSessionId()
javax.servlet.http.HttpServletRequestnull.
getRequestedSessionId in interface javax.servlet.http.HttpServletRequestString specifying the session
ID, or null if the request did
not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public java.lang.String getRequestURI()
javax.servlet.http.HttpServletRequest| First line of HTTP request | Returned Value | |
|---|---|---|
| POST /some/path.html HTTP/1.1 | /some/path.html | |
| GET http://foo.bar/a.html HTTP/1.0 | /a.html | |
| HEAD /xyz?a=b HTTP/1.1 | /xyz |
To reconstruct an URL with a scheme and host, use
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest).
getRequestURI in interface javax.servlet.http.HttpServletRequestString containing
the part of the URL from the
protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)public java.lang.StringBuffer getRequestURL()
javax.servlet.http.HttpServletRequestIf this request has been forwarded using
RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), the server path in the
reconstructed URL must reflect the path used to obtain the
RequestDispatcher, and not the server path specified by the client.
Because this method returns a StringBuffer,
not a string, you can modify the URL easily, for example,
to append query parameters.
This method is useful for creating redirect messages and for reporting errors.
getRequestURL in interface javax.servlet.http.HttpServletRequestStringBuffer object containing
the reconstructed URLpublic java.lang.String getServletPath()
javax.servlet.http.HttpServletRequestThis method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
getServletPath in interface javax.servlet.http.HttpServletRequestString containing
the name or path of the servlet being
called, as specified in the request URL,
decoded, or an empty string if the servlet
used to process the request is matched
using the "/*" pattern.public javax.servlet.http.HttpSession getSession(boolean create)
javax.servlet.http.HttpServletRequestHttpSession
associated with this request or, if there is no
current session and create is true, returns
a new session.
If create is false
and the request has no valid HttpSession,
this method returns null.
To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
getSession in interface javax.servlet.http.HttpServletRequestcreate - true to create
a new session for this request if necessary;
false to return null
if there's no current session
HttpSession associated
with this request or null if
create is false
and the request has no valid sessionHttpServletRequest.getSession()public javax.servlet.http.HttpSession getSession()
javax.servlet.http.HttpServletRequest
getSession in interface javax.servlet.http.HttpServletRequestHttpSession associated
with this requestHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdValid()
javax.servlet.http.HttpServletRequestIf the client did not specify any session ID, this method returns
false.
isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequesttrue if this
request has an id for a valid session
in the current session context;
false otherwiseHttpServletRequest.getRequestedSessionId(),
HttpServletRequest.getSession(boolean),
HttpSessionContextpublic boolean isRequestedSessionIdFromCookie()
javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequesttrue if the session ID
came in as a
cookie; otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequesttrue if the session ID
came in as part of a URL; otherwise,
falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequestpublic java.lang.String getLocalAddr()
javax.servlet.ServletRequest
getLocalAddr in interface javax.servlet.ServletRequestString containing the
IP address on which the request was received.public java.lang.String getLocalName()
javax.servlet.ServletRequest
getLocalName in interface javax.servlet.ServletRequestString containing the host
name of the IP on which the request was received.public int getLocalPort()
javax.servlet.ServletRequest
getLocalPort in interface javax.servlet.ServletRequestpublic int getRemotePort()
javax.servlet.ServletRequest
getRemotePort in interface javax.servlet.ServletRequestpublic javax.servlet.AsyncContext getAsyncContext()
javax.servlet.ServletRequestServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on this request.
getAsyncContext in interface javax.servlet.ServletRequestServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on
this requestpublic javax.servlet.ServletContext getServletContext()
javax.servlet.ServletRequest
getServletContext in interface javax.servlet.ServletRequestpublic boolean isAsyncStarted()
javax.servlet.ServletRequestA ServletRequest is put into asynchronous mode by calling
ServletRequest.startAsync() or
ServletRequest.startAsync(ServletRequest,ServletResponse) on it.
This method returns false if this request was
put into asynchronous mode, but has since been dispatched using
one of the AsyncContext.dispatch() methods or released
from asynchronous mode via a call to AsyncContext.complete().
isAsyncStarted in interface javax.servlet.ServletRequestpublic boolean isAsyncSupported()
javax.servlet.ServletRequestAsynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.
isAsyncSupported in interface javax.servlet.ServletRequest
public javax.servlet.AsyncContext startAsync()
throws java.lang.IllegalStateException
javax.servlet.ServletRequestAsyncContext with the original (unwrapped) ServletRequest
and ServletResponse objects.
Calling this method will cause committal of the associated
response to be delayed until AsyncContext.complete() is
called on the returned AsyncContext, or the asynchronous
operation has timed out.
Calling AsyncContext.hasOriginalRequestAndResponse() on
the returned AsyncContext will return true. Any filters
invoked in the outbound direction after this request was put
into asynchronous mode may use this as an indication that any request
and/or response wrappers that they added during their inbound
invocation need not stay around for the duration of the asynchronous
operation, and therefore any of their associated resources may be
released.
This method clears the list of AsyncListener instances
(if any) that were registered with the AsyncContext returned by the
previous call to one of the startAsync methods, after calling each
AsyncListener at its onStartAsync
method.
Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.
startAsync in interface javax.servlet.ServletRequestjava.lang.IllegalStateException - if this request is within the scope of
a filter or servlet that does not support asynchronous operations
(that is, ServletRequest.isAsyncSupported() returns false),
or if this method is called again without any asynchronous dispatch
(resulting from one of the AsyncContext.dispatch() methods),
is called outside the scope of any such dispatch, or is called again
within the scope of the same dispatch, or if the response has
already been closed
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
javax.servlet.ServletResponse servletResponse)
throws java.lang.IllegalStateException
javax.servlet.ServletRequestAsyncContext with the given request and response objects.
The ServletRequest and ServletResponse arguments must be
the same instances, or instances of ServletRequestWrapper and
ServletResponseWrapper that wrap them, that were passed to the
service method of the Servlet or the
doFilter method of the Filter, respectively,
in whose scope this method is being called.
Calling this method will cause committal of the associated
response to be delayed until AsyncContext.complete() is
called on the returned AsyncContext, or the asynchronous
operation has timed out.
Calling AsyncContext.hasOriginalRequestAndResponse() on
the returned AsyncContext will return false,
unless the passed in ServletRequest and ServletResponse arguments
are the original ones or do not carry any application-provided wrappers.
Any filters invoked in the outbound direction after this
request was put into asynchronous mode may use this as an indication
that some of the request and/or response wrappers that they added
during their inbound invocation may need to stay in place for
the duration of the asynchronous operation, and their associated
resources may not be released.
A ServletRequestWrapper applied during the inbound
invocation of a filter may be released by the outbound
invocation of the filter only if the given servletRequest,
which is used to initialize the AsyncContext and will be returned by
a call to AsyncContext.getRequest(), does not contain said
ServletRequestWrapper. The same holds true for ServletResponseWrapper
instances.
This method clears the list of AsyncListener instances
(if any) that were registered with the AsyncContext returned by the
previous call to one of the startAsync methods, after calling each
AsyncListener at its onStartAsync
method.
Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext.
startAsync in interface javax.servlet.ServletRequestservletRequest - the ServletRequest used to initialize the
AsyncContextservletResponse - the ServletResponse used to initialize the
AsyncContext
java.lang.IllegalStateException - if this request is within the scope of
a filter or servlet that does not support asynchronous operations
(that is, ServletRequest.isAsyncSupported() returns false),
or if this method is called again without any asynchronous dispatch
(resulting from one of the AsyncContext.dispatch() methods),
is called outside the scope of any such dispatch, or is called again
within the scope of the same dispatch, or if the response has
already been closedpublic javax.servlet.DispatcherType getDispatcherType()
javax.servlet.ServletRequestThe dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied.
Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.
The initial dispatcher type of a request is defined as
DispatcherType.REQUEST. The dispatcher type of a request
dispatched via RequestDispatcher.forward(ServletRequest,
ServletResponse) or RequestDispatcher.include(ServletRequest,
ServletResponse) is given as DispatcherType.FORWARD or
DispatcherType.INCLUDE, respectively, while the
dispatcher type of an asynchronous request dispatched via
one of the AsyncContext.dispatch() methods is given as
DispatcherType.ASYNC. Finally, the dispatcher type of a
request dispatched to an error page by the container's error handling
mechanism is given as DispatcherType.ERROR.
getDispatcherType in interface javax.servlet.ServletRequestDispatcherTypepublic ApplicationFilterChain getFilterChain()
public void setFilterChain(ApplicationFilterChain filterChain)
filterChain - new filter chainpublic void nextFilterChain()
public void releaseFilterChain()
public boolean authenticate(javax.servlet.http.HttpServletResponse response)
throws java.io.IOException,
javax.servlet.ServletException
javax.servlet.http.HttpServletRequestServletContext to authenticate the user making
this request.
This method may modify and commit the argument
HttpServletResponse.
authenticate in interface javax.servlet.http.HttpServletRequestresponse - The HttpServletResponse
associated with this HttpServletRequest
true when non-null values were or have been
established as the values returned by getUserPrincipal,
getRemoteUser, and getAuthType. Return
false if authentication is incomplete and the underlying
login mechanism has committed, in the response, the message (e.g.,
challenge) and HTTP status code to be returned to the user.
java.io.IOException - if an input or output error occurred while
reading from this request or writing to the given response
javax.servlet.ServletException - if the authentication failed and
the caller is responsible for handling the error (i.e., the
underlying login mechanism did NOT establish the message and
HTTP status code to be returned to the user)
public void login(java.lang.String username,
java.lang.String password)
throws javax.servlet.ServletException
javax.servlet.http.HttpServletRequestServletContext.
This method returns without throwing a ServletException
when the login mechanism configured for the ServletContext
supports username password validation, and when, at the time of the
call to login, the identity of the caller of the request had
not been established (i.e, all of getUserPrincipal,
getRemoteUser, and getAuthType return null),
and when validation of the provided credentials is successful.
Otherwise, this method throws a ServletException as
described below.
When this method returns without throwing an exception, it must
have established non-null values as the values returned by
getUserPrincipal, getRemoteUser, and
getAuthType.
login in interface javax.servlet.http.HttpServletRequestusername - The String value corresponding to
the login identifier of the user.password - The password String corresponding
to the identified user.
javax.servlet.ServletException - if the configured login mechanism
does not support username
password authentication, or if a
non-null caller identity had
already been established (prior
to the call to login), or if
validation of the provided
username and password fails.
public void logout()
throws javax.servlet.ServletException
javax.servlet.http.HttpServletRequestnull as the value returned when
getUserPrincipal, getRemoteUser,
and getAuthType is called on the request.
logout in interface javax.servlet.http.HttpServletRequestjavax.servlet.ServletException - if logout fails
public javax.servlet.http.Part getPart(java.lang.String name)
throws java.io.IOException,
javax.servlet.ServletException
javax.servlet.http.HttpServletRequestPart with the given name.
getPart in interface javax.servlet.http.HttpServletRequestname - the name of the requested Part
java.io.IOException - if an I/O error occurred during the retrieval
of the requested Part
javax.servlet.ServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()
public java.util.Collection<javax.servlet.http.Part> getParts()
throws java.io.IOException,
javax.servlet.ServletException
javax.servlet.http.HttpServletRequestPart components of this request, provided
that it is of type multipart/form-data.
If this request is of type multipart/form-data, but does not contain any Part components, the returned Collection will be empty.
Any changes to the returned Collection must not
affect this HttpServletRequest.
getParts in interface javax.servlet.http.HttpServletRequestCollection of the
Part components of this request
java.io.IOException - if an I/O error occurred during the retrieval
of the Part components of this request
javax.servlet.ServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||