|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.catalina.core.DummyRequest
public class DummyRequest
Dummy request object, used for request dispatcher mapping, as well as JSP precompilation.
| Field Summary | |
|---|---|
protected java.lang.String |
contextPath
|
protected java.lang.String |
decodedURI
|
protected javax.servlet.FilterChain |
filterChain
|
protected java.lang.String |
pathInfo
|
protected java.lang.String |
queryString
|
protected java.lang.String |
servletPath
|
protected Wrapper |
wrapper
|
| Fields inherited from interface javax.servlet.http.HttpServletRequest |
|---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
| Constructor Summary | |
|---|---|
DummyRequest()
|
|
DummyRequest(java.lang.String contextPath,
java.lang.String decodedURI,
java.lang.String queryString)
|
|
| Method Summary | |
|---|---|
void |
addCookie(javax.servlet.http.Cookie cookie)
|
void |
addHeader(java.lang.String name,
java.lang.String value)
|
void |
addLocale(java.util.Locale locale)
|
void |
addParameter(java.lang.String name,
java.lang.String[] values)
|
void |
clearCookies()
|
void |
clearHeaders()
|
void |
clearLocales()
|
void |
clearParameters()
|
javax.servlet.ServletInputStream |
createInputStream()
|
void |
finishRequest()
|
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 |
getAuthorization()
|
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. |
Connector |
getConnector()
|
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. |
Context |
getContext()
|
java.lang.String |
getContextPath()
Returns the portion of the request URI that indicates the context of the request. |
MessageBytes |
getContextPathMB()
|
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. |
java.lang.String |
getDecodedRequestURI()
|
MessageBytes |
getDecodedRequestURIMB()
|
javax.servlet.FilterChain |
getFilterChain()
|
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. |
Host |
getHost()
|
java.lang.String |
getInfo()
|
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.Object |
getNote(java.lang.String name)
|
java.util.Iterator |
getNoteNames()
|
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. |
java.lang.String |
getPathInfo()
Returns any extra path information associated with the URL the client sent when it made this request. |
MessageBytes |
getPathInfoMB()
|
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.ServletRequest |
getRequest()
|
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. |
MessageBytes |
getRequestPathMB()
|
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. |
Response |
getResponse()
|
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. |
java.lang.String |
getServletPath()
Returns the part of this request's URL that calls the servlet. |
MessageBytes |
getServletPathMB()
|
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.net.Socket |
getSocket()
|
java.io.InputStream |
getStream()
|
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal object containing
the name of the current authenticated user. |
Wrapper |
getWrapper()
|
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 |
recycle()
|
void |
removeAttribute(java.lang.String name)
Removes an attribute from this request. |
void |
removeNote(java.lang.String name)
|
void |
setAttribute(java.lang.String name,
java.lang.Object value)
Stores an attribute in this request. |
void |
setAuthorization(java.lang.String authorization)
|
void |
setAuthType(java.lang.String authType)
|
void |
setCharacterEncoding(java.lang.String enc)
Overrides the name of the character encoding used in the body of this request. |
void |
setConnector(Connector connector)
|
void |
setContentLength(int length)
|
void |
setContentType(java.lang.String type)
|
void |
setContext(Context context)
|
void |
setContextPath(java.lang.String path)
|
void |
setDecodedRequestURI(java.lang.String uri)
|
void |
setFilterChain(javax.servlet.FilterChain filterChain)
|
void |
setHost(Host host)
|
void |
setMethod(java.lang.String method)
|
void |
setNote(java.lang.String name,
java.lang.Object value)
|
void |
setPathInfo(java.lang.String path)
|
void |
setProtocol(java.lang.String protocol)
|
void |
setQueryString(java.lang.String query)
|
void |
setRemoteAddr(java.lang.String remoteAddr)
|
void |
setRemoteHost(java.lang.String remoteHost)
|
void |
setRequestedSessionCookie(boolean flag)
|
void |
setRequestedSessionId(java.lang.String id)
|
void |
setRequestedSessionURL(boolean flag)
|
void |
setRequestURI(java.lang.String uri)
|
void |
setResponse(Response response)
|
void |
setScheme(java.lang.String scheme)
|
void |
setSecure(boolean secure)
|
void |
setServerName(java.lang.String name)
|
void |
setServerPort(int port)
|
void |
setServletPath(java.lang.String path)
|
void |
setSocket(java.net.Socket socket)
|
void |
setStream(java.io.InputStream input)
|
void |
setUserPrincipal(java.security.Principal principal)
|
void |
setWrapper(Wrapper wrapper)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.lang.String contextPath
protected java.lang.String decodedURI
protected java.lang.String queryString
protected java.lang.String pathInfo
protected java.lang.String servletPath
protected Wrapper wrapper
protected javax.servlet.FilterChain filterChain
| Constructor Detail |
|---|
public DummyRequest()
public DummyRequest(java.lang.String contextPath,
java.lang.String decodedURI,
java.lang.String queryString)
| Method Detail |
|---|
public java.lang.String getContextPath()
javax.servlet.http.HttpServletRequest
getContextPath in interface javax.servlet.http.HttpServletRequestString specifying the
portion of the request URI that indicates the context
of the requestpublic MessageBytes getContextPathMB()
public javax.servlet.ServletRequest getRequest()
public java.lang.String getDecodedRequestURI()
public MessageBytes getDecodedRequestURIMB()
public javax.servlet.FilterChain getFilterChain()
public void setFilterChain(javax.servlet.FilterChain filterChain)
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 void setQueryString(java.lang.String query)
public 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 void setPathInfo(java.lang.String path)
public MessageBytes getPathInfoMB()
public MessageBytes getRequestPathMB()
public 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 void setServletPath(java.lang.String path)
public MessageBytes getServletPathMB()
public Wrapper getWrapper()
public void setWrapper(Wrapper wrapper)
public java.lang.String getAuthorization()
public void setAuthorization(java.lang.String authorization)
public Connector getConnector()
public void setConnector(Connector connector)
public Context getContext()
public void setContext(Context context)
public Host getHost()
public void setHost(Host host)
public java.lang.String getInfo()
public Response getResponse()
public void setResponse(Response response)
public java.net.Socket getSocket()
public void setSocket(java.net.Socket socket)
public java.io.InputStream getStream()
public void setStream(java.io.InputStream input)
public void addLocale(java.util.Locale locale)
public javax.servlet.ServletInputStream createInputStream()
throws java.io.IOException
java.io.IOException
public void finishRequest()
throws java.io.IOException
java.io.IOExceptionpublic java.lang.Object getNote(java.lang.String name)
public java.util.Iterator getNoteNames()
public void removeNote(java.lang.String name)
public void setContentType(java.lang.String type)
public void setNote(java.lang.String name,
java.lang.Object value)
public void setProtocol(java.lang.String protocol)
public void setRemoteAddr(java.lang.String remoteAddr)
public void setRemoteHost(java.lang.String remoteHost)
public void setScheme(java.lang.String scheme)
public void setServerName(java.lang.String name)
public void setServerPort(int port)
public 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 encodingpublic int getContentLength()
javax.servlet.ServletRequest
getContentLength in interface javax.servlet.ServletRequestpublic void setContentLength(int length)
public 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.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 java.lang.String getProtocol()
javax.servlet.ServletRequestSERVER_PROTOCOL.
getProtocol in interface javax.servlet.ServletRequestString containing the protocol
name and version number
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.IOException - if an input or output exception occurredServletRequest.getInputStream()public java.lang.String getRealPath(java.lang.String path)
getRealPath in interface javax.servlet.ServletRequestpublic 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 clientpublic 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.ServletRequestpublic boolean isSecure()
javax.servlet.ServletRequest
isSecure in interface javax.servlet.ServletRequestpublic 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 remove
public void setAttribute(java.lang.String name,
java.lang.Object value)
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 attributevalue - the Object to be stored
public void setCharacterEncoding(java.lang.String enc)
throws java.io.UnsupportedEncodingException
javax.servlet.ServletRequest
setCharacterEncoding in interface javax.servlet.ServletRequestenc - a String containing the name of
the character encoding.
java.io.UnsupportedEncodingException - if this is not a valid encodingpublic void addCookie(javax.servlet.http.Cookie cookie)
public void addHeader(java.lang.String name,
java.lang.String value)
public void addParameter(java.lang.String name,
java.lang.String[] values)
public void clearCookies()
public void clearHeaders()
public void clearLocales()
public void clearParameters()
public void recycle()
public void setAuthType(java.lang.String authType)
public void setContextPath(java.lang.String path)
public void setMethod(java.lang.String method)
public void setRequestedSessionCookie(boolean flag)
public void setRequestedSessionId(java.lang.String id)
public void setRequestedSessionURL(boolean flag)
public void setRequestURI(java.lang.String uri)
public void setSecure(boolean secure)
public void setUserPrincipal(java.security.Principal principal)
public 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.Map getParameterMap()
javax.servlet.ServletRequest
getParameterMap in interface javax.servlet.ServletRequestpublic 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 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 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 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 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 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
HttpServletRequest.getRequestURL().
getRequestURI in interface javax.servlet.http.HttpServletRequestString containing
the part of the URL from the
protocol name up to the query stringpublic void setDecodedRequestURI(java.lang.String uri)
public java.lang.StringBuffer getRequestURL()
javax.servlet.http.HttpServletRequestBecause 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 javax.servlet.http.HttpSession getSession()
javax.servlet.http.HttpServletRequest
getSession in interface javax.servlet.http.HttpServletRequestHttpSession associated
with this requestHttpServletRequest.getSession(boolean)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 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 boolean isRequestedSessionIdValid()
javax.servlet.http.HttpServletRequest
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 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 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.ServletRequest
|
Apache Tomcat 6.0.45 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||