cn.imaq.tompuss.servlet

类 TPHttpServletRequest

java.lang.Object

cn.imaq.tompuss.servlet.TPHttpServletRequest

所有已实现的接口:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class TPHttpServletRequest
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest

字段概要

从接口继承的字段 javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

构造器概要

构造器

构造器和说明
TPHttpServletRequest(cn.imaq.autumn.http.protocol.AutumnHttpRequest httpRequest, TPServletContext context, TPHttpExchange exchange)

方法概要

限定符和类型	方法和说明
boolean	authenticate(javax.servlet.http.HttpServletResponse response) Use the container login mechanism configured for the ServletContext to authenticate the user making this request.
java.lang.String	changeSessionId() Change the session id of the current session associated with this request and return the new session id.
javax.servlet.AsyncContext	getAsyncContext() Gets the AsyncContext that was created or reinitialized by the most recent invocation of startAsync() or startAsync(ServletRequest, ServletResponse) on this request.
java.lang.Object	getAttribute(java.lang.String name) Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.
java.util.Enumeration<java.lang.String>	getAttributeNames() Returns an Enumeration containing the names of the attributes available to this request.
java.lang.String	getAuthType() Returns the name of the authentication scheme used to protect the servlet.
java.lang.String	getCharacterEncoding() Returns the name of the character encoding used in the body of this request.
int	getContentLength() Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE.
long	getContentLengthLong() Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.
java.lang.String	getContentType() Returns the MIME type of the body of the request, or null if the type is not known.
java.lang.String	getContextPath() Returns the portion of the request URI that indicates the context of the request.
javax.servlet.http.Cookie[]	getCookies() Returns an array containing all of the Cookie objects the client sent with this request.
long	getDateHeader(java.lang.String name) Returns the value of the specified request header as a long value that represents a Date object.
javax.servlet.DispatcherType	getDispatcherType() Gets the dispatcher type of this request.
java.lang.String	getHeader(java.lang.String name) Returns the value of the specified request header as a String.
java.util.Enumeration<java.lang.String>	getHeaderNames() Returns an enumeration of all the header names this request contains.
java.util.Enumeration<java.lang.String>	getHeaders(java.lang.String name) Returns all the values of the specified request header as an Enumeration of String objects.
javax.servlet.ServletInputStream	getInputStream() Retrieves the body of the request as binary data using a ServletInputStream.
int	getIntHeader(java.lang.String name) Returns the value of the specified request header as an int.
java.lang.String	getLocalAddr() Returns the Internet Protocol (IP) address of the interface on which the request was received.
java.util.Locale	getLocale() Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
java.util.Enumeration<java.util.Locale>	getLocales() Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.
java.lang.String	getLocalName() Returns the host name of the Internet Protocol (IP) interface on which the request was received.
int	getLocalPort() Returns the Internet Protocol (IP) port number of the interface on which the request was received.
java.lang.String	getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
java.lang.String	getParameter(java.lang.String name) Returns the value of a request parameter as a String, or null if the parameter does not exist.
java.util.Map<java.lang.String,java.lang.String[]>	getParameterMap() Returns a java.util.Map of the parameters of this request.
java.util.Enumeration<java.lang.String>	getParameterNames() Returns an Enumeration of String objects containing the names of the parameters contained in this request.
java.lang.String[]	getParameterValues(java.lang.String name) Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.
javax.servlet.http.Part	getPart(java.lang.String name) Gets the Part with the given name.
java.util.Collection<javax.servlet.http.Part>	getParts() Gets all the Part components of this request, provided that it is of type multipart/form-data.
java.lang.String	getPathInfo() Returns any extra path information associated with the URL the client sent when it made this request.
java.lang.String	getPathTranslated() Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
java.lang.String	getProtocol() Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.
java.lang.String	getQueryString() Returns the query string that is contained in the request URL after the path.
java.io.BufferedReader	getReader() Retrieves the body of the request as character data using a BufferedReader.
java.lang.String	getRealPath(java.lang.String path) 已过时。 As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead.
java.lang.String	getRemoteAddr() Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
java.lang.String	getRemoteHost() Returns the fully qualified name of the client or the last proxy that sent the request.
int	getRemotePort() Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
java.lang.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.
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String path) Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
java.lang.String	getRequestedSessionId() Returns the session ID specified by the client.
java.lang.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.
java.lang.StringBuffer	getRequestURL() Reconstructs the URL the client used to make the request.
java.lang.String	getScheme() Returns the name of the scheme used to make this request, for example, http, https, or ftp.
java.lang.String	getServerName() Returns the host name of the server to which the request was sent.
int	getServerPort() Returns the port number to which the request was sent.
javax.servlet.ServletContext	getServletContext() Gets the servlet context to which this ServletRequest was last dispatched.
java.lang.String	getServletPath() Returns the part of this request's URL that calls the servlet.
javax.servlet.http.HttpSession	getSession() Returns the current session associated with this request, or if the request does not have a session, creates one.
javax.servlet.http.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.
java.security.Principal	getUserPrincipal() Returns a java.security.Principal object containing the name of the current authenticated user.
boolean	isAsyncStarted() Checks if this request has been put into asynchronous mode.
boolean	isAsyncSupported() Checks if this request supports asynchronous operation.
boolean	isRequestedSessionIdFromCookie() Checks whether the requested session ID was conveyed to the server as an HTTP cookie.
boolean	isRequestedSessionIdFromUrl() 已过时。 As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL() instead.
boolean	isRequestedSessionIdFromURL() Checks whether the requested session ID was conveyed to the server as part of the request URL.
boolean	isRequestedSessionIdValid() Checks whether the requested session ID is still valid.
boolean	isSecure() Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
boolean	isUserInRole(java.lang.String role) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
void	login(java.lang.String username, java.lang.String password) Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.
void	logout() Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.
void	removeAttribute(java.lang.String name) Removes an attribute from this request.
void	setAttribute(java.lang.String name, java.lang.Object o) Stores an attribute in this request.
void	setCharacterEncoding(java.lang.String env) Overrides the name of the character encoding used in the body of this request.
javax.servlet.AsyncContext	startAsync() Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest and ServletResponse objects.
javax.servlet.AsyncContext	startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects.
<T extends javax.servlet.http.HttpUpgradeHandler> T	upgrade(java.lang.Class<T> handlerClass) Creates an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade processing.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 javax.servlet.http.HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

