程序包 cn.taketoday.web.handler.function

类 DefaultServerRequestBuilder.BuiltServerRequest

java.lang.Object

cn.taketoday.web.handler.function.DefaultServerRequestBuilder.BuiltServerRequest

所有已实现的接口:

ServerRequest, ServerResponse.Context

封闭类:

DefaultServerRequestBuilder

private static class DefaultServerRequestBuilder.BuiltServerRequest
extends Object
implements ServerRequest

嵌套类概要

嵌套类

修饰符和类型	类	说明
private class	DefaultServerRequestBuilder.BuiltServerRequest.BuiltInputMessage

从接口继承的嵌套类/接口 cn.taketoday.web.handler.function.ServerRequest

ServerRequest.Builder, ServerRequest.Headers

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private final byte[]	body
private final cn.taketoday.util.MultiValueMap<String,HttpCookie>	cookies
private final HttpHeaders	headers
private final List<HttpMessageConverter<?>>	messageConverters
private final HttpMethod	method
private final cn.taketoday.util.MultiValueMap<String,String>	params
private final InetSocketAddress	remoteAddress
private final RequestContext	requestContext
private final URI	uri

构造器概要

构造器

构造器	说明
BuiltServerRequest(RequestContext requestContext, HttpMethod method, URI uri, HttpHeaders headers, cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies, Map<String,Object> attributes, cn.taketoday.util.MultiValueMap<String,String> params, InetSocketAddress remoteAddress, byte[] body, List<HttpMessageConverter<?>> messageConverters)

方法概要

修饰符和类型	方法	说明
Map<String,Object>	attributes()	Get a mutable map of request attributes.
<T> T	bind(Class<T> bindType, Consumer<WebDataBinder> dataBinderCustomizer)	Bind to this request and return an instance of the given type.
<T> T	body(cn.taketoday.core.ParameterizedTypeReference<T> bodyType)	Extract the body as an object of the given type.
<T> T	body(Class<T> bodyType)	Extract the body as an object of the given type.
private <T> T	bodyInternal(Type bodyType, Class<?> bodyClass)
cn.taketoday.util.MultiValueMap<String,HttpCookie>	cookies()	Get the cookies of this request.
RequestContext	exchange()	Get the request that this request is based on.
ServerRequest.Headers	headers()	Get the headers of this request.
List<HttpMessageConverter<?>>	messageConverters()	Get the readers used to convert the body of this request.
HttpMethod	method()	Get the HTTP method.
String	methodName()	Get the name of the HTTP method.
cn.taketoday.util.MultiValueMap<String,Multipart>	multipartData()	Get the parts of a multipart request, provided the Content-Type is "multipart/form-data", or an exception otherwise.
cn.taketoday.util.MultiValueMap<String,String>	params()	Get all parameters for this request. parameters are contained in the query string or posted form data.
Map<String,String>	pathVariables()	Get all path variables for this request.
Optional<InetSocketAddress>	remoteAddress()	Get the remote address to which this request is connected, if available.
URI	uri()	Get the request URI.
UriBuilder	uriBuilder()	Get a UriBuilderComponents from the URI associated with this ServerRequest.

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

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

从接口继承的方法 cn.taketoday.web.handler.function.ServerRequest

attribute, bind, checkNotModified, checkNotModified, checkNotModified, param, params, path, pathVariable, requestPath

字段详细资料

method

private final HttpMethod method

uri

private final URI uri

headers

private final HttpHeaders headers

requestContext

private final RequestContext requestContext

cookies

private final cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies

attributes

private final Map<String,Object> attributes

body

private final byte[] body

messageConverters

private final List<HttpMessageConverter<?>> messageConverters

params

private final cn.taketoday.util.MultiValueMap<String,String> params

remoteAddress

@Nullable
private final InetSocketAddress remoteAddress

构造器详细资料

BuiltServerRequest

public BuiltServerRequest(RequestContext requestContext,
 HttpMethod method,
 URI uri,
 HttpHeaders headers,
 cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies,
 Map<String,Object> attributes,
 cn.taketoday.util.MultiValueMap<String,String> params,
 @Nullable
 InetSocketAddress remoteAddress,
 byte[] body,
 List<HttpMessageConverter<?>> messageConverters)

方法详细资料

method

public HttpMethod method()

