java.lang.Object
- org.redkale.net.client.ClientRequest
- - org.redkale.net.http.WebRequest

所有已实现的接口:

Serializable
```
public class WebRequest
extends ClientRequest
implements Serializable
```
HttpRequest的缩减版, 只提供部分字段
详情见: https://redkale.org

从以下版本开始:

2.1.0

作者:

zhangjx

另请参阅:

WebClient, WebConnection, WebResult, 序列化表格

字段概要

字段
修饰符和类型	字段	说明
`protected byte[]`	`body`
`protected String`	`contentType`
`protected String`	`contextPath`
`protected Serializable`	`currentUserid`
`protected HttpHeaders`	`headers`
`protected String`	`locale`
`protected String`	`method`
`protected HttpParameters`	`params`
`protected String`	`path`
`protected String`	`remoteAddr`
`protected ConvertType`	`reqConvertType`
`protected ConvertType`	`respConvertType`
`protected boolean`	`rpc`
`protected String`	`sessionid`

从类继承的字段 org.redkale.net.client.ClientRequest
createTime, EMPTY_TRACEID, traceid, workThread

构造器概要

构造器
构造器说明

WebRequest()

方法概要

所有方法静态方法实例方法具体方法
修饰符和类型	方法	说明
`WebRequest`	`addHeader(String key, int value)`
`WebRequest`	`addHeader(String key, long value)`
`WebRequest`	`addHeader(String key, Object value)`
`WebRequest`	`addHeader(String key, String value)`
`WebRequest`	`addHeader(String key, TextConvert convert, Object value)`
`WebRequest`	`body(byte[] body)`
`WebRequest`	`bothConvertType(ConvertType convertType)`
`WebRequest`	`clearContentType()`
`WebRequest`	`clearHeaders()`
`WebRequest`	`clearLocale()`
`WebRequest`	`clearParams()`
`WebRequest`	`clearRemoteAddr()`
`WebRequest`	`clearSessionid()`
`protected boolean`	`containsHeader(String name)`
`protected static byte[]`	`contentLengthBytes(byte[] clientBody)`
`WebRequest`	`contentType(String contentType)`
`WebRequest`	`contextPath(String contextPath)`
`WebRequest`	`copy()`
`static WebRequest`	`createGetPath(String path)`
`static WebRequest`	`createGetPath(String path, Object... params)`
`static WebRequest`	`createGetPath(String path, HttpHeaders header)`
`static WebRequest`	`createGetPath(String path, HttpHeaders header, Object... params)`
`static WebRequest`	`createPath(String path)`
`static WebRequest`	`createPath(String path, Object... params)`
`static WebRequest`	`createPath(String path, HttpHeaders header)`
`static WebRequest`	`createPath(String path, HttpHeaders header, Object... params)`
`static WebRequest`	`createPostPath(String path)`
`static WebRequest`	`createPostPath(String path, Object... params)`
`static WebRequest`	`createPostPath(String path, HttpHeaders header)`
`static WebRequest`	`createPostPath(String path, HttpHeaders header, Object... params)`
`WebRequest`	`currentUserid(Serializable userid)`
`WebRequest`	`formUrlencoded()`
`byte[]`	`getBody()`
`String`	`getContentType()`
`String`	`getContextPath()`
`Serializable`	`getCurrentUserid()`
`String`	`getHeader(String name)`
`String`	`getHeader(String name, String defaultValue)`
`HttpHeaders`	`getHeaders()`
`String`	`getLocale()`
`String`	`getMethod()`
`String`	`getParametersToString()`
`HttpParameters`	`getParams()`
`String`	`getPath()`
`String`	`getRemoteAddr()`
`ConvertType`	`getReqConvertType()`
`ConvertType`	`getRespConvertType()`
`String`	`getSessionid()`
`WebRequest`	`headers(HttpHeaders header)`
`boolean`	`isRpc()`
`WebRequest`	`locale(String locale)`
`WebRequest`	`method(String method)`
`WebRequest`	`param(String key, Object value)`
`WebRequest`	`param(String key, String value)`
`WebRequest`	`param(String key, TextConvert convert, Object value)`
`WebRequest`	`params(HttpParameters params)`
`WebRequest`	`path(String path)`
`WebRequest`	`remoteAddr(String remoteAddr)`
`WebRequest`	`removeHeader(String name)`
`WebRequest`	`removeParam(String name)`
`WebRequest`	`reqConvertType(ConvertType reqConvertType)`
`String`	`requestPath()`
`WebRequest`	`respConvertType(ConvertType respConvertType)`
`WebRequest`	`rpc(boolean rpc)`
`WebRequest`	`sessionid(String sessionid)`
`void`	`setBody(byte[] body)`
`void`	`setContentType(String contentType)`
`void`	`setContextPath(String contextPath)`
`void`	`setCurrentUserid(Serializable currentUserid)`
`WebRequest`	`setHeader(String key, int value)`
`WebRequest`	`setHeader(String key, long value)`
`WebRequest`	`setHeader(String key, Object value)`
`WebRequest`	`setHeader(String key, String value)`
`WebRequest`	`setHeader(String key, TextConvert convert, Object value)`
`void`	`setHeaders(HttpHeaders headers)`
`void`	`setLocale(String locale)`
`void`	`setMethod(String method)`
`void`	`setParams(HttpParameters params)`
`void`	`setPath(String path)`
`void`	`setRemoteAddr(String remoteAddr)`
`void`	`setReqConvertType(ConvertType reqConvertType)`
`void`	`setRespConvertType(ConvertType respConvertType)`
`void`	`setRpc(boolean rpc)`
`void`	`setSessionid(String sessionid)`
`void`	`setTraceid(String traceid)`
`String`	`toString()`
`WebRequest`	`traceid(String traceid)`
`void`	`writeTo(ClientConnection conn, ByteArray array)`

