Java Doc for HttpServletRequest.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

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 » jsdk » 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)
HttpServletRequest encapsulates client request data.
URI
The servlet engine splits the URI into three useful sections: the context path (application prefix), the servlet path, and the path info.
For example, given an application prefix of '/myapp', the api /myapp/dir/test.jsp/data will be split as follows:

/myapp/dir/test.jsp/data getRequestURI()
/myapp getContextPath()
/dir/test.jsp getServletPath()
/data getPathInfo()

Useful headers

User-Agent String describing the browser's version

CGI equivalents

AUTH_TYPE getAuthType()
CONTENT_TYPE getContentType()
CONTENT_LENGTH getContentLength()
PATH_INFO getPathInfo()
PATH_TRANSLATED getPathTranslated()
QUERY_STRING getQueryString()
REMOTE_ADDR getRemoteAddr()
REMOTE_HOST getRemoteHost()
REMOTE_USER getRemoteUser()
REQUEST_METHOD getMethod()
SCRIPT_NAME getServletPath()
SERVER_NAME getServerName()
SERVER_PROTOCOL getProtocol()
SERVER_PORT getServerPort()

Form data
For form data, see ServletRequest.getParameter()

Field Summary
final public static String BASIC_AUTH
     String identifier for basic authentication.
final public static String CLIENT_CERT_AUTH
     String identifier for client cert authentication.
final public static String DIGEST_AUTH
     String identifier for digest authenciation.
final public static String FORM_AUTH
     String identifier for form authenciation.

Method Summary
public String getAuthType()
     Returns the auth type, i.e.
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 int getIntHeader(String name)
     Converts a header value to an integer.
public String getMethod()
     Returns the HTTP method, e.g.
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 getQueryString()
     Returns the request's query string.
public String getRemoteUser()
     Returns the remote user if authenticated.
public String getRequestURI()

public StringBuffer getRequestURL()
     Reconstructs the URL the client used for the request.
public String getRequestedSessionId()
     Returns the session id.
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 isUserInRole(String role)
     Returns true if the user is in the given 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 cert authentication. Value "CLIENT_CERT".

DIGEST_AUTH
final public static String DIGEST_AUTH(Code)
String identifier for digest authenciation. Value "DIGEST".

FORM_AUTH
final public static String FORM_AUTH(Code)
String identifier for form authenciation. Value "FORM".

Method Detail
getAuthType
public String getAuthType()(Code)
Returns the auth type, i.e. BASIC, CLIENT-CERT, DIGEST, or FORM.

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.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.