Java Doc for ServletRequestWrapper.java in  » EJB-Server-resin-3.1.5 » jsdk » javax » servlet » 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 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.servlet.ServletRequestWrapper

All known Subclasses:   javax.servlet.http.HttpServletRequestWrapper,
ServletRequestWrapper
public class ServletRequestWrapper 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




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

Method Summary
public  ObjectgetAttribute(String name)
     Returns an attribute value.
public  EnumerationgetAttributeNames()
     Enumerates all attribute names in the request.
public  StringgetCharacterEncoding()
     Returns the character encoding of the POSTed data.
public  intgetContentLength()
     Returns the content length of the data.
public  StringgetContentType()
     Returns the request's mime-type.
public  ServletInputStreamgetInputStream()
     Returns an InputStream to retrieve POST data from the request.
public  StringgetLocalAddr()
     Returns the IP address of the local host, i.e.
public  StringgetLocalName()
     Returns the local host name.
public  intgetLocalPort()
    
public  LocalegetLocale()
     Returns the request's preferred locale.
public  EnumerationgetLocales()
     Returns an enumeration of all locales acceptable by the client.
public  StringgetParameter(String name)
     Returns a form parameter.
public  MapgetParameterMap()
     Returns the parameter map request parameters.
public  EnumerationgetParameterNames()
     Returns an enumeration of all form parameter names.
public  String[]getParameterValues(String name)
     Returns all values of a form parameter.
public  StringgetProtocol()
     Returns the prococol, e.g.
public  BufferedReadergetReader()
     Returns a reader to read POSTed data.
public  StringgetRealPath(String uri)
     Returns the real path.
public  StringgetRemoteAddr()
     Returns the IP address of the remote host, i.e.
public  StringgetRemoteHost()
     Returns the DNS hostname of the remote host, i.e.
public  intgetRemotePort()
    
public  ServletRequestgetRequest()
     Gets the request object being wrapped.
public  RequestDispatchergetRequestDispatcher(String uri)
     Returns a request dispatcher for later inclusion or forwarding.
public  StringgetScheme()
     Returns the request scheme, e.g.
public  StringgetServerName()
     Returns the server name handling the request.
public  intgetServerPort()
     Returns the server port handling the request, e.g.
public  booleanisSecure()
     Returns true if the connection is secure, e.g.
public  voidremoveAttribute(String name)
     Removes the given attribute.
public  voidsetAttribute(String name, Object o)
     Sets an attribute value.
public  voidsetCharacterEncoding(String encoding)
     Sets the character encoding to be used for forms and getReader.
public  voidsetRequest(ServletRequest request)
     Sets the request object being wrapped.


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




Method Detail
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. 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.



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



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.




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



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



getRequest
public ServletRequest 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.



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.



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



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