从类继承的方法 org.redkale.net.client.ClientRequest
getCreateTime, getRequestid, getTraceid, isCloseType, isCompleted, isVirtualType, prepare, recycle, traceBytes, workThread

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

rpc

@ConvertColumn(index=13)
@Comment("\u662f\u5426RPC\u8bf7\u6c42, \u8be5\u7c7b\u901a\u5e38\u662f\u4e3aRPC\u521b\u5efa\u7684\uff0c\u6545\u9ed8\u8ba4\u662ftrue")
protected boolean rpc

reqConvertType

@ConvertColumn(index=14)
@Comment("\u8bf7\u6c42\u53c2\u6570\u7684ConvertType")
protected ConvertType reqConvertType

respConvertType

@ConvertColumn(index=15)
@Comment("\u8f93\u51fa\u7ed3\u679c\u7684ConvertType")
protected ConvertType respConvertType

method

@Comment("Method GET/POST/...")
@ConvertColumn(index=16)
protected String method

path

@ConvertColumn(index=17)
@Comment("\u8bf7\u6c42\u7684Path")
protected String path

contextPath

@ConvertColumn(index=18)
@Comment("\u8bf7\u6c42\u7684\u524d\u7f00")
protected String contextPath

remoteAddr

@ConvertColumn(index=19)
@Comment("\u5ba2\u6237\u7aefIP")
protected String remoteAddr

locale

@ConvertColumn(index=20)
@Comment("Locale\u56fd\u9645\u5316")
protected String locale

sessionid

@ConvertColumn(index=21)
@Comment("\u4f1a\u8bddID")
protected String sessionid

contentType

@ConvertColumn(index=22)
@Comment("Content-Type")
protected String contentType

currentUserid

@ConvertColumn(index=23)
protected Serializable currentUserid

headers

@ConvertColumn(index=24)
@Comment("http header\u4fe1\u606f")
protected HttpHeaders headers

params

@ConvertColumn(index=25)
@Comment("\u53c2\u6570\u4fe1\u606f")
protected HttpParameters params

body

@ConvertColumn(index=26)
@Comment("http body\u4fe1\u606f")
protected byte[] body

构造器详细资料
- WebRequest
```
public WebRequest()
```

方法详细资料

createPath

public static WebRequest createPath(String path)

createPath

public static WebRequest createPath(String path,
                                    HttpHeaders header)

createPath

public static WebRequest createPath(String path,
                                    Object... params)

createPath

public static WebRequest createPath(String path,
                                    HttpHeaders header,
                                    Object... params)

createGetPath

public static WebRequest createGetPath(String path)

createGetPath

public static WebRequest createGetPath(String path,
                                       HttpHeaders header)

createGetPath

public static WebRequest createGetPath(String path,
                                       Object... params)

createGetPath

public static WebRequest createGetPath(String path,
                                       HttpHeaders header,
                                       Object... params)

createPostPath

public static WebRequest createPostPath(String path)

createPostPath

public static WebRequest createPostPath(String path,
                                        HttpHeaders header)

createPostPath

public static WebRequest createPostPath(String path,
                                        Object... params)

createPostPath

public static WebRequest createPostPath(String path,
                                        HttpHeaders header,
                                        Object... params)

copy
```
public WebRequest copy()
```

writeTo

public void writeTo(ClientConnection conn,
                    ByteArray array)

指定者:: writeTo 在类中 ClientRequest

containsHeader

protected boolean containsHeader(String name)

contentLengthBytes

protected static byte[] contentLengthBytes(byte[] clientBody)

getParametersToString

@Nullable
public String getParametersToString()

requestPath
```
public String requestPath()
```

formUrlencoded
```
public WebRequest formUrlencoded()
```

rpc

public WebRequest rpc(boolean rpc)

traceid

public WebRequest traceid(String traceid)

覆盖:: traceid 在类中 ClientRequest

path

