Java Doc for ServletRequest.java in  » Sevlet-Container » apache-tomcat-6.0.14 » 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 » Sevlet Container » apache tomcat 6.0.14 » javax.servlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.servlet.ServletRequest

All known Subclasses:   javax.servlet.ServletRequestWrapper,
ServletRequest
public interface ServletRequest (Code)
Defines an object to provide client request information to a servlet. The servlet container creates a ServletRequest object and passes it as an argument to the servlet's service method.

A ServletRequest object provides data including parameter name and values, attributes, and an input stream. Interfaces that extend ServletRequest can provide additional protocol-specific data (for example, HTTP data is provided by javax.servlet.http.HttpServletRequest .
author:
   Various
version:
   $Version$
See Also:   javax.servlet.http.HttpServletRequest





Method Summary
public  ObjectgetAttribute(String name)
     Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
public  EnumerationgetAttributeNames()
     Returns an Enumeration containing the names of the attributes available to this request.
public  StringgetCharacterEncoding()
     Returns the name of the character encoding used in the body of this request.
public  intgetContentLength()
     Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
public  StringgetContentType()
     Returns the MIME type of the body of the request, or null if the type is not known.
public  ServletInputStreamgetInputStream()
     Retrieves the body of the request as binary data using a ServletInputStream .
public  StringgetLocalAddr()
     Returns the Internet Protocol (IP) address of the interface on which the request was received. a String containing theIP address on which the request was received.
public  StringgetLocalName()
     Returns the host name of the Internet Protocol (IP) interface on which the request was received.
public  intgetLocalPort()
     Returns the Internet Protocol (IP) port number of the interface on which the request was received.
public  LocalegetLocale()
     Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
public  EnumerationgetLocales()
     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.
public  StringgetParameter(String name)
     Returns the value of a request parameter as a String, or null if the parameter does not exist.
public  MapgetParameterMap()
     Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the request.
public  EnumerationgetParameterNames()
     Returns an Enumeration of String objects containing the names of the parameters contained in this request.
public  String[]getParameterValues(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.
public  StringgetProtocol()
     Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
public  BufferedReadergetReader()
     Retrieves the body of the request as character data using a BufferedReader.
public  StringgetRealPath(String path)
    
public  StringgetRemoteAddr()
     Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
public  StringgetRemoteHost()
     Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address.
public  intgetRemotePort()
     Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
public  RequestDispatchergetRequestDispatcher(String path)
     Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
public  StringgetScheme()
     Returns the name of the scheme used to make this request, for example, http, https, or ftp.
public  StringgetServerName()
     Returns the host name of the server to which the request was sent.
public  intgetServerPort()
     Returns the port number to which the request was sent.
public  booleanisSecure()
     Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
public  voidremoveAttribute(String name)
     Removes an attribute from this request.
public  voidsetAttribute(String name, Object o)
     Stores an attribute in this request. Attributes are reset between requests.
public  voidsetCharacterEncoding(String env)
     Overrides the name of the character encoding used in the body of this request.



Method Detail
getAttribute
public Object getAttribute(String name)(Code)
Returns the value of the named attribute as an Object, 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 . 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.*.
Parameters:
  name - a String specifying the name of the attribute an Object containing the value of the attribute, or null ifthe attribute does not exist




getAttributeNames
public Enumeration getAttributeNames()(Code)
Returns an Enumeration 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. an Enumeration of strings containing the names of the request's attributes



getCharacterEncoding
public String getCharacterEncoding()(Code)
Returns the name of the character encoding used in the body of this request. This method returns null if the request does not specify a character encoding a String containing the name of the character encoding, or nullif the request does not specify a character encoding



getContentLength
public int getContentLength()(Code)
Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH. an integer containing the length of the request body or -1 if the length is not known



getContentType
public String getContentType()(Code)
Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE. a String containing the name of the MIME type of the request, or null if the type is not known



getInputStream
public ServletInputStream getInputStream() throws IOException(Code)
Retrieves the body of the request as binary data using a ServletInputStream . Either this method or ServletRequest.getReader may be called to read the body, not both. a ServletInputStream object containingthe body of the request
exception:
  IllegalStateException - if the ServletRequest.getReader methodhas already been called for this request
exception:
  IOException - if an input or output exception occurred



getLocalAddr
public String getLocalAddr()(Code)
Returns the Internet Protocol (IP) address of the interface on which the request was received. a String containing theIP address on which the request was received.
since:
   2.4



getLocalName
public String getLocalName()(Code)
Returns the host name of the Internet Protocol (IP) interface on which the request was received. a String containing the hostname of the IP on which the request was received.
since:
   2.4



getLocalPort
public int getLocalPort()(Code)
Returns the Internet Protocol (IP) port number of the interface on which the request was received. an integer specifying the port number
since:
   2.4



getLocale
public Locale getLocale()(Code)
Returns the preferred Locale 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. the preferred Locale for the client



getLocales
public Enumeration getLocales()(Code)
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. 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. an Enumeration of preferred Locale objects for the client



getParameter
public String getParameter(String name)(Code)
Returns the value of a request parameter as a String, 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 .

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.
Parameters:
  name - a String specifying the name of the parameter a String representing the single value of the parameter
See Also:   ServletRequest.getParameterValues




getParameterMap
public Map getParameterMap()(Code)
Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data. an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parametermap are of type String. The values in the parameter map are of typeString array.



getParameterNames
public Enumeration getParameterNames()(Code)
Returns an Enumeration 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. an Enumeration of Stringobjects, each String containingthe name of a request parameter; or an empty Enumeration if therequest has no parameters



getParameterValues
public String[] getParameterValues(String name)(Code)
Returns an array of String 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.
Parameters:
  name - a String containing the name of the parameter whose value is requested an array of String objects containing the parameter's values
See Also:   ServletRequest.getParameter




getProtocol
public String getProtocol()(Code)
Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL. a String containing the protocol name and version number



getReader
public BufferedReader getReader() throws IOException(Code)
Retrieves the body of the request as character data using a BufferedReader. 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. a BufferedReadercontaining the body of the request
exception:
  UnsupportedEncodingException - if the character set encodingused is not supported and the text cannot be decoded
exception:
  IllegalStateException - if ServletRequest.getInputStream methodhas been called on this request
exception:
  IOException - if an input or output exception occurred
See Also:   ServletRequest.getInputStream



getRealPath
public String getRealPath(String path)(Code)
ServletContext.getRealPath



getRemoteAddr
public String getRemoteAddr()(Code)
Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR. a String containing the IP address of the client that sent the request



getRemoteHost
public String getRemoteHost()(Code)
Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST. a String containing the fully qualified name of the client



getRemotePort
public int getRemotePort()(Code)
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request. an integer specifying the port number
since:
   2.4



getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String path)(Code)
Returns a RequestDispatcher 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 is that this method can take a relative path.
Parameters:
  path - a String specifying the pathnameto the resource. If it is relative, it must berelative against the current servlet. a RequestDispatcher objectthat acts as a wrapper for the resourceat the specified path, or nullif the servlet container cannot return aRequestDispatcher
See Also:   RequestDispatcher
See Also:   ServletContext.getRequestDispatcher




getScheme
public String getScheme()(Code)
Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738. a String containing the name of the scheme used to make this request



getServerName
public String getServerName()(Code)
Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address. a String containing the name of the server



getServerPort
public int getServerPort()(Code)
Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on. an integer specifying the port number



isSecure
public boolean isSecure()(Code)
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS. a boolean indicating if the request was made using asecure channel



removeAttribute
public void removeAttribute(String name)(Code)
Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

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.
Parameters:
  name - a String specifying the name of the attribute to remove




setAttribute
public void setAttribute(String name, Object o)(Code)
Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher .

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 .
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.
Parameters:
  name - a String specifying the name of the attribute
Parameters:
  o - the Object to be stored




setCharacterEncoding
public void setCharacterEncoding(String env) throws java.io.UnsupportedEncodingException(Code)
Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader().
Parameters:
  env - a String containing the name of the character encoding.
throws:
  java.io.UnsupportedEncodingException - if this is not a valid encoding



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.