public interface Request
限定符和类型 | 方法和说明 |
---|---|
default String |
address()
Get client ip address
|
default <T> T |
attribute(String name)
Get a Request Attribute
|
default Request |
attribute(String name,
Object value)
Setting Request Attribute
|
Map<String,Object> |
attributes()
Get current request attributes
|
default <T> T |
bindWithBody(Class<T> modelClass)
Bind body parameter to model
|
default <T> T |
bindWithForm(Class<T> modelClass)
Bind form parameter to model
|
io.netty.buffer.ByteBuf |
body()
Get current request body as ByteBuf
|
default String |
bodyToString()
Get current request body as string
|
boolean |
chunkIsEnd() |
default String |
contentType()
Get current request contentType. e.g: "text/html; charset=utf-8"
|
default String |
contextPath()
Get current application contextPath, default is "/"
|
Request |
cookie(Cookie cookie)
Add a cookie to the request
|
default String |
cookie(String name)
Get String Cookie Value
|
default String |
cookie(String name,
String defaultValue)
Get String Cookie Value
|
Cookie |
cookieRaw(String name)
Get raw cookie by cookie name
|
Map<String,Cookie> |
cookies()
Get current request cookies
|
default Optional<FileItem> |
fileItem(String name)
get file item by request part name
|
Map<String,FileItem> |
fileItems()
Get current request all fileItems
|
default String |
header(String name)
Get header information
|
default String |
header(String name,
String defaultValue)
Get header information
|
Map<String,String> |
headers()
Get current request headers.
|
String |
host()
Get client host.
|
HttpMethod |
httpMethod()
Get current request HttpMethod. e.g: HttpMethod.GET
|
Request |
initPathParams(Route route)
init request path parameters
|
default boolean |
isAjax()
Get current request is ajax.
|
default boolean |
isFormRequest()
Determine if this request is a FORM form request
According to header content-type contains "form"
|
default boolean |
isIE()
Gets the current request is the head of the IE browser
|
default boolean |
isJsonRequest()
Determine if this request is a json request
According to header content-type contains "json"
|
boolean |
isMultipart() |
boolean |
isSecure()
Get current request is https.
|
boolean |
keepAlive()
Get current request is KeepAlive, HTTP1.1 is true.
|
String |
method()
Get current request http method. e.g: GET
|
Set<String> |
parameterNames()
Get current request query parameter names
|
Map<String,List<String>> |
parameters()
Get current request query parameters
|
List<String> |
parameterValues(String paramName)
Get current request query parameter values
|
default Integer |
pathInt(String name)
Return a URL parameter for a Int type
|
default Long |
pathLong(String name)
Return a URL parameter for a Long type
|
Map<String,String> |
pathParams()
Get current request Path params, like /users/:uid
|
default String |
pathString(String name)
Get a URL parameter
|
String |
protocol()
Get request http protocol
|
default Optional<String> |
query(String name)
Get a request parameter
|
default String |
query(String name,
String defaultValue)
Get a request parameter, if NULL is returned to defaultValue
|
default Optional<Double> |
queryDouble(String name)
Returns a request parameter for a Double type
|
default double |
queryDouble(String name,
double defaultValue)
Returns a request parameter for a Double type
|
default Optional<Integer> |
queryInt(String name)
Returns a request parameter for a Int type
|
default int |
queryInt(String name,
int defaultValue)
Returns a request parameter for a Int type
|
default Optional<Long> |
queryLong(String name)
Returns a request parameter for a Long type
|
default long |
queryLong(String name,
long defaultValue)
Returns a request parameter for a Long type
|
String |
queryString()
Get queryString. e.g: http://xxx.com/hello?
|
String |
remoteAddress()
Get client remote address. e.g: 102.331.234.11:38227
|
Session |
session()
Get current request session, if null then create
|
String |
uri()
Get request uri
|
String |
url()
Get request url
|
boolean |
useGZIP() |
default String |
userAgent()
Get request user-agent
|
Request initPathParams(Route route)
route
- route objectString host()
String remoteAddress()
String uri()
String url()
default String userAgent()
String protocol()
default String contextPath()
Map<String,String> pathParams()
default String pathString(@NonNull String name)
name
- Parameter namedefault Integer pathInt(@NonNull String name)
name
- Parameter namedefault Long pathLong(@NonNull String name)
name
- Parameter nameString queryString()
Map<String,List<String>> parameters()
Set<String> parameterNames()
List<String> parameterValues(String paramName)
paramName
- param namedefault Optional<String> query(@NonNull String name)
name
- Parameter namedefault String query(@NonNull String name, @NonNull String defaultValue)
name
- parameter namedefaultValue
- default String valuedefault Optional<Integer> queryInt(@NonNull String name)
name
- Parameter namedefault int queryInt(@NonNull String name, int defaultValue)
name
- Parameter namedefaultValue
- default int valuedefault Optional<Long> queryLong(@NonNull String name)
name
- Parameter namedefault long queryLong(@NonNull String name, long defaultValue)
name
- Parameter namedefaultValue
- default long valuedefault Optional<Double> queryDouble(@NonNull String name)
name
- Parameter namedefault double queryDouble(@NonNull String name, double defaultValue)
name
- Parameter namedefaultValue
- default double valueString method()
HttpMethod httpMethod()
boolean useGZIP()
default String address()
Session session()
default String contentType()
boolean isSecure()
default boolean isAjax()
default boolean isFormRequest()
According to header content-type contains "form"
default boolean isJsonRequest()
According to header content-type contains "json"
default boolean isIE()
default String cookie(@NonNull String name)
name
- cookie nameCookie cookieRaw(String name)
name
- cookie namedefault String cookie(@NonNull String name, @NonNull String defaultValue)
name
- cookie namedefaultValue
- default cookie valueRequest cookie(Cookie cookie)
cookie
- cookie rawdefault String header(@NonNull String name)
name
- Parameter namedefault String header(@NonNull String name, @NonNull String defaultValue)
name
- Parameter namedefaultValue
- default header valueboolean keepAlive()
default <T> T bindWithForm(Class<T> modelClass)
T
- modelClass
- model class typedefault <T> T bindWithBody(Class<T> modelClass)
T
- modelClass
- model class typeMap<String,Object> attributes()
default Request attribute(@NonNull String name, Object value)
name
- attribute namevalue
- attribute Valuedefault <T> T attribute(String name)
name
- Parameter nameMap<String,FileItem> fileItems()
default Optional<FileItem> fileItem(@NonNull String name)
name
- boolean chunkIsEnd()
boolean isMultipart()
io.netty.buffer.ByteBuf body()
default String bodyToString()
Copyright © 2018. All rights reserved.