All Packages Class Hierarchy This Package Previous Next Index
Interface javax.servlet.http.HttpServletRequest
- public interface HttpServletRequest
- extends ServletRequest
This interface represents an HTTP servlet request. It gets data
from the client to the servlet for use in the service method. It
allows the HTTP-protocol specified header information to be accessed
from the service method.
-
getAuthType()
- Returns the authentication scheme of the request, or null if none.
-
getDateHeader(String)
- Returns the value of a date header field, or -1 if not found.
-
getHeader(String)
- Returns the value of a header field, or null if not known.
-
getHeaderNames()
- Returns an enumeration of strings representing the header names
for this request.
-
getIntHeader(String)
- Returns the value of an integer header field, or -1 if not found.
-
getMethod()
- Returns the method with which the request was made.
-
getPathInfo()
- Returns optional extra path information following the servlet
path, but immediately preceding the query string.
-
getPathTranslated()
- Returns extra path information translated to a real path.
-
getQueryString()
- Returns the query string part of the servlet URI, or null if none.
-
getRemoteUser()
- Returns the name of the user making this request, or null if not
known.
-
getRequestURI()
- Returns the request URI as a URL object.
-
getServletPath()
- Returns the part of the request URI that refers to the servlet
being invoked.
getMethod
public abstract String getMethod()
- Returns the method with which the request was made. The returned
value can be "GET", "HEAD", "POST", or an extension method. Same
as the CGI variable REQUEST_METHOD.
getRequestURI
public abstract String getRequestURI()
- Returns the request URI as a URL object.
getServletPath
public abstract String getServletPath()
- Returns the part of the request URI that refers to the servlet
being invoked. Analogous to the CGI variable SCRIPT_NAME.
getPathInfo
public abstract String getPathInfo()
- Returns optional extra path information following the servlet
path, but immediately preceding the query string. Returns null if
not specified. Same as the CGI variable PATH_INFO.
getPathTranslated
public abstract String getPathTranslated()
- Returns extra path information translated to a real path. Returns
null if no extra path information specified. Same as the CGI variable
PATH_TRANSLATED.
getQueryString
public abstract String getQueryString()
- Returns the query string part of the servlet URI, or null if none.
Same as the CGI variable QUERY_STRING.
getRemoteUser
public abstract String getRemoteUser()
- Returns the name of the user making this request, or null if not
known. The user name is set with HTTP authentication. Whether
the user name will continue to be sent with each subsequent
communication is browser-dependent. Same as the CGI variable
REMOTE_USER.
getAuthType
public abstract String getAuthType()
- Returns the authentication scheme of the request, or null if none.
Same as the CGI variable AUTH_TYPE.
getHeader
public abstract String getHeader(String name)
- Returns the value of a header field, or null if not known.
The case of the header field name is ignored.
- Parameters:
- name - the case-insensitive header field name
getIntHeader
public abstract int getIntHeader(String name)
- Returns the value of an integer header field, or -1 if not found.
The case of the header field name is ignored.
- Parameters:
- name - the case-insensitive header field name
getDateHeader
public abstract long getDateHeader(String name)
- Returns the value of a date header field, or -1 if not found.
The case of the header field name is ignored.
- Parameters:
- name - the case-insensitive header field name
getHeaderNames
public abstract Enumeration getHeaderNames()
- Returns an enumeration of strings representing the header names
for this request. Some server implementations do not allow headers
to be accessed in this way, in which case this method will return null.
All Packages Class Hierarchy This Package Previous Next Index