| javax.servlet.ServletRequest
All known Subclasses: javax.servlet.ServletRequestWrapper,
| ServletRequest | | public interface ServletRequest (Code) | | ServletRequest encapsulates client request data. See HttpServletRequest
for HTTP-specific information.
Requests have user-defined attributes. Servlets can communicate
to included or forwarded pages using the request attributes. For example,
a servlet may calculate results and place them in the request attributes.
It may then forward the call to a JSP template to format the result.
Form parameters are retrieved using getParameter
|
| Method Summary | |
| public Object | getAttribute(String name)
Returns an attribute value. | | public Enumeration | getAttributeNames()
Enumerates all attribute names in the request. | | public String | getCharacterEncoding()
Returns the character encoding of the POSTed data. | | public int | getContentLength()
Returns the content length of the data. | | public String | getContentType()
Returns the request's mime-type. | | public ServletInputStream | getInputStream()
Returns an InputStream to retrieve POST data from the request. | | public String | getLocalAddr()
This call returns the ip of the host actually used to connect to the Resin
server, which means that if ipchains, load balancing, or proxying is
involved this call does not return the correct host for
forming urls. | | public String | getLocalName()
Returns the IP address of the local host, i.e. | | public int | getLocalPort()
Returns the port of the local host. | | public Locale | getLocale()
Returns the request's preferred locale, based on the Accept-Language
header. | | public Enumeration | getLocales()
Returns an enumeration of all locales acceptable by the client. | | public String | getParameter(String name)
Returns a form parameter. | | public Map | getParameterMap()
Returns a Map of the form parameters. | | public Enumeration | getParameterNames()
Returns an enumeration of all form parameter names. | | public String[] | getParameterValues(String name)
Returns all values of a form parameter. | | public String | getProtocol()
Returns the prococol, e.g. | | public BufferedReader | getReader()
Returns a reader to read POSTed data. | | public String | getRealPath(String uri)
Returns the path of the URI. | | public String | getRemoteAddr()
Returns the IP address of the remote host, i.e. | | public String | getRemoteHost()
Returns the DNS hostname of the remote host, i.e. | | public int | getRemotePort()
Returns the port of the remote host, i.e. | | public RequestDispatcher | getRequestDispatcher(String uri)
Returns a request dispatcher for later inclusion or forwarding. | | public String | getScheme()
Returns the request scheme, e.g. | | public String | getServerName()
Returns the server name handling the request. | | public int | getServerPort()
Returns the server port used by the client, e.g. | | public boolean | isSecure()
Returns true if the connection is secure, e.g. | | public void | removeAttribute(String name)
Removes the given attribute. | | public void | setAttribute(String name, Object o)
Sets an attribute value. | | public void | setCharacterEncoding(String encoding)
Overrides the character encoding specified in the request. |
| getAttribute | | public Object getAttribute(String name)(Code) | | Returns an attribute value.
Parameters:
name - the attribute name the attribute value |
| getAttributeNames | | public Enumeration getAttributeNames()(Code) | | Enumerates all attribute names in the request.
|
| getCharacterEncoding | | public String getCharacterEncoding()(Code) | | Returns the character encoding of the POSTed data.
|
| getContentLength | | public int getContentLength()(Code) | | Returns the content length of the data. This value may differ from
the actual length of the data. Newer browsers
supporting HTTP/1.1 may use "chunked" encoding which does
not make the content length available.
The upshot is, rely on the input stream to end when the data
completes.
|
| getContentType | | public String getContentType()(Code) | | Returns the request's mime-type.
|
| getInputStream | | public ServletInputStream getInputStream() throws IOException(Code) | | Returns an InputStream to retrieve POST data from the request.
The stream will automatically end when the end of the POST data
is complete.
|
| getLocalAddr | | public String getLocalAddr()(Code) | | This call returns the ip of the host actually used to connect to the Resin
server, which means that if ipchains, load balancing, or proxying is
involved this call does not return the correct host for
forming urls.
since:
2.4 |
| getLocalName | | public String getLocalName()(Code) | | Returns the IP address of the local host, i.e. the server.
This call returns the name of the host actaully used to connect to the
Resin server, which means that if ipchains, load balancing, or proxying
is involved this call does not return the correct host for
forming urls.
since:
2.4 |
| getLocalPort | | public int getLocalPort()(Code) | | Returns the port of the local host.
This call returns the port number actually used to connect to the Resin
server, which means that if ipchains, load balancing, or proxying is
involved this call does not return the correct port for
forming urls.
This call should not be used to test for an ssl connection
(getServerPort() == 443),
ServletRequest.isSecure() is provided for that purpose.
since:
2.4 |
| getLocale | | public Locale getLocale()(Code) | | Returns the request's preferred locale, based on the Accept-Language
header. If unspecified, returns the server's default locale.
|
| getLocales | | public Enumeration getLocales()(Code) | | Returns an enumeration of all locales acceptable by the client.
|
| getParameter | | public String getParameter(String name)(Code) | | Returns a form parameter. When the form contains several parameters
of the same name, getParameter returns the first.
For example, calling getParameter("a") with the
the query string a=1&a=2 will return "1".
Parameters:
name - the form parameter to return the form value or null if none matches. |
| getParameterMap | | public Map getParameterMap()(Code) | | Returns a Map of the form parameters. The map is immutable.
The keys are the form keys as returned by getParameterNames
and the values are String arrays as returned by
getParameterValues.
|
| getParameterNames | | public Enumeration getParameterNames()(Code) | | Returns an enumeration of all form parameter names.
Enumeration e = request.getParameterNames();
while (e.hasMoreElements()) {
String name = (String) e.nextElement();
out.println(name + ": " + request.getParameter(name));
}
|
| getParameterValues | | public String[] getParameterValues(String name)(Code) | | Returns all values of a form parameter.
For example, calling getParameterValues("a")
with the the query string a=1&a=2 will
return ["1", "2"].
Parameters:
name - the form parameter to return an array of matching form values or null if none matches. |
| getProtocol | | public String getProtocol()(Code) | | Returns the prococol, e.g. "HTTP/1.1"
|
| getRemoteAddr | | public String getRemoteAddr()(Code) | | Returns the IP address of the remote host, i.e. the client browser.
|
| getRemoteHost | | public String getRemoteHost()(Code) | | Returns the DNS hostname of the remote host, i.e. the client browser.
|
| getRemotePort | | public int getRemotePort()(Code) | | Returns the port of the remote host, i.e. the client browser.
since:
2.4 |
| getRequestDispatcher | | public RequestDispatcher getRequestDispatcher(String uri)(Code) | | Returns a request dispatcher for later inclusion or forwarding. This
is the servlet API equivalent to SSI includes. uri
is relative to the request URI. Absolute URIs are relative to
the application prefix (getContextPath()).
If getRequestURI() is /myapp/dir/test.jsp and the
uri is "inc.jsp", the resulting page is
/myapp/dir/inc.jsp.
RequestDispatcher disp;
disp = getRequestDispatcher("inc.jsp?a=b");
disp.include(request, response);
Parameters:
uri - path relative to getRequestURI()(including query string) for the included file. RequestDispatcher for later inclusion or forwarding. |
| getScheme | | public String getScheme()(Code) | | Returns the request scheme, e.g. "http"
|
| getServerName | | public String getServerName()(Code) | | Returns the server name handling the request. When using virtual hosts,
this returns the virtual host name, e.g. "vhost1.caucho.com".
This call returns the host name as the client sees it, which means that
if ipchains, load balancing, or proxying is involved this call returns the
correct call for forming urls, but may not contain the host that Resin is
actually listening on.
|
| getServerPort | | public int getServerPort()(Code) | | Returns the server port used by the client, e.g. 80.
This call returns the port number as the client sees it, which means that
if ipchains, load balancing, or proxying is involved this call returns the
correct call for forming urls, but may not return the actual port that
Resin is listening on.
This call should not be used to test for an ssl connection
(getServerPort() == 443),
ServletRequest.isSecure() is provided for that purpose.
|
| isSecure | | public boolean isSecure()(Code) | | Returns true if the connection is secure, e.g. it uses SSL.
|
| removeAttribute | | public void removeAttribute(String name)(Code) | | Removes the given attribute.
Parameters:
name - the attribute name |
| setAttribute | | public void setAttribute(String name, Object o)(Code) | | Sets an attribute value.
Parameters:
name - the attribute name
Parameters:
o - the attribute value |
| setCharacterEncoding | | public void setCharacterEncoding(String encoding) throws java.io.UnsupportedEncodingException(Code) | | Overrides the character encoding specified in the request.
setCharacterEncoding must be called before calling
getReader or reading any parameters.
|
|
|