Save This Page
Home » apache-tomcat-6.0.26-src » javax » servlet » http » [javadoc | source]
javax.servlet.http
public interface: HttpServletRequest [javadoc | source]

All Implemented Interfaces:
    ServletRequest

All Known Implementing Classes:
    HttpServletRequestWrapper

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

Field Summary
public static final  String BASIC_AUTH    String identifier for Basic authentication. Value "BASIC" 
public static final  String FORM_AUTH    String identifier for Form authentication. Value "FORM" 
public static final  String CLIENT_CERT_AUTH    String identifier for Client Certificate authentication. Value "CLIENT_CERT" 
public static final  String DIGEST_AUTH    String identifier for Digest authentication. Value "DIGEST" 
Method from javax.servlet.http.HttpServletRequest Summary:
getAuthType,   getContextPath,   getCookies,   getDateHeader,   getHeader,   getHeaderNames,   getHeaders,   getIntHeader,   getMethod,   getPathInfo,   getPathTranslated,   getQueryString,   getRemoteUser,   getRequestURI,   getRequestURL,   getRequestedSessionId,   getServletPath,   getSession,   getSession,   getUserPrincipal,   isRequestedSessionIdFromCookie,   isRequestedSessionIdFromURL,   isRequestedSessionIdFromUrl,   isRequestedSessionIdValid,   isUserInRole
Method from javax.servlet.http.HttpServletRequest Detail:
 public String getAuthType()
    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.

 public String getContextPath()
    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.
 public Cookie[] getCookies()
    Returns an array containing all of the Cookie objects the client sent with this request. This method returns null if no cookies were sent.
 public long getDateHeader(String name)
    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.

 public String getHeader(String name)
    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.
 public Enumeration getHeaderNames()
    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

 public Enumeration getHeaders(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. You can use this method with any request header.

 public int getIntHeader(String name)
    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.

 public String getMethod()
    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.
 public String getPathInfo()
    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.

 public String getPathTranslated()
    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.

 public String getQueryString()
    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.
 public String getRemoteUser()
    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.
 public String getRequestURI()
    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 .

 public StringBuffer getRequestURL()
    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.

 public String getRequestedSessionId()
    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.
 public String getServletPath()
    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.

 public HttpSession getSession()
    Returns the current session associated with this request, or if the request does not have a session, creates one.
 public HttpSession getSession(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. 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.

 public Principal getUserPrincipal()
    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.
 public boolean isRequestedSessionIdFromCookie()
    Checks whether the requested session ID came in as a cookie.
 public boolean isRequestedSessionIdFromURL()
    Checks whether the requested session ID came in as part of the request URL.
 public boolean isRequestedSessionIdFromUrl()Deprecated! As -  of Version 2.1 of the Java Servlet
			API, use #isRequestedSessionIdFromURL 
			instead.

 public boolean isRequestedSessionIdValid()
    Checks whether the requested session ID is still valid.
 public boolean isUserInRole(String role)
    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.