程序包 cn.taketoday.http.server

类 ServletServerHttpRequest

java.lang.Object

cn.taketoday.http.server.ServletServerHttpRequest

所有已实现的接口:

HttpInputMessage, HttpMessage, HttpRequest, ServerHttpRequest

public class ServletServerHttpRequest
extends Object
implements ServerHttpRequest

ServerHttpRequest implementation that is based on a HttpServletRequest.

从以下版本开始:

3.0

作者:

Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private ServerHttpAsyncRequestControl	asyncRequestControl
protected static final Charset	FORM_CHARSET
private HttpHeaders	headers
private final HttpMethod	method
private final HttpServletRequest	servletRequest
private URI	uri

构造器概要

构造器

构造器	说明
ServletServerHttpRequest(HttpServletRequest servletRequest)	Construct a new instance of the ServletServerHttpRequest based on the given HttpServletRequest.

方法概要

修饰符和类型	方法	说明
ServerHttpAsyncRequestControl	getAsyncRequestControl(ServerHttpResponse response)	Return a control that allows putting the request in asynchronous mode so the response remains open until closed explicitly from the current or another thread.
InputStream	getBody()	Return the body of the message as an input stream.
private static InputStream	getBodyFromServletRequestParameters(HttpServletRequest request)	Use ServletRequest.getParameterMap() to reconstruct the body of a form 'POST' providing a predictable outcome as opposed to reading from the body, which can fail if any other code has used the ServletRequest to access a parameter, thus causing the input stream to be "consumed".
HttpHeaders	getHeaders()	Return the headers of this message.
InetSocketAddress	getLocalAddress()	Return the address on which the request was received.
HttpMethod	getMethod()	Return the HTTP method of the request.
Principal	getPrincipal()	Return a Principal instance containing the name of the authenticated user.
InetSocketAddress	getRemoteAddress()	Return the address of the remote client.
HttpServletRequest	getServletRequest()	Returns the HttpServletRequest this object is based on.
URI	getURI()	Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).
static URI	initURI(HttpServletRequest servletRequest)	Initialize a URI from the given Servlet request.

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

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

从接口继承的方法 cn.taketoday.http.HttpRequest

getMethodValue

字段详细资料

FORM_CHARSET

protected static final Charset FORM_CHARSET

servletRequest

private final HttpServletRequest servletRequest

uri

@Nullable
private URI uri

headers

@Nullable
private HttpHeaders headers

asyncRequestControl

@Nullable
private ServerHttpAsyncRequestControl asyncRequestControl

method

private final HttpMethod method

构造器详细资料

ServletServerHttpRequest

public ServletServerHttpRequest(HttpServletRequest servletRequest)

Construct a new instance of the ServletServerHttpRequest based on the given HttpServletRequest.

参数:

servletRequest - the servlet request

方法详细资料

getServletRequest

public HttpServletRequest getServletRequest()

Returns the HttpServletRequest this object is based on.

getMethod

public HttpMethod getMethod()

从接口复制的说明: HttpRequest

Return the HTTP method of the request.

指定者:

getMethod 在接口中 HttpRequest

返回:

the HTTP method as an HttpMethod value

另请参阅:

• HttpMethod.resolve(String)

getURI

public URI getURI()

从接口复制的说明: HttpRequest

Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

指定者:

getURI 在接口中 HttpRequest

返回:

the URI of the request (never null)

initURI

public static URI initURI(HttpServletRequest servletRequest)

Initialize a URI from the given Servlet request.

参数:

servletRequest - the request

返回:

the initialized URI

getHeaders

public HttpHeaders getHeaders()

从接口复制的说明: HttpMessage

Return the headers of this message.

指定者:

getHeaders 在接口中 HttpMessage

返回:

a corresponding HttpHeaders object (never null)

getPrincipal

public Principal getPrincipal()

从接口复制的说明: ServerHttpRequest

Return a Principal instance containing the name of the authenticated user.

If the user has not been authenticated, the method returns null.

指定者:

getPrincipal 在接口中 ServerHttpRequest

getLocalAddress

public InetSocketAddress getLocalAddress()

从接口复制的说明: ServerHttpRequest

Return the address on which the request was received.

指定者:

getLocalAddress 在接口中 ServerHttpRequest

getRemoteAddress

public InetSocketAddress getRemoteAddress()

从接口复制的说明: ServerHttpRequest

Return the address of the remote client.

指定者:

getRemoteAddress 在接口中 ServerHttpRequest

getBody

public InputStream getBody()
                    throws IOException

从接口复制的说明: HttpInputMessage

Return the body of the message as an input stream.

指定者:

getBody 在接口中 HttpInputMessage

返回:

the input stream body (never null)

抛出:

IOException - in case of I/O errors

getAsyncRequestControl

public ServerHttpAsyncRequestControl getAsyncRequestControl(ServerHttpResponse response)

从接口复制的说明: ServerHttpRequest

Return a control that allows putting the request in asynchronous mode so the response remains open until closed explicitly from the current or another thread.

指定者:

getAsyncRequestControl 在接口中 ServerHttpRequest

getBodyFromServletRequestParameters

private static InputStream getBodyFromServletRequestParameters(HttpServletRequest request)
                                                        throws IOException

Use ServletRequest.getParameterMap() to reconstruct the body of a form 'POST' providing a predictable outcome as opposed to reading from the body, which can fail if any other code has used the ServletRequest to access a parameter, thus causing the input stream to be "consumed".

抛出:

IOException