Java Doc for HttpServletRequest.java in  » 6.0-JDK-Core » Servlet-API-by-tomcat » javax » servlet » http » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
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
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Servlet API by tomcat » javax.servlet.http 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.servlet.http.HttpServletRequest

All known Subclasses:   javax.servlet.http.HttpServletRequestWrapper,
HttpServletRequest
public interface HttpServletRequest extends ServletRequest(Code)
Extends the javax.servlet.ServletRequest interface to provide request information for HTTP servlets.

The servlet container creates an HttpServletRequest object and passes it as an argument to the servlet's service methods (doGet, doPost, etc).
author:
   Various
version:
   $Version$



Field Summary
final public static  StringBASIC_AUTH
     String identifier for Basic authentication.
final public static  StringCLIENT_CERT_AUTH
     String identifier for Client Certificate authentication.
final public static  StringDIGEST_AUTH
     String identifier for Digest authentication.
final public static  StringFORM_AUTH
     String identifier for Form authentication.


Method Summary
public  StringgetAuthType()
     Returns the name of the authentication scheme used to protect the servlet.
public  StringgetContextPath()
     Returns the portion of the request URI that indicates the context of the request.
public  Cookie[]getCookies()
     Returns an array containing all of the Cookie objects the client sent with this request.
public  longgetDateHeader(String name)
     Returns the value of the specified request header as a long value that represents a Date object.
public  StringgetHeader(String name)
     Returns the value of the specified request header as a String.
public  EnumerationgetHeaderNames()
     Returns an enumeration of all the header names this request contains.
public  EnumerationgetHeaders(String name)
     Returns all the values of the specified request header as an Enumeration of String objects.

Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive.

public  intgetIntHeader(String name)
     Returns the value of the specified request header as an int.
public  StringgetMethod()
     Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
public  StringgetPathInfo()
     Returns any extra path information associated with the URL the client sent when it made this request.
public  StringgetPathTranslated()
     Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
public  StringgetQueryString()
     Returns the query string that is contained in the request URL after the path.
public  StringgetRemoteUser()
     Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication.
public  StringgetRequestURI()
     Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.
public  StringBuffergetRequestURL()
     Reconstructs the URL the client used to make the request.
public  StringgetRequestedSessionId()
     Returns the session ID specified by the client.
public  StringgetServletPath()
     Returns the part of this request's URL that calls the servlet.
public  HttpSessiongetSession(boolean create)
     Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

If create is false and the request has no valid HttpSession, this method returns null.

To make sure the session is properly maintained, you must call this method before the response is committed.

public  HttpSessiongetSession()
     Returns the current session associated with this request, or if the request does not have a session, creates one.
public  java.security.PrincipalgetUserPrincipal()
     Returns a java.security.Principal object containing the name of the current authenticated user.
public  booleanisRequestedSessionIdFromCookie()
     Checks whether the requested session ID came in as a cookie.
public  booleanisRequestedSessionIdFromURL()
     Checks whether the requested session ID came in as part of the request URL.
public  booleanisRequestedSessionIdFromUrl()
    
public  booleanisRequestedSessionIdValid()
     Checks whether the requested session ID is still valid.
public  booleanisUserInRole(String role)
     Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Field Detail
BASIC_AUTH
final public static String BASIC_AUTH(Code)
String identifier for Basic authentication. Value "BASIC"



CLIENT_CERT_AUTH
final public static String CLIENT_CERT_AUTH(Code)
String identifier for Client Certificate authentication. Value "CLIENT_CERT"



DIGEST_AUTH
final public static String DIGEST_AUTH(Code)
String identifier for Digest authentication. Value "DIGEST"



FORM_AUTH
final public static String FORM_AUTH(Code)
String identifier for Form authentication. Value "FORM"





Method Detail
getAuthType
public String getAuthType()(Code)
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticated null is returned.

Same as the value of the CGI variable AUTH_TYPE. one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH(suitable for == comparison) orthe container-specific string indicatingthe authentication scheme, ornull if the request was not authenticated.




getContextPath
public String getContextPath()(Code)
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string. a String specifying theportion of the request URI that indicates the contextof the request



getCookies
public Cookie[] getCookies()(Code)
Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent. an array of all the Cookiesincluded with this request, or nullif the request has no cookies



getDateHeader
public long getDateHeader(String name)(Code)
Returns the value of the specified request header as a long value that represents a Date object. Use this method with headers that contain dates, such as If-Modified-Since.

The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.

If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an IllegalArgumentException.
Parameters:
  name - a String specifying thename of the header a long valuerepresenting the date specifiedin the header expressed asthe number of millisecondssince January 1, 1970 GMT,or -1 if the named headerwas not included with therequest
exception:
  IllegalArgumentException - If the header valuecan't be convertedto a date