从接口复制的说明: ServerRequest

Get the HTTP method.

指定者:

method 在接口中 ServerRequest

返回:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

methodName

public String methodName()

从接口复制的说明: ServerRequest

Get the name of the HTTP method.

指定者:

methodName 在接口中 ServerRequest

返回:

the HTTP method as a String

multipartData

public cn.taketoday.util.MultiValueMap<String,Multipart> multipartData()
                                                                throws IOException

从接口复制的说明: ServerRequest

Get the parts of a multipart request, provided the Content-Type is "multipart/form-data", or an exception otherwise.

指定者:

multipartData 在接口中 ServerRequest

返回:

the multipart data, mapping from name to part(s)

抛出:

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

另请参阅:

• RequestContext.getMultipartRequest()
• MultipartRequest.multipartData()

uri

public URI uri()

从接口复制的说明: ServerRequest

Get the request URI.

指定者:

uri 在接口中 ServerRequest

uriBuilder

public UriBuilder uriBuilder()

从接口复制的说明: ServerRequest

Get a UriBuilderComponents from the URI associated with this ServerRequest.

指定者:

uriBuilder 在接口中 ServerRequest

返回:

a URI builder

headers

public ServerRequest.Headers headers()

从接口复制的说明: ServerRequest

Get the headers of this request.

指定者:

headers 在接口中 ServerRequest

cookies

public cn.taketoday.util.MultiValueMap<String,HttpCookie> cookies()

从接口复制的说明: ServerRequest

Get the cookies of this request.

指定者:

cookies 在接口中 ServerRequest

remoteAddress

public Optional<InetSocketAddress> remoteAddress()

从接口复制的说明: ServerRequest

Get the remote address to which this request is connected, if available.

指定者:

remoteAddress 在接口中 ServerRequest

messageConverters

public List<HttpMessageConverter<?>> messageConverters()

从接口复制的说明: ServerRequest

Get the readers used to convert the body of this request.

指定者:

messageConverters 在接口中 ServerRequest

指定者:

messageConverters 在接口中 ServerResponse.Context

返回:

the list of message writers

body

public <T> T body(Class<T> bodyType)
           throws IOException

从接口复制的说明: ServerRequest

Extract the body as an object of the given type.

指定者:

body 在接口中 ServerRequest

类型参数:

T - the body type

参数:

bodyType - the type of return value

返回:

the body

抛出:

IOException

body

public <T> T body(cn.taketoday.core.ParameterizedTypeReference<T> bodyType)
           throws IOException

从接口复制的说明: ServerRequest

Extract the body as an object of the given type.

指定者:

body 在接口中 ServerRequest

类型参数:

T - the body type

参数:

bodyType - the type of return value

返回:

the body

抛出:

IOException

bodyInternal

private <T> T bodyInternal(Type bodyType,
 Class<?> bodyClass)
                    throws IOException

抛出:

IOException

bind

public <T> T bind(Class<T> bindType,
 Consumer<WebDataBinder> dataBinderCustomizer)
           throws cn.taketoday.validation.BindException

从接口复制的说明: ServerRequest

Bind to this request and return an instance of the given type.

指定者:

bind 在接口中 ServerRequest

类型参数:

T - the type to bind to

参数:

bindType - the type of class to bind this request to

dataBinderCustomizer - used to customize the data binder, e.g. set (dis)allowed fields

返回:

a constructed and bound instance of bindType

抛出:

cn.taketoday.validation.BindException - in case of binding errors

attributes

public Map<String,Object> attributes()

从接口复制的说明: ServerRequest

Get a mutable map of request attributes.

指定者:

attributes 在接口中 ServerRequest

返回:

the request attributes

params

public cn.taketoday.util.MultiValueMap<String,String> params()

从接口复制的说明: ServerRequest

Get all parameters for this request. parameters are contained in the query string or posted form data.

指定者:

params 在接口中 ServerRequest

另请参阅:

• RequestContext.getParameters()

pathVariables

public Map<String,String> pathVariables()

从接口复制的说明: ServerRequest

Get all path variables for this request.

指定者:

pathVariables 在接口中 ServerRequest

exchange

public RequestContext exchange()

从接口复制的说明: ServerRequest

Get the request that this request is based on.

指定者:

exchange 在接口中 ServerRequest