构造器详细资料

TPHttpServletRequest

public TPHttpServletRequest(cn.imaq.autumn.http.protocol.AutumnHttpRequest httpRequest,
                            TPServletContext context,
                            TPHttpExchange exchange)

方法详细资料

getAuthType

public java.lang.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.

指定者:

getAuthType 在接口中 javax.servlet.http.HttpServletRequest

返回:

one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH (suitable for == comparison) or the container-specific string indicating the authentication scheme, or null if the request was not authenticated.

getCookies

public javax.servlet.http.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.

指定者:

getCookies 在接口中 javax.servlet.http.HttpServletRequest

返回:

an array of all the Cookies included with this request, or null if the request has no cookies

getDateHeader

public long getDateHeader(java.lang.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.

指定者:

getDateHeader 在接口中 javax.servlet.http.HttpServletRequest

参数:

name - a String specifying the name of the header

返回:

a long value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request

抛出:

java.lang.IllegalArgumentException - If the header value can't be converted to a date

getHeader

public java.lang.String getHeader(java.lang.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.

指定者:

getHeader 在接口中 javax.servlet.http.HttpServletRequest

参数:

name - a String specifying the header name

返回:

a String containing the value of the requested header, or null if the request does not have a header of that name

getHeaders

public java.util.Enumeration<java.lang.String> getHeaders(java.lang.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.

指定者:

getHeaders 在接口中 javax.servlet.http.HttpServletRequest

参数:

name - a String specifying the header name

返回:

an Enumeration 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.Enumeration<java.lang.String> 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

指定者:

getHeaderNames 在接口中 javax.servlet.http.HttpServletRequest

返回:

an enumeration of all the header names sent with this request; if the request has no headers, an empty enumeration; if the servlet container does not allow servlets to use this method, null

getIntHeader

public int getIntHeader(java.lang.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.

指定者:

getIntHeader 在接口中 javax.servlet.http.HttpServletRequest

参数:

name - a String specifying the name of a request header

返回:

an integer expressing the value of the request header or -1 if the request doesn't have a header of this name

抛出:

java.lang.NumberFormatException - If the header value can't be converted to an int

getMethod

public java.lang.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.

指定者:

getMethod 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String specifying the name of the method with which this request was made

getPathInfo

public java.lang.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.

指定者:

getPathInfo 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; or null if the URL does not have any extra path information

getPathTranslated

public java.lang.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.

指定者:

getPathTranslated 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String specifying the real path, or null if the URL does not have any extra path information

getContextPath

public java.lang.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.

It is possible that a servlet container may match a context by more than one context path. In such cases this method will return the actual context path used by the request and it may differ from the path returned by the ServletContext.getContextPath() method. The context path returned by ServletContext.getContextPath() should be considered as the prime or preferred context path of the application.

指定者:

getContextPath 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String specifying the portion of the request URI that indicates the context of the request

另请参阅:

ServletContext.getContextPath()

getQueryString

public java.lang.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.

指定者:

getQueryString 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String containing the query string or null if the URL contains no query string. The value is not decoded by the container.

getRemoteUser

public java.lang.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.

指定者:

getRemoteUser 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String specifying the login of the user making this request, or null if the user login is not known

isUserInRole

public boolean isUserInRole(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 returns false.

The role name "*" should never be used as an argument in calling isUserInRole. Any call to isUserInRole with "*" must return false. If the role-name of the security-role to be tested is "**", and the application has NOT declared an application security-role with role-name "**", isUserInRole must only return true if the user has been authenticated; that is, only when getRemoteUser() and getUserPrincipal() would both return a non-null value. Otherwise, the container must check the user for membership in the application role.

指定者:

isUserInRole 在接口中 javax.servlet.http.HttpServletRequest

参数:

role - a String specifying the name of the role

返回:

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated

getUserPrincipal

public java.security.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.

指定者:

getUserPrincipal 在接口中 javax.servlet.http.HttpServletRequest

返回:

a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated

getRequestedSessionId

public java.lang.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.

指定者:

getRequestedSessionId 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String specifying the session ID, or null if the request did not specify a session ID

另请参阅:

isRequestedSessionIdValid()

getRequestURI

public java.lang.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(javax.servlet.http.HttpServletRequest).

指定者:

getRequestURI 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String containing the part of the URL from the protocol name up to the query string

另请参阅:

HttpUtils.getRequestURL(javax.servlet.http.HttpServletRequest)

getRequestURL

public java.lang.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.

If this request has been forwarded using RequestDispatcher.forward(javax.servlet.ServletRequest, javax.servlet.ServletResponse), the server path in the reconstructed URL must reflect the path used to obtain the RequestDispatcher, and not the server path specified by the client.

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.

指定者:

getRequestURL 在接口中 javax.servlet.http.HttpServletRequest

返回:

a StringBuffer object containing the reconstructed URL

getServletPath

public java.lang.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.

指定者:

getServletPath 在接口中 javax.servlet.http.HttpServletRequest

返回:

a String containing the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.

getSession

public javax.servlet.http.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.

指定者:

getSession 在接口中 javax.servlet.http.HttpServletRequest

参数:

create - true to create a new session for this request if necessary; false to return null if there's no current session

返回:

the HttpSession associated with this request or null if create is false and the request has no valid session

另请参阅:

getSession()

getSession

public javax.servlet.http.HttpSession getSession()

Returns the current session associated with this request, or if the request does not have a session, creates one.

指定者:

getSession 在接口中 javax.servlet.http.HttpServletRequest

返回:

the HttpSession associated with this request

另请参阅:

getSession(boolean)

changeSessionId

public java.lang.String changeSessionId()

Change the session id of the current session associated with this request and return the new session id.

指定者:

changeSessionId 在接口中 javax.servlet.http.HttpServletRequest

返回:

the new session id

抛出:

java.lang.IllegalStateException - if there is no session associated with the request

从以下版本开始:

Servlet 3.1

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Checks whether the requested session ID is still valid.

If the client did not specify any session ID, this method returns false.

指定者:

isRequestedSessionIdValid 在接口中 javax.servlet.http.HttpServletRequest

返回:

true if this request has an id for a valid session in the current session context; false otherwise

另请参阅:

getRequestedSessionId(), getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Checks whether the requested session ID was conveyed to the server as an HTTP cookie.

指定者:

isRequestedSessionIdFromCookie 在接口中 javax.servlet.http.HttpServletRequest

返回:

true if the session ID was conveyed to the server an an HTTP cookie; otherwise, false

另请参阅:

getSession(boolean)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Checks whether the requested session ID was conveyed to the server as part of the request URL.

指定者:

isRequestedSessionIdFromURL 在接口中 javax.servlet.http.HttpServletRequest

返回:

true if the session ID was conveyed to the server as part of a URL; otherwise, false

另请参阅:

getSession(boolean)

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

已过时。 As of Version 2.1 of the Java Servlet API, use isRequestedSessionIdFromURL() instead.

指定者:

isRequestedSessionIdFromUrl 在接口中 javax.servlet.http.HttpServletRequest

返回:

true if the session ID was conveyed to the server as part of a URL; otherwise, false

authenticate

public boolean authenticate(javax.servlet.http.HttpServletResponse response)
                     throws java.io.IOException,
                            javax.servlet.ServletException

Use the container login mechanism configured for the ServletContext to authenticate the user making this request.

This method may modify and commit the argument HttpServletResponse.

指定者:

authenticate 在接口中 javax.servlet.http.HttpServletRequest

参数:

response - The HttpServletResponse associated with this HttpServletRequest

返回:

true when non-null values were or have been established as the values returned by getUserPrincipal, getRemoteUser, and getAuthType. Return false if authentication is incomplete and the underlying login mechanism has committed, in the response, the message (e.g., challenge) and HTTP status code to be returned to the user.

抛出:

java.io.IOException - if an input or output error occurred while reading from this request or writing to the given response

java.lang.IllegalStateException - if the login mechanism attempted to modify the response and it was already committed

javax.servlet.ServletException - if the authentication failed and the caller is responsible for handling the error (i.e., the underlying login mechanism did NOT establish the message and HTTP status code to be returned to the user)

从以下版本开始:

Servlet 3.0

login

public void login(java.lang.String username,
                  java.lang.String password)
           throws javax.servlet.ServletException

Validate the provided username and password in the password validation realm used by the web container login mechanism configured for the ServletContext.

This method returns without throwing a ServletException when the login mechanism configured for the ServletContext supports username password validation, and when, at the time of the call to login, the identity of the caller of the request had not been established (i.e, all of getUserPrincipal, getRemoteUser, and getAuthType return null), and when validation of the provided credentials is successful. Otherwise, this method throws a ServletException as described below.

When this method returns without throwing an exception, it must have established non-null values as the values returned by getUserPrincipal, getRemoteUser, and getAuthType.

指定者:

login 在接口中 javax.servlet.http.HttpServletRequest

参数:

username - The String value corresponding to the login identifier of the user.

password - The password String corresponding to the identified user.

抛出:

javax.servlet.ServletException - if the configured login mechanism does not support username password authentication, or if a non-null caller identity had already been established (prior to the call to login), or if validation of the provided username and password fails.

从以下版本开始:

Servlet 3.0

logout

public void logout()
            throws javax.servlet.ServletException

Establish null as the value returned when getUserPrincipal, getRemoteUser, and getAuthType is called on the request.

指定者:

logout 在接口中 javax.servlet.http.HttpServletRequest

抛出:

javax.servlet.ServletException - if logout fails

从以下版本开始:

Servlet 3.0

getParts

public java.util.Collection<javax.servlet.http.Part> getParts()
                                                       throws java.io.IOException,
                                                              javax.servlet.ServletException

Gets all the Part components of this request, provided that it is of type multipart/form-data.

If this request is of type multipart/form-data, but does not contain any Part components, the returned Collection will be empty.

Any changes to the returned Collection must not affect this HttpServletRequest.

指定者:

getParts 在接口中 javax.servlet.http.HttpServletRequest

返回:

a (possibly empty) Collection of the Part components of this request

抛出:

java.io.IOException - if an I/O error occurred during the retrieval of the Part components of this request

javax.servlet.ServletException - if this request is not of type multipart/form-data

java.lang.IllegalStateException - if the request body is larger than maxRequestSize, or any Part in the request is larger than maxFileSize, or there is no @MultipartConfig or multipart-config in deployment descriptors

从以下版本开始:

Servlet 3.0

另请参阅:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

getPart

public javax.servlet.http.Part getPart(java.lang.String name)
                                throws java.io.IOException,
                                       javax.servlet.ServletException

Gets the Part with the given name.

指定者:

getPart 在接口中 javax.servlet.http.HttpServletRequest

参数:

name - the name of the requested Part

返回:

The Part with the given name, or null if this request is of type multipart/form-data, but does not contain the requested Part

抛出:

java.io.IOException - if an I/O error occurred during the retrieval of the requested Part

javax.servlet.ServletException - if this request is not of type multipart/form-data

java.lang.IllegalStateException - if the request body is larger than maxRequestSize, or any Part in the request is larger than maxFileSize, or there is no @MultipartConfig or multipart-config in deployment descriptors

从以下版本开始:

Servlet 3.0

另请参阅:

MultipartConfig.maxFileSize(), MultipartConfig.maxRequestSize()

upgrade

public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass)
                                                            throws java.io.IOException,
                                                                   javax.servlet.ServletException

Creates an instance of HttpUpgradeHandler for a given class and uses it for the http protocol upgrade processing.

指定者:

upgrade 在接口中 javax.servlet.http.HttpServletRequest

参数:

handlerClass - The HttpUpgradeHandler class used for the upgrade.

返回:

an instance of the HttpUpgradeHandler

抛出:

java.io.IOException - if an I/O error occurred during the upgrade

javax.servlet.ServletException - if the given handlerClass fails to be instantiated

从以下版本开始:

Servlet 3.1

另请参阅:

HttpUpgradeHandler, WebConnection

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Returns the value of the named attribute as an Object, or null if no attribute of the given name exists.

Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute javax.servlet.request.X509Certificate can be used to retrieve information on the certificate of the client. Attributes can also be set programatically using ServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be embedded into a request before a RequestDispatcher call.

Attribute names should follow the same conventions as package names. This specification reserves names matching java.*, javax.*, and sun.*.

指定者:

getAttribute 在接口中 javax.servlet.ServletRequest

参数:

name - a String specifying the name of the attribute

返回:

an Object containing the value of the attribute, or null if the attribute does not exist

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

指定者:

getAttributeNames 在接口中 javax.servlet.ServletRequest

返回:

an Enumeration of strings containing the names of the request's attributes

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Returns the name of the character encoding used in the body of this request. This method returns null if no request encoding character encoding has been specified. The following methods for specifying the request character encoding are consulted, in decreasing order of priority: per request, per web app (using ServletContext.setRequestCharacterEncoding(java.lang.String), deployment descriptor), and per container (for all web applications deployed in that container, using vendor specific configuration).

指定者:

getCharacterEncoding 在接口中 javax.servlet.ServletRequest

返回:

a String containing the name of the character encoding, or null if the request does not specify a character encoding

setCharacterEncoding

public void setCharacterEncoding(java.lang.String env)
                          throws java.io.UnsupportedEncodingException

Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader(). Otherwise, it has no effect.

指定者:

setCharacterEncoding 在接口中 javax.servlet.ServletRequest

参数:

env - String containing the name of the character encoding.

抛出:

java.io.UnsupportedEncodingException - if this ServletRequest is still in a state where a character encoding may be set, but the specified encoding is invalid

getContentLength

public int getContentLength()

Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known ir is greater than Integer.MAX_VALUE. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.

指定者:

getContentLength 在接口中 javax.servlet.ServletRequest

返回:

an integer containing the length of the request body or -1 if the length is not known or is greater than Integer.MAX_VALUE.

getContentLengthLong

public long getContentLengthLong()

Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.

指定者:

getContentLengthLong 在接口中 javax.servlet.ServletRequest

返回:

a long containing the length of the request body or -1L if the length is not known

从以下版本开始:

Servlet 3.1

getContentType

public java.lang.String getContentType()

Returns the MIME type of the body of the request, or null if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.

指定者:

getContentType 在接口中 javax.servlet.ServletRequest

返回:

a String containing the name of the MIME type of the request, or null if the type is not known

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Retrieves the body of the request as binary data using a ServletInputStream. Either this method or getReader() may be called to read the body, not both.

指定者:

getInputStream 在接口中 javax.servlet.ServletRequest

返回:

a ServletInputStream object containing the body of the request

抛出:

java.lang.IllegalStateException - if the getReader() method has already been called for this request

java.io.IOException - if an input or output exception occurred

getParameter

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

Returns the value of a request parameter as a String, or null if the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use getParameterValues(java.lang.String).

If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by getParameterValues.

If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via getInputStream() or getReader() can interfere with the execution of this method.

指定者:

getParameter 在接口中 javax.servlet.ServletRequest

参数:

name - a String specifying the name of the parameter

返回:

a String representing the single value of the parameter

另请参阅:

getParameterValues(java.lang.String)

getParameterNames

public java.util.Enumeration<java.lang.String> getParameterNames()

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

指定者:

getParameterNames 在接口中 javax.servlet.ServletRequest

返回:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String name)

Returns an array of String objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

指定者:

getParameterValues 在接口中 javax.servlet.ServletRequest

参数:

name - a String containing the name of the parameter whose value is requested

返回:

an array of String objects containing the parameter's values

另请参阅:

getParameter(java.lang.String)

getParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()

Returns a java.util.Map of the parameters of this request.

Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

指定者:

getParameterMap 在接口中 javax.servlet.ServletRequest

返回:

an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.

getProtocol

public java.lang.String getProtocol()

Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variable SERVER_PROTOCOL.

指定者:

getProtocol 在接口中 javax.servlet.ServletRequest

返回:

a String containing the protocol name and version number

getScheme

public java.lang.String getScheme()

Returns the name of the scheme used to make this request, for example, http, https, or ftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.

指定者:

getScheme 在接口中 javax.servlet.ServletRequest

返回:

a String containing the name of the scheme used to make this request

getServerName

public java.lang.String getServerName()

Returns the host name of the server to which the request was sent. It is the value of the part before ":" in the Host header value, if any, or the resolved server name, or the server IP address.

指定者:

getServerName 在接口中 javax.servlet.ServletRequest

返回:

a String containing the name of the server

getServerPort

public int getServerPort()

Returns the port number to which the request was sent. It is the value of the part after ":" in the Host header value, if any, or the server port where the client connection was accepted on.

指定者:

getServerPort 在接口中 javax.servlet.ServletRequest

返回:

an integer specifying the port number

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Retrieves the body of the request as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or getInputStream() may be called to read the body, not both.

指定者:

getReader 在接口中 javax.servlet.ServletRequest

返回:

a BufferedReader containing the body of the request

抛出:

java.io.UnsupportedEncodingException - if the character set encoding used is not supported and the text cannot be decoded

java.lang.IllegalStateException - if getInputStream() method has been called on this request

java.io.IOException - if an input or output exception occurred

另请参阅:

getInputStream()

getRemoteAddr

public java.lang.String getRemoteAddr()

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR.

指定者:

getRemoteAddr 在接口中 javax.servlet.ServletRequest

返回:

a String containing the IP address of the client that sent the request

getRemoteHost

public java.lang.String getRemoteHost()

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST.

指定者:

getRemoteHost 在接口中 javax.servlet.ServletRequest

返回:

a String containing the fully qualified name of the client

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object o)

Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction with RequestDispatcher.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.
If the object passed in is null, the effect is the same as calling removeAttribute(java.lang.String).
It is warned that when the request is dispatched from the servlet resides in a different web application by RequestDispatcher, the object set by this method may not be correctly retrieved in the caller servlet.

指定者:

setAttribute 在接口中 javax.servlet.ServletRequest

参数:

name - a String specifying the name of the attribute

o - the Object to be stored

removeAttribute

public void removeAttribute(java.lang.String name)

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.

Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.

指定者:

removeAttribute 在接口中 javax.servlet.ServletRequest

参数:

name - a String specifying the name of the attribute to remove

getLocale

public java.util.Locale getLocale()

Returns the preferred Locale that the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.

指定者:

getLocale 在接口中 javax.servlet.ServletRequest

返回:

the preferred Locale for the client

getLocales

public java.util.Enumeration<java.util.Locale> getLocales()

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns an Enumeration containing one Locale, the default locale for the server.

指定者:

getLocales 在接口中 javax.servlet.ServletRequest

返回:

an Enumeration of preferred Locale objects for the client

isSecure

public boolean isSecure()

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

指定者:

isSecure 在接口中 javax.servlet.ServletRequest

返回:

a boolean indicating if the request was made using a secure channel

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns null if the servlet container cannot return a RequestDispatcher.

The difference between this method and ServletContext.getRequestDispatcher(java.lang.String) is that this method can take a relative path.

指定者:

getRequestDispatcher 在接口中 javax.servlet.ServletRequest

参数:

path - a String specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.

返回:

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the servlet container cannot return a RequestDispatcher

另请参阅:

RequestDispatcher, ServletContext.getRequestDispatcher(java.lang.String)

getRealPath

public java.lang.String getRealPath(java.lang.String path)

已过时。 As of Version 2.1 of the Java Servlet API, use ServletContext.getRealPath(java.lang.String) instead.

指定者:

getRealPath 在接口中 javax.servlet.ServletRequest

参数:

path - the path for which the real path is to be returned.

返回:

the real path, or null if the translation cannot be performed.

getRemotePort

public int getRemotePort()

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.

指定者:

getRemotePort 在接口中 javax.servlet.ServletRequest

返回:

an integer specifying the port number

从以下版本开始:

Servlet 2.4

getLocalName

public java.lang.String getLocalName()

Returns the host name of the Internet Protocol (IP) interface on which the request was received.

指定者:

getLocalName 在接口中 javax.servlet.ServletRequest

返回:

a String containing the host name of the IP on which the request was received.

从以下版本开始:

Servlet 2.4

getLocalAddr

public java.lang.String getLocalAddr()

Returns the Internet Protocol (IP) address of the interface on which the request was received.

指定者:

getLocalAddr 在接口中 javax.servlet.ServletRequest

返回:

a String containing the IP address on which the request was received.

从以下版本开始:

Servlet 2.4

getLocalPort

public int getLocalPort()

Returns the Internet Protocol (IP) port number of the interface on which the request was received.

指定者:

getLocalPort 在接口中 javax.servlet.ServletRequest

返回:

an integer specifying the port number

从以下版本开始:

Servlet 2.4

getServletContext

public javax.servlet.ServletContext getServletContext()

Gets the servlet context to which this ServletRequest was last dispatched.

指定者:

getServletContext 在接口中 javax.servlet.ServletRequest

返回:

the servlet context to which this ServletRequest was last dispatched

从以下版本开始:

Servlet 3.0

startAsync

public javax.servlet.AsyncContext startAsync()
                                      throws java.lang.IllegalStateException

Puts this request into asynchronous mode, and initializes its AsyncContext with the original (unwrapped) ServletRequest and ServletResponse objects.

Calling this method will cause committal of the associated response to be delayed until AsyncContext.complete() is called on the returned AsyncContext, or the asynchronous operation has timed out.

Calling AsyncContext.hasOriginalRequestAndResponse() on the returned AsyncContext will return true. Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that any request and/or response wrappers that they added during their inbound invocation need not stay around for the duration of the asynchronous operation, and therefore any of their associated resources may be released.

This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method.

Subsequent invocations of this method, or its overloaded variant, will return the same AsyncContext instance, reinitialized as appropriate.

指定者:

startAsync 在接口中 javax.servlet.ServletRequest

返回:

the (re)initialized AsyncContext

抛出:

java.lang.IllegalStateException - if this request is within the scope of a filter or servlet that does not support asynchronous operations (that is, isAsyncSupported() returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the AsyncContext.dispatch() methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed

从以下版本开始:

Servlet 3.0

另请参阅:

AsyncContext.dispatch()

startAsync

public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest,
                                             javax.servlet.ServletResponse servletResponse)
                                      throws java.lang.IllegalStateException

Puts this request into asynchronous mode, and initializes its AsyncContext with the given request and response objects.

The ServletRequest and ServletResponse arguments must be the same instances, or instances of ServletRequestWrapper and ServletResponseWrapper that wrap them, that were passed to the service method of the Servlet or the doFilter method of the Filter, respectively, in whose scope this method is being called.

Calling this method will cause committal of the associated response to be delayed until AsyncContext.complete() is called on the returned AsyncContext, or the asynchronous operation has timed out.

Calling AsyncContext.hasOriginalRequestAndResponse() on the returned AsyncContext will return false, unless the passed in ServletRequest and ServletResponse arguments are the original ones or do not carry any application-provided wrappers. Any filters invoked in the outbound direction after this request was put into asynchronous mode may use this as an indication that some of the request and/or response wrappers that they added during their inbound invocation may need to stay in place for the duration of the asynchronous operation, and their associated resources may not be released. A ServletRequestWrapper applied during the inbound invocation of a filter may be released by the outbound invocation of the filter only if the given servletRequest, which is used to initialize the AsyncContext and will be returned by a call to AsyncContext.getRequest(), does not contain said ServletRequestWrapper. The same holds true for ServletResponseWrapper instances.

This method clears the list of AsyncListener instances (if any) that were registered with the AsyncContext returned by the previous call to one of the startAsync methods, after calling each AsyncListener at its onStartAsync method.

Subsequent invocations of this method, or its zero-argument variant, will return the same AsyncContext instance, reinitialized as appropriate. If a call to this method is followed by a call to its zero-argument variant, the specified (and possibly wrapped) request and response objects will remain locked in on the returned AsyncContext.

指定者:

startAsync 在接口中 javax.servlet.ServletRequest

参数:

servletRequest - the ServletRequest used to initialize the AsyncContext

servletResponse - the ServletResponse used to initialize the AsyncContext

返回:

the (re)initialized AsyncContext

抛出:

java.lang.IllegalStateException - if this request is within the scope of a filter or servlet that does not support asynchronous operations (that is, isAsyncSupported() returns false), or if this method is called again without any asynchronous dispatch (resulting from one of the AsyncContext.dispatch() methods), is called outside the scope of any such dispatch, or is called again within the scope of the same dispatch, or if the response has already been closed

从以下版本开始:

Servlet 3.0

isAsyncStarted

public boolean isAsyncStarted()

Checks if this request has been put into asynchronous mode.

A ServletRequest is put into asynchronous mode by calling startAsync() or startAsync(ServletRequest, ServletResponse) on it.

This method returns false if this request was put into asynchronous mode, but has since been dispatched using one of the AsyncContext.dispatch() methods or released from asynchronous mode via a call to AsyncContext.complete().

指定者:

isAsyncStarted 在接口中 javax.servlet.ServletRequest

返回:

true if this request has been put into asynchronous mode, false otherwise

从以下版本开始:

Servlet 3.0

isAsyncSupported

public boolean isAsyncSupported()

Checks if this request supports asynchronous operation.

Asynchronous operation is disabled for this request if this request is within the scope of a filter or servlet that has not been annotated or flagged in the deployment descriptor as being able to support asynchronous handling.

指定者:

isAsyncSupported 在接口中 javax.servlet.ServletRequest

返回:

true if this request supports asynchronous operation, false otherwise

从以下版本开始:

Servlet 3.0

getAsyncContext

public javax.servlet.AsyncContext getAsyncContext()

Gets the AsyncContext that was created or reinitialized by the most recent invocation of startAsync() or startAsync(ServletRequest, ServletResponse) on this request.

指定者:

getAsyncContext 在接口中 javax.servlet.ServletRequest

返回:

the AsyncContext that was created or reinitialized by the most recent invocation of startAsync() or startAsync(ServletRequest, ServletResponse) on this request

抛出:

java.lang.IllegalStateException - if this request has not been put into asynchronous mode, i.e., if neither startAsync() nor startAsync(ServletRequest, ServletResponse) has been called

从以下版本开始:

Servlet 3.0

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

Gets the dispatcher type of this request.

The dispatcher type of a request is used by the container to select the filters that need to be applied to the request: Only filters with matching dispatcher type and url patterns will be applied.

Allowing a filter that has been configured for multiple dispatcher types to query a request for its dispatcher type allows the filter to process the request differently depending on its dispatcher type.

The initial dispatcher type of a request is defined as DispatcherType.REQUEST. The dispatcher type of a request dispatched via RequestDispatcher.forward(ServletRequest, ServletResponse) or RequestDispatcher.include(ServletRequest, ServletResponse) is given as DispatcherType.FORWARD or DispatcherType.INCLUDE, respectively, while the dispatcher type of an asynchronous request dispatched via one of the AsyncContext.dispatch() methods is given as DispatcherType.ASYNC. Finally, the dispatcher type of a request dispatched to an error page by the container's error handling mechanism is given as DispatcherType.ERROR.

指定者:

getDispatcherType 在接口中 javax.servlet.ServletRequest

返回:

the dispatcher type of this request

从以下版本开始:

Servlet 3.0

另请参阅:

DispatcherType