Java Doc for RequestWrapper.java in » EJB-Server-resin-3.1.5 » resin » com » caucho » server » connection » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » EJB Server resin 3.1.5 » resin » com.caucho.server.connection

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.caucho.server.connection .RequestWrapper

All known Subclasses:   com.caucho.server.connection .RequestAdapter,
RequestWrapper
public class RequestWrapper implements ServletRequest(Code)
Wraps a servlet request in another request. Filters may use ServletRequestWrapper to modify the headers passed to the servlet.
The default methods just call the wrapped request methods.
since:
   servlet 2.3

Field Summary
protected HttpServletRequest _request


Constructor Summary
public RequestWrapper()
     Create a new ServletRequestWrapper wrapping the enclosed request.
public RequestWrapper(HttpServletRequest request)
     Create a new ServletRequestWrapper wrapping the enclosed request.

Method Summary
protected void free()
     Clears the wrapper.
public Object getAttribute(String name)
     Returns an attribute value.
public Enumeration getAttributeNames()
     Enumerates all attribute names in the request.
public String getAuthType()
     Returns the auth type, e.g.
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 String getContextPath()
     Returns the part of the URI corresponding to the application's prefix.
public Cookie[] getCookies()
     Returns an array of all cookies sent by the client.
public long getDateHeader(String name)
     Converts a date header to milliseconds since the epoch.
public String getHeader(String name)
     Returns the first value for a request header.
public Enumeration getHeaderNames()
     Returns an enumeration of all headers sent by the client.
public Enumeration getHeaders(String name)
     Returns all the values for a request header.
public ServletInputStream getInputStream()
     Returns an InputStream to retrieve POST data from the request.
public int getIntHeader(String name)
     Converts a header value to an integer.
public String getLocalAddr()
     Returns the IP address of the local host, i.e.
public String getLocalName()
     Returns the local host name.
public int getLocalPort()

public Locale getLocale()
     Returns the request's preferred locale.
public Enumeration getLocales()
     Returns an enumeration of all locales acceptable by the client.
public String getMethod()
     Returns the HTTP method, e.g.
public String getParameter(String name)
     Returns a form parameter.
public Map getParameterMap()
     Returns the parameter map request 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 getPathInfo()
     Returns the URI part after the selected servlet and null if there is no suffix.
public String getPathTranslated()
     Returns the physical path name for the path info.
public String getProtocol()
     Returns the prococol, e.g.
public String getQueryString()
     Returns the request's query string.
public BufferedReader getReader()
     Returns a reader to read POSTed data.
public String getRealPath(String uri)
     Returns the real path.
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()

public String getRemoteUser()
     Returns the remote user if authenticated.
public HttpServletRequest getRequest()
     Gets the request object being wrapped.
public RequestDispatcher getRequestDispatcher(String uri)
     Returns a request dispatcher for later inclusion or forwarding.
public String getRequestURI()

public StringBuffer getRequestURL()
     Reconstructs the URL the client used for the request.
public String getRequestedSessionId()
     Returns the session id.
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 handling the request, e.g.
public String getServletPath()
     Returns the URI part corresponding to the selected servlet.
public HttpSession getSession(boolean create)
     Returns a session.
public HttpSession getSession()
     Returns the current session, creating one if necessary.
public Principal getUserPrincipal()
     Returns the equivalent principal object for the authenticated user.
public boolean isRequestedSessionIdFromCookie()
     Returns true if the session came from a cookie.
public boolean isRequestedSessionIdFromURL()
     Returns true if the session came URL-encoding.
public boolean isRequestedSessionIdFromUrl()

public boolean isRequestedSessionIdValid()
     Returns true if the session is valid.
public boolean isSecure()
     Returns true if the connection is secure, e.g.
public boolean isUserInRole(String role)
     Returns true if the user is in the given role.
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)
     Sets the character encoding to be used for forms and getReader.
public void setRequest(HttpServletRequest request)
     Sets the request object being wrapped.

Field Detail
_request
protected HttpServletRequest _request(Code)

Constructor Detail
RequestWrapper
public RequestWrapper()(Code)
Create a new ServletRequestWrapper wrapping the enclosed request.

RequestWrapper
public RequestWrapper(HttpServletRequest request)(Code)
Create a new ServletRequestWrapper wrapping the enclosed request.

Method Detail
free
protected void free()(Code)
Clears the wrapper.

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.

getAuthType
public String getAuthType()(Code)
Returns the auth type, e.g. basic.

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. For newer browsers, i.e. those supporting HTTP/1.1, can support "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.

getContextPath
public String getContextPath()(Code)
Returns the part of the URI corresponding to the application's prefix. The first part of the URI selects applications (ServletContexts).
getContextPath() is /myapp for the uri /myapp/servlet/Hello,

getCookies
public Cookie[] getCookies()(Code)
Returns an array of all cookies sent by the client.

