public class FiberHttpServletRequest extends FiberServletRequest implements HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH| Constructor and Description |
|---|
FiberHttpServletRequest(FiberHttpServlet servlet,
HttpServletRequest req) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
authenticate(HttpServletResponse response)
Use the container login mechanism configured for the
ServletContext to authenticate the user making
this request. |
String |
getAuthType()
Returns the name of the authentication scheme used to protect
the servlet.
|
String |
getContextPath()
Returns the portion of the request URI that indicates the context
of the request.
|
Cookie[] |
getCookies()
Returns an array containing all of the
Cookie
objects the client sent with this request. |
long |
getDateHeader(String name)
Returns the value of the specified request header
as a
long value that represents a
Date object. |
String |
getHeader(String name)
Returns the value of the specified request header
as a
String. |
Enumeration<String> |
getHeaderNames()
Returns an enumeration of all the header names
this request contains.
|
Enumeration<String> |
getHeaders(String name)
Returns all the values of the specified request header
as an
Enumeration of String objects. |
int |
getIntHeader(String name)
Returns the value of the specified request header
as an
int. |
String |
getMethod()
Returns the name of the HTTP method with which this
request was made, for example, GET, POST, or PUT.
|
Part |
getPart(String name)
Gets the
Part with the given name. |
Collection<Part> |
getParts()
Gets all the
Part components of this request, provided
that it is of type multipart/form-data. |
String |
getPathInfo()
Returns any extra path information associated with
the URL the client sent when it made this request.
|
String |
getPathTranslated()
Returns any extra path information after the servlet name
but before the query string, and translates it to a real
path.
|
String |
getQueryString()
Returns the query string that is contained in the request
URL after the path.
|
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. |
String |
getRequestedSessionId()
Returns the session ID specified by the client.
|
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.
|
StringBuffer |
getRequestURL()
Reconstructs the URL the client used to make the request.
|
String |
getServletPath()
Returns the part of this request's URL that calls
the servlet.
|
HttpSession |
getSession()
Returns the current session associated with this request,
or if the request does not have a session, creates one.
|
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. |
Principal |
getUserPrincipal()
Returns a
java.security.Principal object containing
the name of the current authenticated user. |
boolean |
isRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie.
|
boolean |
isRequestedSessionIdFromUrl()
Deprecated.
|
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 |
isUserInRole(String role)
Returns a boolean indicating whether the authenticated user is included
in the specified logical "role".
|
void |
login(String username,
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. |
equals, getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, hashCode, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsyncpublic FiberHttpServletRequest(FiberHttpServlet servlet, HttpServletRequest req)
public String getAuthType()
javax.servlet.http.HttpServletRequestnull is returned.
Same as the value of the CGI variable AUTH_TYPE.
getAuthType in interface HttpServletRequestnull if the request was
not authenticated.public 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 HttpServletRequestCookies
included with this request, or null
if the request has no cookiespublic long getDateHeader(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 HttpServletRequestname - a String specifying the
name of the headerlong 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 String getHeader(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 HttpServletRequestname - a String specifying the
header nameString containing the
value of the requested
header, or null
if the request does not
have a header of that namepublic Enumeration<String> getHeaders(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 HttpServletRequestname - a String specifying the
header nameEnumeration 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 Enumeration<String> 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 HttpServletRequestnullpublic int getIntHeader(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 HttpServletRequestname - a String specifying the name
of a request headerpublic String getMethod()
javax.servlet.http.HttpServletRequestgetMethod in interface HttpServletRequestString
specifying the name
of the method with which
this request was madepublic 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 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 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 HttpServletRequestString specifying the
real path, or null if
the URL does not have any extra path
informationpublic 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 HttpServletRequestString specifying the
portion of the request URI that indicates the context
of the requestServletContext.getContextPath()public 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 HttpServletRequestString containing the query
string or null if the URL
contains no query string. The value is not
decoded by the container.public 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 HttpServletRequestString specifying the login
of the user making this request, or null
if the user login is not knownpublic boolean isUserInRole(String role)
javax.servlet.http.HttpServletRequestfalse.isUserInRole in interface HttpServletRequestrole - a String specifying the name
of the roleboolean indicating whether
the user making this request belongs to a given role;
false if the user has not been
authenticatedpublic 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 HttpServletRequestjava.security.Principal containing
the name of the user making this request;
null if the user has not been
authenticatedpublic String getRequestedSessionId()
javax.servlet.http.HttpServletRequestnull.getRequestedSessionId in interface HttpServletRequestString specifying the session
ID, or null if the request did
not specify a session IDHttpServletRequest.isRequestedSessionIdValid()public 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 HttpServletRequestString containing
the part of the URL from the
protocol name up to the query stringHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)public 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 HttpServletRequestStringBuffer object containing
the reconstructed URLpublic 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 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 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 HttpServletRequestcreate - true to create
a new session for this request if necessary;
false to return null
if there's no current sessionHttpSession associated
with this request or null if
create is false
and the request has no valid sessionHttpServletRequest.getSession()public HttpSession getSession()
javax.servlet.http.HttpServletRequestgetSession in interface 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 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.HttpServletRequestisRequestedSessionIdFromCookie in interface HttpServletRequesttrue if the session ID
came in as a
cookie; otherwise, falseHttpServletRequest.getSession(boolean)public boolean isRequestedSessionIdFromURL()
javax.servlet.http.HttpServletRequestisRequestedSessionIdFromURL in interface HttpServletRequesttrue if the session ID
came in as part of a URL; otherwise,
falseHttpServletRequest.getSession(boolean)@Deprecated public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl in interface HttpServletRequestpublic boolean authenticate(HttpServletResponse response) throws IOException, ServletException
javax.servlet.http.HttpServletRequestServletContext to authenticate the user making
this request.
This method may modify and commit the argument
HttpServletResponse.
authenticate in interface HttpServletRequestresponse - The HttpServletResponse
associated with this HttpServletRequesttrue 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.IOException - if an input or output error occurred while
reading from this request or writing to the given responseServletException - 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(String username, String password) throws 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 HttpServletRequestusername - The String value corresponding to
the login identifier of the user.password - The password String corresponding
to the identified user.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 ServletException
javax.servlet.http.HttpServletRequestnull as the value returned when
getUserPrincipal, getRemoteUser,
and getAuthType is called on the request.logout in interface HttpServletRequestServletException - if logout failspublic Collection<Part> getParts() throws IOException, 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 HttpServletRequestCollection of the
Part components of this requestIOException - if an I/O error occurred during the retrieval
of the Part components of this requestServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()public Part getPart(String name) throws IOException, ServletException
javax.servlet.http.HttpServletRequestPart with the given name.getPart in interface HttpServletRequestname - the name of the requested PartIOException - if an I/O error occurred during the retrieval
of the requested PartServletException - if this request is not of type
multipart/form-dataMultipartConfig.maxFileSize(),
MultipartConfig.maxRequestSize()