Movatterモバイル変換

Interface HttpServletRequest

All Superinterfaces:: ServletRequest

All Known Implementing Classes:: HttpServletRequestWrapper

public interfaceHttpServletRequest
extendsServletRequest

Extends theServletRequest interface to provide request information for HTTP servlets.

The servlet container creates anHttpServletRequest object and passes it as an argument to the servlet's service methods (doGet,doPost, etc).


	`BASIC_AUTH` String identifier for Basic authentication.
	`CLIENT_CERT_AUTH` String identifier for Basic authentication.
	`DIGEST_AUTH` String identifier for Basic authentication.
	`FORM_AUTH` String identifier for Basic authentication.


	`getAuthType()` Returns the name of the authentication scheme used to protect the servlet.
	`getContextPath()` Returns the portion of the request URI that indicates the context of the request.
	`getCookies()` Returns an array containing all of the`Cookie` objects the client sent with this request.
	`getDateHeader(java.lang.String name)` Returns the value of the specified request header as a`long` value that represents a`Date` object.
	`getHeader(java.lang.String name)` Returns the value of the specified request header as a`String`.
	`getHeaderNames()` Returns an enumeration of all the header names this request contains.
	`getHeaders(java.lang.String name)` Returns all the values of the specified request header as an`Enumeration` of`String` objects.
	`getIntHeader(java.lang.String name)` Returns the value of the specified request header as an`int`.
	`getMethod()` Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
	`getPathInfo()` Returns any extra path information associated with the URL the client sent when it made this request.
	`getPathTranslated()` Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
	`getQueryString()` Returns the query string that is contained in the request URL after the path.
	`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.
	`getRequestedSessionId()` Returns the session ID specified by the client.
	`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.
	`getRequestURL()` Reconstructs the URL the client used to make the request.
	`getServletPath()` Returns the part of this request's URL that calls the servlet.
	`getSession()` Returns the current session associated with this request, or if the request does not have a session, creates one.
	`getSession(boolean create)` Returns the current`HttpSession` associated with this request or, if if there is no current session and`create` is true, returns a new session.
	`getUserPrincipal()` Returns a`java.security.Principal` object containing the name of the current authenticated user.
	`isRequestedSessionIdFromCookie()` Checks whether the requested session ID came in as a cookie.
	`isRequestedSessionIdFromUrl()` Deprecated. As of Version 2.1 of the Java ServletAPI, use`isRequestedSessionIdFromURL()`instead.
	`isRequestedSessionIdFromURL()` Checks whether the requested session ID came in as part of the request URL.
	`isRequestedSessionIdValid()` Checks whether the requested session ID is still valid.
	`isUserInRole(java.lang.String role)` Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Methods inherited from interface javax.servlet.ServletRequest

getAttribute,getAttributeNames,getCharacterEncoding,getContentLength,getContentType,getInputStream,getLocale,getLocales,getParameter,getParameterMap,getParameterNames,getParameterValues,getProtocol,getReader,getRealPath,getRemoteAddr,getRemoteHost,getRequestDispatcher,getScheme,getServerName,getServerPort,isSecure,removeAttribute,setAttribute,setCharacterEncoding

BASIC_AUTH

public static final java.lang.StringBASIC_AUTH

String identifier for Basic authentication. Value "BASIC"

FORM_AUTH

public static final java.lang.StringFORM_AUTH

String identifier for Basic authentication. Value "FORM"

CLIENT_CERT_AUTH

public static final java.lang.StringCLIENT_CERT_AUTH

String identifier for Basic authentication. Value "CLIENT_CERT"

DIGEST_AUTH

public static final java.lang.StringDIGEST_AUTH

String identifier for Basic authentication. Value "DIGEST"

getAuthType

public java.lang.StringgetAuthType()

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 authenticatednull is returned.

Same as the value of the CGI variable AUTH_TYPE.

Returns:: one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH(suitable for == comparison) indicating the authentication scheme, ornull if the request was not authenticated.

getCookies

publicCookie[]getCookies()

Returns an array containing all of theCookie objects the client sent with this request. This method returnsnull if no cookies were sent.

Returns:: an array of all theCookiesincluded with this request, ornullif the request has no cookies

getDateHeader

public longgetDateHeader(java.lang.String name)

Returns the value of the specified request header as along value that represents aDate object. Use this method with headers that contain dates, such asIf-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 anIllegalArgumentException.

Parameters:: name - aString specifying thename of the header
Returns:: along valuerepresenting the date specifiedin the header expressed asthe number of millisecondssince January 1, 1970 GMT,or -1 if the named headerwas not included with thereqest
Throws:: java.lang.IllegalArgumentException - If the header valuecan't be convertedto a date

getHeader

public java.lang.StringgetHeader(java.lang.String name)

Returns the value of the specified request header as aString. If the request did not include a header of the specified name, this method returnsnull. The header name is case insensitive. You can use this method with any request header.

Parameters:: name - aString specifying theheader name
Returns:: aString containing thevalue of the requestedheader, ornullif the request does nothave a header of that name

getHeaders

public java.util.EnumerationgetHeaders(java.lang.String name)