getDateHeader
public long getDateHeader(String name)(Code)
Converts a date header to milliseconds since the epoch.
long mod = _request.getDateHeader("If-Modified-Since");

Parameters:
  name - the header name the header value converted to an date

getHeader
public String getHeader(String name)(Code)
Returns the first value for a request header.
Corresponds to CGI's HTTP_*
String userAgent = request.getHeader("User-Agent");

Parameters:
  name - the header name the header value

getHeaderNames
public Enumeration getHeaderNames()(Code)
Returns an enumeration of all headers sent by the client.

getHeaders
public Enumeration getHeaders(String name)(Code)
Returns all the values for a request header. In some rare cases, like cookies, browsers may return multiple headers.
Parameters:
  name - the header name an enumeration of the header values.

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.

getIntHeader
public int getIntHeader(String name)(Code)
Converts a header value to an integer.
Parameters:
  name - the header name the header value converted to an integer

getLocalAddr
public String getLocalAddr()(Code)
Returns the IP address of the local host, i.e. the server.

getLocalName
public String getLocalName()(Code)
Returns the local host name.

getLocalPort
public int getLocalPort()(Code)
Returns the local port

getLocale
public Locale getLocale()(Code)
Returns the request's preferred locale.

getLocales
public Enumeration getLocales()(Code)
Returns an enumeration of all locales acceptable by the client.

getMethod
public String getMethod()(Code)
Returns the HTTP method, e.g. "GET" or "POST"
Equivalent to CGI's REQUEST_METHOD

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 the parameter map request parameters. By default, returns the underlying request's map.

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.

getPathInfo
public String getPathInfo()(Code)
Returns the URI part after the selected servlet and null if there is no suffix.
Corresponds to CGI's PATH_INFO
getPathInfo() is /foo for the uri /myapp/servlet/Hello/foo. getPathInfo() is /hello.jsp for for the uri /myapp/dir/hello.jsp/foo.

getPathTranslated
public String getPathTranslated()(Code)
Returns the physical path name for the path info.
Corresponds to CGI's PATH_TRANSLATED null if there is no path info.

getProtocol
public String getProtocol()(Code)
Returns the prococol, e.g. "HTTP/1.1"

getQueryString
public String getQueryString()(Code)
Returns the request's query string. Form based servlets will use ServletRequest.getParameter() to decode the form values.
Corresponds to CGI's PATH_TRANSLATED

getReader
public BufferedReader getReader() throws IOException, IllegalStateException(Code)
Returns a reader to read POSTed data. Character encoding is based on the request data and is the same as getCharacterEncoding()

getRealPath
public String getRealPath(String uri)(Code)
Returns the real path.

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 remote port
since:
   2.4

getRemoteUser
public String getRemoteUser()(Code)
Returns the remote user if authenticated.

getRequest
public HttpServletRequest getRequest()(Code)
Gets the request object being wrapped. the wrapped response

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.

getRequestURI
public String getRequestURI()(Code)
Returns the entire request URI

getRequestURL
public StringBuffer getRequestURL()(Code)
Reconstructs the URL the client used for the request.
since:
   Servlet 2.3

getRequestedSessionId
public String getRequestedSessionId()(Code)
Returns the session id. Sessions are a convenience for keeping user state across requests.
The session id is the value of the JSESSION cookie.

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

getServerPort
public int getServerPort()(Code)
Returns the server port handling the request, e.g. 80.

getServletPath
public String getServletPath()(Code)
Returns the URI part corresponding to the selected servlet. The URI is relative to the application.
Corresponds to CGI's SCRIPT_NAME getServletPath() is /servlet/Hello for the uri /myapp/servlet/Hello/foo. getServletPath() is /dir/hello.jsp for the uri /myapp/dir/hello.jsp/foo,

getSession
public HttpSession getSession(boolean create)(Code)
Returns a session. If no session exists and create is true, then create a new session, otherwise return null.
Parameters:
  create - If true, then create a new session if none exists.

getSession
public HttpSession getSession()(Code)
Returns the current session, creating one if necessary. Sessions are a convenience for keeping user state across requests.

getUserPrincipal
public Principal getUserPrincipal()(Code)
Returns the equivalent principal object for the authenticated user.

isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()(Code)
Returns true if the session came from a cookie.

isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()(Code)
Returns true if the session came URL-encoding.

isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()(Code)

isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()(Code)
Returns true if the session is valid.

isSecure
public boolean isSecure()(Code)
Returns true if the connection is secure, e.g. it uses SSL.

isUserInRole
public boolean isUserInRole(String role)(Code)
Returns true if the user is in the given role.

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 UnsupportedEncodingException(Code)
Sets the character encoding to be used for forms and getReader.

setRequest
public void setRequest(HttpServletRequest request)(Code)
Sets the request object being wrapped.
exception:
  IllegalArgumentException - if the request is null

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.