org.eclipse.jetty.server
类 ServletRequestHttpWrapper

java.lang.Object
  javax.servlet.ServletRequestWrapper
      org.eclipse.jetty.server.ServletRequestHttpWrapper

所有已实现的接口：

HttpServletRequest, ServletRequest

public class ServletRequestHttpWrapper
extends ServletRequestWrapper
implements HttpServletRequest

Class to tunnel a ServletRequest via a HttpServletRequest

字段摘要

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

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

构造方法摘要

ServletRequestHttpWrapper(ServletRequest request)

方法摘要

boolean	authenticate(HttpServletResponse response) Use the container login mechanism configured for the ServletContext to authenticate the user making this request.
String	getAuthType() Returns the name of the authentication scheme used to protect the servlet.
String	getContextPath() Returns the portion of the request URI that indicates the context of the request.
Cookie[]	getCookies() Returns an array containing all of the Cookie objects the client sent with this request.
long	getDateHeader(String name) Returns the value of the specified request header as a long value that represents a Date object.
String	getHeader(String name) Returns the value of the specified request header as a String.
Enumeration	getHeaderNames() Returns an enumeration of all the header names this request contains.
Enumeration	getHeaders(String name) Returns all the values of the specified request header as an Enumeration of String objects.
int	getIntHeader(String name) Returns the value of the specified request header as an int.
String	getMethod() Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.
Part	getPart(String name) Gets the Part with the given name.
Collection<Part>	getParts() Gets all the Part components of this request, provided that it is of type multipart/form-data.
String	getPathInfo() Returns any extra path information associated with the URL the client sent when it made this request.
String	getPathTranslated() Returns any extra path information after the servlet name but before the query string, and translates it to a real path.
String	getQueryString() Returns the query string that is contained in the request URL after the path.
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.
String	getRequestedSessionId() Returns the session ID specified by the client.
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.
StringBuffer	getRequestURL() Reconstructs the URL the client used to make the request.
String	getServletPath() Returns the part of this request's URL that calls the servlet.
HttpSession	getSession() Returns the current session associated with this request, or if the request does not have a session, creates one.
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.
Principal	getUserPrincipal() Returns a java.security.Principal object containing the name of the current authenticated user.
boolean	isRequestedSessionIdFromCookie() Checks whether the requested session ID came in as a cookie.
boolean	isRequestedSessionIdFromUrl()
boolean	isRequestedSessionIdFromURL() Checks whether the requested session ID came in as part of the request URL.
boolean	isRequestedSessionIdValid() Checks whether the requested session ID is still valid.
boolean	isUserInRole(String role) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".
void	login(String username, 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.

从类 javax.servlet.ServletRequestWrapper 继承的方法

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

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

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

从接口 javax.servlet.ServletRequest 继承的方法

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

构造方法详细信息

ServletRequestHttpWrapper

public ServletRequestHttpWrapper(ServletRequest request)

方法详细信息

getAuthType

public String getAuthType()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getAuthType

返回：

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 Cookie[] getCookies()

从接口 HttpServletRequest 复制的描述

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

指定者：

接口 HttpServletRequest 中的 getCookies

返回：

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

getDateHeader

public long getDateHeader(String name)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getDateHeader

参数：

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

getHeader

public String getHeader(String name)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getHeader

参数：

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 Enumeration getHeaders(String name)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getHeaders

参数：

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 Enumeration getHeaderNames()

从接口 HttpServletRequest 复制的描述

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

指定者：

接口 HttpServletRequest 中的 getHeaderNames

返回：

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(String name)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getIntHeader

参数：

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

getMethod

public String getMethod()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getMethod

返回：

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

getPathInfo

public String getPathInfo()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getPathInfo

返回：

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

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getPathTranslated

返回：

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

getContextPath

public String getContextPath()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getContextPath

返回：

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

另请参见：

ServletContext.getContextPath()

getQueryString

public String getQueryString()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getQueryString

返回：

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 String getRemoteUser()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getRemoteUser

返回：

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

isUserInRole

public boolean isUserInRole(String role)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 isUserInRole

参数：

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 Principal getUserPrincipal()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getUserPrincipal

返回：

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

getRequestedSessionId

public String getRequestedSessionId()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getRequestedSessionId

返回：

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

另请参见：

HttpServletRequest.isRequestedSessionIdValid()

getRequestURI

public String getRequestURI()

从接口 HttpServletRequest 复制的描述

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

指定者：

接口 HttpServletRequest 中的 getRequestURI

返回：

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

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getRequestURL

返回：

a StringBuffer object containing the reconstructed URL

getServletPath

public String getServletPath()

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getServletPath

返回：

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 HttpSession getSession(boolean create)

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getSession

参数：

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

另请参见：

HttpServletRequest.getSession()

getSession

public HttpSession getSession()

从接口 HttpServletRequest 复制的描述

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

指定者：

接口 HttpServletRequest 中的 getSession

返回：

the HttpSession associated with this request

另请参见：

HttpServletRequest.getSession(boolean)

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

从接口 HttpServletRequest 复制的描述

Checks whether the requested session ID is still valid.

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

指定者：

接口 HttpServletRequest 中的 isRequestedSessionIdValid

返回：

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

另请参见：

HttpServletRequest.getRequestedSessionId(), HttpServletRequest.getSession(boolean), HttpSessionContext

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

从接口 HttpServletRequest 复制的描述

Checks whether the requested session ID came in as a cookie.

指定者：

接口 HttpServletRequest 中的 isRequestedSessionIdFromCookie

返回：

true if the session ID came in as a cookie; otherwise, false

另请参见：

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

从接口 HttpServletRequest 复制的描述

Checks whether the requested session ID came in as part of the request URL.

指定者：

接口 HttpServletRequest 中的 isRequestedSessionIdFromURL

返回：

true if the session ID came in as part of a URL; otherwise, false

另请参见：

HttpServletRequest.getSession(boolean)

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

指定者：

接口 HttpServletRequest 中的 isRequestedSessionIdFromUrl

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
                            ServletException

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 authenticate

参数：

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.

抛出：

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

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)

另请参见：

HttpServletRequest.authenticate(javax.servlet.http.HttpServletResponse)

getPart

public Part getPart(String name)
             throws IOException,
                    ServletException

从接口 HttpServletRequest 复制的描述

Gets the Part with the given name.

指定者：

接口 HttpServletRequest 中的 getPart

参数：

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

抛出：

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

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

另请参见：

HttpServletRequest.getPart(java.lang.String)

getParts

public Collection<Part> getParts()
                          throws IOException,
                                 ServletException

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 getParts

返回：

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

抛出：

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

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

另请参见：

HttpServletRequest.getParts()

login

public void login(String username,
                  String password)
           throws ServletException

从接口 HttpServletRequest 复制的描述

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.

指定者：

接口 HttpServletRequest 中的 login

参数：

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

password - The password String corresponding to the identified user.

抛出：

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.

另请参见：

HttpServletRequest.login(java.lang.String, java.lang.String)

logout

public void logout()
            throws ServletException

从接口 HttpServletRequest 复制的描述

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

指定者：

接口 HttpServletRequest 中的 logout

抛出：

ServletException - if logout fails

另请参见：

HttpServletRequest.logout()