Java Doc for HttpServletRequestWrapper.java in  » EJB-Server-resin-3.1.5 » jsdk » javax » servlet » http » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » jsdk » javax.servlet.http 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper

HttpServletRequestWrapper
public class HttpServletRequestWrapper extends ServletRequestWrapper implements HttpServletRequest(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




Constructor Summary
public  HttpServletRequestWrapper(HttpServletRequest request)
    

Method Summary
public  StringgetAuthType()
     Returns the auth type, e.g.
public  StringgetContextPath()
     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  longgetDateHeader(String name)
     Converts a date header to milliseconds since the epoch.
public  StringgetHeader(String name)
     Returns the first value for a request header.
public  EnumerationgetHeaderNames()
     Returns an enumeration of all headers sent by the client.
public  EnumerationgetHeaders(String name)
     Returns all the values for a request header.
public  intgetIntHeader(String name)
     Converts a header value to an integer.
public  StringgetMethod()
     Returns the HTTP method, e.g.
public  StringgetPathInfo()
     Returns the URI part after the selected servlet and null if there is no suffix.
public  StringgetPathTranslated()
     Returns the physical path name for the path info.
public  StringgetQueryString()
     Returns the request's query string.
public  StringgetRemoteUser()
     Returns the remote user if authenticated.
public  StringgetRequestURI()
    
public  StringBuffergetRequestURL()
     Reconstructs the URL the client used for the request.
public  StringgetRequestedSessionId()
     Returns the session id.
public  StringgetServletPath()
     Returns the URI part corresponding to the selected servlet.
public  HttpSessiongetSession(boolean create)
     Returns a session.
public  HttpSessiongetSession()
     Returns the current session, creating one if necessary.
public  PrincipalgetUserPrincipal()
     Returns the equivalent principal object for the authenticated user.
public  booleanisRequestedSessionIdFromCookie()
     Returns true if the session came from a cookie.
public  booleanisRequestedSessionIdFromURL()
     Returns true if the session came URL-encoding.
public  booleanisRequestedSessionIdFromUrl()
    
public  booleanisRequestedSessionIdValid()
     Returns true if the session is valid.
public  booleanisUserInRole(String role)
     Returns true if the user is in the given role.
public  voidsetRequest(ServletRequest request)
     Sets the request object for the wrapper.


Constructor Detail
HttpServletRequestWrapper
public HttpServletRequestWrapper(HttpServletRequest request)(Code)
Creates a new request wrapper
Parameters:
  request - the wrapped request




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



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.



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



getMethod
public String getMethod()(Code)
Returns the HTTP method, e.g. "GET" or "POST"

Equivalent to CGI's REQUEST_METHOD




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.




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




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



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.




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.



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



setRequest
public void setRequest(ServletRequest request)(Code)
Sets the request object for the wrapper.
Parameters:
  request - the wrapped request



Methods inherited from javax.servlet.ServletRequestWrapper
public Object getAttribute(String name)(Code)(Java Doc)
public Enumeration getAttributeNames()(Code)(Java Doc)
public String getCharacterEncoding()(Code)(Java Doc)
public int getContentLength()(Code)(Java Doc)
public String getContentType()(Code)(Java Doc)
public ServletInputStream getInputStream() throws IOException(Code)(Java Doc)
public String getLocalAddr()(Code)(Java Doc)
public String getLocalName()(Code)(Java Doc)
public int getLocalPort()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Enumeration getLocales()(Code)(Java Doc)
public String getParameter(String name)(Code)(Java Doc)
public Map getParameterMap()(Code)(Java Doc)
public Enumeration getParameterNames()(Code)(Java Doc)
public String[] getParameterValues(String name)(Code)(Java Doc)
public String getProtocol()(Code)(Java Doc)
public BufferedReader getReader() throws IOException, IllegalStateException(Code)(Java Doc)
public String getRealPath(String uri)(Code)(Java Doc)
public String getRemoteAddr()(Code)(Java Doc)
public String getRemoteHost()(Code)(Java Doc)
public int getRemotePort()(Code)(Java Doc)
public ServletRequest getRequest()(Code)(Java Doc)
public RequestDispatcher getRequestDispatcher(String uri)(Code)(Java Doc)
public String getScheme()(Code)(Java Doc)
public String getServerName()(Code)(Java Doc)
public int getServerPort()(Code)(Java Doc)
public boolean isSecure()(Code)(Java Doc)
public void removeAttribute(String name)(Code)(Java Doc)
public void setAttribute(String name, Object o)(Code)(Java Doc)
public void setCharacterEncoding(String encoding) throws UnsupportedEncodingException(Code)(Java Doc)
public void setRequest(ServletRequest request)(Code)(Java Doc)

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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.