getHeader
public String getHeader(String name)(Code)
Returns the value of the specified request header as a String. If the request did not include a header of the specified name, this method returns null. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.
Parameters:
  name - a String specifying theheader name a String containing thevalue of the requestedheader, or nullif the request does nothave a header of that name



getHeaderNames
public Enumeration getHeaderNames()(Code)
Returns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.

Some servlet containers do not allow servlets to access headers using this method, in which case this method returns null an enumeration of all theheader names sent with thisrequest; if the request hasno headers, an empty enumeration;if the servlet container does notallow servlets to use this method,null




getHeaders
public Enumeration getHeaders(String name)(Code)
Returns all the values of the specified request header as an Enumeration of String objects.

Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.
Parameters:
  name - a String specifying theheader name an Enumeration containingthe values of the requested header. Ifthe request does not have any headers ofthat name return an emptyenumeration. If the container does not allow access toheader information, return null




getIntHeader
public int getIntHeader(String name)(Code)
Returns the value of the specified request header as an int. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws a NumberFormatException.

The header name is case insensitive.
Parameters:
  name - a String specifying the nameof a request header an integer expressing the value of the request header or -1if the request doesn't have aheader of this name
exception:
  NumberFormatException - If the header valuecan't be convertedto an int




getMethod
public String getMethod()(Code)
Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD. a String specifying the nameof the method with whichthis request was made



getPathInfo
public String getPathInfo()(Code)
Returns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.

This method returns null if there was no extra path information.

Same as the value of the CGI variable PATH_INFO. a String, decoded by theweb container, specifying extra path information that comesafter the servlet path but beforethe query string in the request URL;or null if the URL does not haveany extra path information




getPathTranslated
public String getPathTranslated()(Code)
Returns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.

If the URL does not have any extra path information, this method returns null or the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string. a String specifying thereal path, or null ifthe URL does not have any extra pathinformation




getQueryString
public String getQueryString()(Code)
Returns the query string that is contained in the request URL after the path. This method returns null if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING. a String containing the querystring or null if the URL contains no query string. The value is notdecoded by the container.



getRemoteUser
public String getRemoteUser()(Code)
Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER. a String specifying the loginof the user making this request, or nullif the user login is not known



getRequestURI
public String getRequestURI()(Code)
Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:
First line of HTTP request Returned Value
POST /some/path.html HTTP/1.1/some/path.html
GET http://foo.bar/a.html HTTP/1.0 /a.html
HEAD /xyz?a=b HTTP/1.1/xyz

To reconstruct an URL with a scheme and host, use HttpUtils.getRequestURL . a String containingthe part of the URL from the protocol name up to the query string
See Also:   HttpUtils.getRequestURL




getRequestURL
public StringBuffer getRequestURL()(Code)
Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors. a StringBuffer object containingthe reconstructed URL




getRequestedSessionId
public String getRequestedSessionId()(Code)
Returns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returns null. a String specifying the sessionID, or null if the request didnot specify a session ID
See Also:   HttpServletRequest.isRequestedSessionIdValid



getServletPath
public String getServletPath()(Code)
Returns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.

This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern. a String containingthe name or path of the servlet beingcalled, as specified in the request URL,decoded, or an empty string if the servletused to process the request is matchedusing the "/*" pattern.




getSession
public HttpSession getSession(boolean create)(Code)
Returns the current HttpSession associated with this request or, if there is no current session and create is true, returns a new session.

If create is false and the request has no valid HttpSession, this method returns null.

To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
Parameters:
  create - true to createa new session for this request if necessary; false to return nullif there's no current session the HttpSession associated with this request or null ifcreate is falseand the request has no valid session
See Also:   HttpServletRequest.getSession()




getSession
public HttpSession getSession()(Code)
Returns the current session associated with this request, or if the request does not have a session, creates one. the HttpSession associatedwith this request
See Also:   HttpServletRequest.getSession(boolean)



getUserPrincipal
public java.security.Principal getUserPrincipal()(Code)
Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null. a java.security.Principal containingthe name of the user making this request;null if the user has not been authenticated



isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()(Code)
Checks whether the requested session ID came in as a cookie. true if the session IDcame in as acookie; otherwise, false
See Also:   HttpServletRequest.getSession



isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()(Code)
Checks whether the requested session ID came in as part of the request URL. true if the session IDcame in as part of a URL; otherwise,false
See Also:   HttpServletRequest.getSession



isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()(Code)
HttpServletRequest.isRequestedSessionIdFromURL



isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()(Code)
Checks whether the requested session ID is still valid. true if thisrequest has an id for a valid sessionin the current session context;false otherwise
See Also:   HttpServletRequest.getRequestedSessionId
See Also:   HttpServletRequest.getSession
See Also:   HttpSessionContext



isUserInRole
public boolean isUserInRole(String role)(Code)
Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.
Parameters:
  role - a String specifying the nameof the role a boolean indicating whetherthe user making this request belongs to a given role;false if the user has not been authenticated



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