Returns all the values of the specified request header as anEnumeration ofString objects.

Some headers, such asAccept-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 emptyEnumeration. The header name is case insensitive. You can use this method with any request header.

Parameters:: name - aString specifying theheader name
Returns:: anEnumeration containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null

getHeaderNames

public java.util.EnumerationgetHeaderNames()

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 do not allow servlets to access headers using this method, in which case this method returnsnull

Returns:: 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

getIntHeader

public intgetIntHeader(java.lang.String name)

Returns the value of the specified request header as anint. 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 aNumberFormatException.

The header name is case insensitive.

Parameters:: name - aString specifying the nameof a request header
Returns:: an integer expressing the value of the request header or -1if the request doesn't have aheader of this name
Throws:: java.lang.NumberFormatException - If the header valuecan't be convertedto anint

getMethod

public java.lang.StringgetMethod()

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.

Returns:: aString specifying the nameof the method with whichthis request was made

getPathInfo

public java.lang.StringgetPathInfo()

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. This method returnsnull if there was no extra path information.

Same as the value of the CGI variable PATH_INFO.

Returns:: aString, decoded by theweb container, specifying extra path information that comesafter the servlet path but beforethe query string in the request URL;ornull if the URL does not haveany extra path information

getPathTranslated

public java.lang.StringgetPathTranslated()

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 returnsnull. The web container does not decode thins string.

Returns:: aString specifying thereal path, ornull ifthe URL does not have any extra pathinformation

getContextPath

public java.lang.StringgetContextPath()

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.

Returns:: aString specifying theportion of the request URI that indicates the contextof the request

getQueryString

public java.lang.StringgetQueryString()

Returns the query string that is contained in the request URL after the path. This method returnsnull if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.

Returns:: aString containing the querystring ornull if the URL contains no query string. The value is notdecoded by the container.

getRemoteUser

public java.lang.StringgetRemoteUser()

Returns the login of the user making this request, if the user has been authenticated, ornull 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.

Returns:: aString specifying the loginof the user making this request, ornull

isUserInRole
public booleanisUserInRole(java.lang.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 returnsfalse.
Parameters:
role - aString specifying the nameof the role
Returns:
aboolean indicating whetherthe user making this request belongs to a given role;false if the user has not been authenticated
getUserPrincipal
public java.security.PrincipalgetUserPrincipal()
Returns ajava.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull.
Returns:
ajava.security.Principal containingthe name of the user making this request;null if the user has not been authenticated
getRequestedSessionId
public java.lang.StringgetRequestedSessionId()
Returns the session ID specified by the client. This may not be the same as the ID of the actual session in use. For example, if the request specified an old (expired) session ID and the server has started a new session, this method gets a new session with a new ID. If the request did not specify a session ID, this method returnsnull.
Returns:
aString specifying the sessionID, ornull if the request didnot specify a session ID
See Also:
isRequestedSessionIdValid()
getRequestURI
public java.lang.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. 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, useHttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest).
Returns:
aString containingthe part of the URL from the protocol name up to the query string
See Also:
HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)
getRequestURL
public java.lang.StringBuffergetRequestURL()
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 aStringBuffer, 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.
Returns:
aStringBuffer object containingthe reconstructed URL
getServletPath
public java.lang.StringgetServletPath()
Returns the part of this request's URL that calls the servlet. This 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.
Returns:
aString containingthe name or path of the servlet beingcalled, as specified in the request URL,decoded.
getSession
publicHttpSessiongetSession(boolean create)
Returns the currentHttpSession associated with this request or, if if there is no current session andcreate is true, returns  a new session.Ifcreate isfalse and the request has no validHttpSession, this method returnsnull.
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:
true - to createa new session for this request if necessary;false to returnnullif there's no current session
Returns:
theHttpSession associated with this request ornull ifcreate isfalseand the request has no valid session
See Also:
getSession()
getSession
publicHttpSessiongetSession()
Returns the current session associated with this request, or if the request does not have a session, creates one.
Returns:
theHttpSession associatedwith this request
See Also:
getSession(boolean)
isRequestedSessionIdValid
public booleanisRequestedSessionIdValid()
Checks whether the requested session ID is still valid.
Returns:
true if thisrequest has an id for a valid sessionin the current session context;false otherwise
See Also:
getRequestedSessionId(),getSession(boolean),HttpSessionContext
isRequestedSessionIdFromCookie
public booleanisRequestedSessionIdFromCookie()
Checks whether the requested session ID came in as a cookie.
Returns:
true if the session IDcame in as acookie; otherwise,false
See Also:
getSession(boolean)
isRequestedSessionIdFromURL
public booleanisRequestedSessionIdFromURL()
Checks whether the requested session ID came in as part of the  request URL.
Returns:
true if the session IDcame in as part of a URL; otherwise,false
See Also:
getSession(boolean)
isRequestedSessionIdFromUrl
public booleanisRequestedSessionIdFromUrl()
Deprecated. As of Version 2.1 of the Java ServletAPI, useisRequestedSessionIdFromURL()instead.
                
  


[8]ページ先頭

©2009-2025 Movatter.jp

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