public WebRequest path(String path)

contextPath

public WebRequest contextPath(String contextPath)

bothConvertType

public WebRequest bothConvertType(ConvertType convertType)

reqConvertType

public WebRequest reqConvertType(ConvertType reqConvertType)

respConvertType

public WebRequest respConvertType(ConvertType respConvertType)

remoteAddr

public WebRequest remoteAddr(String remoteAddr)

locale

public WebRequest locale(String locale)

sessionid

public WebRequest sessionid(String sessionid)

contentType

public WebRequest contentType(String contentType)

currentUserid

public WebRequest currentUserid(Serializable userid)

removeHeader

public WebRequest removeHeader(String name)

removeParam

public WebRequest removeParam(String name)

headers

public WebRequest headers(HttpHeaders header)

params

public WebRequest params(HttpParameters params)

method

public WebRequest method(String method)

addHeader

public WebRequest addHeader(String key,
                            String value)

addHeader

public WebRequest addHeader(String key,
                            TextConvert convert,
                            Object value)

addHeader

public WebRequest addHeader(String key,
                            Object value)

addHeader

public WebRequest addHeader(String key,
                            int value)

addHeader

public WebRequest addHeader(String key,
                            long value)

setHeader

public WebRequest setHeader(String key,
                            String value)

setHeader

public WebRequest setHeader(String key,
                            TextConvert convert,
                            Object value)

setHeader

public WebRequest setHeader(String key,
                            Object value)

setHeader

public WebRequest setHeader(String key,
                            int value)

setHeader

public WebRequest setHeader(String key,
                            long value)

param

public WebRequest param(String key,
                        String value)

param

public WebRequest param(String key,
                        TextConvert convert,
                        Object value)

param

public WebRequest param(String key,
                        Object value)

body

public WebRequest body(byte[] body)

clearParams
```
public WebRequest clearParams()
```

clearHeaders
```
public WebRequest clearHeaders()
```

clearRemoteAddr
```
public WebRequest clearRemoteAddr()
```

clearLocale
```
public WebRequest clearLocale()
```

clearSessionid
```
public WebRequest clearSessionid()
```

clearContentType
```
public WebRequest clearContentType()
```

getHeader

public String getHeader(String name)

getHeader

public String getHeader(String name,
                        String defaultValue)

isRpc
```
public boolean isRpc()
```

setRpc
```
public void setRpc(boolean rpc)
```

setTraceid

public void setTraceid(String traceid)

getMethod
```
public String getMethod()
```

setMethod

public void setMethod(String method)

getPath
```
public String getPath()
```

setPath
```
public void setPath(String path)
```

getContextPath
```
public String getContextPath()
```

setContextPath

public void setContextPath(String contextPath)

getSessionid
```
public String getSessionid()
```

setSessionid

public void setSessionid(String sessionid)

getRemoteAddr
```
public String getRemoteAddr()
```

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

getLocale
```
public String getLocale()
```

setLocale

public void setLocale(String locale)

getCurrentUserid

public Serializable getCurrentUserid()

setCurrentUserid

public void setCurrentUserid(Serializable currentUserid)

getContentType
```
public String getContentType()
```

setContentType

public void setContentType(String contentType)

getHeaders
```
public HttpHeaders getHeaders()
```

setHeaders

public void setHeaders(HttpHeaders headers)

getParams
```
public HttpParameters getParams()
```

setParams

public void setParams(HttpParameters params)

getBody
```
public byte[] getBody()
```

setBody
```
public void setBody(byte[] body)
```

getReqConvertType

public ConvertType getReqConvertType()

setReqConvertType

public void setReqConvertType(ConvertType reqConvertType)

getRespConvertType

public ConvertType getRespConvertType()

setRespConvertType

public void setRespConvertType(ConvertType respConvertType)

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 WebRequest

字段概要

从类继承的字段 org.redkale.net.client.ClientRequest

构造器概要

方法概要

从类继承的方法 org.redkale.net.client.ClientRequest

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

字段详细资料

rpc

reqConvertType

respConvertType

method

path

contextPath

remoteAddr

locale

sessionid

contentType

currentUserid

headers

params

body

构造器详细资料

WebRequest

方法详细资料

createPath

createPath

createPath

createPath

createGetPath

createGetPath

createGetPath

createGetPath

createPostPath

createPostPath

createPostPath

createPostPath

copy

writeTo

containsHeader

contentLengthBytes

getParametersToString

requestPath

formUrlencoded

rpc

traceid

path

contextPath

bothConvertType

reqConvertType

respConvertType

remoteAddr

locale

sessionid

contentType

currentUserid

removeHeader

removeParam

headers

params

method

addHeader

addHeader

addHeader

addHeader

addHeader

setHeader

setHeader

setHeader

setHeader

setHeader

param

param

param

body

clearParams

clearHeaders

clearRemoteAddr

clearLocale

clearSessionid