RequestBuilderBase (Asynchronous Http Client 2.0.0-RC5 API)

java.lang.Object
- org.asynchttpclient.RequestBuilderBase<T>

Type Parameters:

T - the builder type

Direct Known Subclasses:

BoundRequestBuilder, RequestBuilder
```
public abstract class RequestBuilderBase<T extends RequestBuilderBase<T>>
extends Object
```
Builder for Request

Field Summary

Fields
Modifier and Type	Field and Description
`protected InetAddress`	`address`
`protected BodyGenerator`	`bodyGenerator`
`protected List<Part>`	`bodyParts`
`protected ByteBuffer`	`byteBufferData`
`protected byte[]`	`byteData`
`protected ChannelPoolPartitioning`	`channelPoolPartitioning`
`protected Charset`	`charset`
`protected List<byte[]>`	`compositeByteData`
`protected long`	`contentLength`
`protected ArrayList<Cookie>`	`cookies`
`protected File`	`file`
`protected Boolean`	`followRedirect`
`protected List<Param>`	`formParams`
`protected io.netty.handler.codec.http.HttpHeaders`	`headers`
`protected InetAddress`	`localAddress`
`protected String`	`method`
`protected NameResolver`	`nameResolver`
`protected ProxyServer`	`proxyServer`
`protected List<Param>`	`queryParams`
`protected long`	`rangeOffset`
`protected Realm`	`realm`
`protected int`	`requestTimeout`
`protected SignatureCalculator`	`signatureCalculator`
`protected InputStream`	`streamData`
`protected String`	`stringData`
`protected Uri`	`uri`
`protected UriEncoder`	`uriEncoder`
`protected String`	`virtualHost`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`RequestBuilderBase(Request prototype)`
`protected`	`RequestBuilderBase(Request prototype, boolean disableUrlEncoding, boolean validateHeaders)`
`protected`	`RequestBuilderBase(String method, boolean disableUrlEncoding)`
`protected`	`RequestBuilderBase(String method, boolean disableUrlEncoding, boolean validateHeaders)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addBodyPart(Part bodyPart)`
`T`	`addCookie(Cookie cookie)`
`T`	`addFormParam(String name, String value)`
`T`	`addHeader(CharSequence name, String value)`
`T`	`addOrReplaceCookie(Cookie cookie)`
`T`	`addQueryParam(String name, String value)`
`T`	`addQueryParams(List<Param> params)`
`Request`	`build()`
`void`	`resetCookies()`
`void`	`resetFormParams()`
`void`	`resetMultipartData()`
`void`	`resetNonMultipartData()`
`void`	`resetQuery()`
`T`	`setAddress(InetAddress address)`
`T`	`setBody(BodyGenerator bodyGenerator)`
`T`	`setBody(byte[] data)`
`T`	`setBody(ByteBuffer data)`
`T`	`setBody(File file)`
`T`	`setBody(InputStream stream)`
`T`	`setBody(List<byte[]> data)`
`T`	`setBody(org.reactivestreams.Publisher<ByteBuffer> publisher)`
`T`	`setBody(String data)`
`T`	`setBodyParts(List<Part> bodyParts)`
`T`	`setChannelPoolPartitioning(ChannelPoolPartitioning channelPoolPartitioning)`
`T`	`setCharset(Charset charset)`
`T`	`setContentLength(int contentLength)`
`T`	`setCookies(Collection<Cookie> cookies)`
`T`	`setFollowRedirect(boolean followRedirect)`
`T`	`setFormParams(List<Param> params)`
`T`	`setFormParams(Map<String,List<String>> map)`
`T`	`setHeader(CharSequence name, String value)`
`T`	`setHeaders(io.netty.handler.codec.http.HttpHeaders headers)`
`T`	`setHeaders(Map<String,Collection<String>> headers)`
`T`	`setLocalAddress(InetAddress address)`
`T`	`setMethod(String method)`
`T`	`setNameResolver(NameResolver nameResolver)`
`T`	`setProxyServer(ProxyServer.Builder proxyServerBuilder)`
`T`	`setProxyServer(ProxyServer proxyServer)`
`T`	`setQueryParams(List<Param> params)`
`T`	`setQueryParams(Map<String,List<String>> map)`
`T`	`setRangeOffset(long rangeOffset)`
`T`	`setRealm(Realm realm)`
`T`	`setRequestTimeout(int requestTimeout)`
`T`	`setSignatureCalculator(SignatureCalculator signatureCalculator)`
`T`	`setUri(Uri uri)`
`T`	`setUrl(String url)`
`T`	`setVirtualHost(String virtualHost)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uriEncoder
```
protected UriEncoder uriEncoder
```

queryParams
```
protected List<Param> queryParams
```

signatureCalculator

protected SignatureCalculator signatureCalculator

method
```
protected String method
```

uri
```
protected Uri uri
```

address
```
protected InetAddress address
```

localAddress
```
protected InetAddress localAddress
```

headers

protected io.netty.handler.codec.http.HttpHeaders headers

cookies
```
protected ArrayList<Cookie> cookies
```

byteData
```
protected byte[] byteData
```

compositeByteData

protected List<byte[]> compositeByteData

stringData
```
protected String stringData
```

byteBufferData
```
protected ByteBuffer byteBufferData
```

streamData
```
protected InputStream streamData
```

bodyGenerator
```
protected BodyGenerator bodyGenerator
```

formParams
```
protected List<Param> formParams
```

bodyParts
```
protected List<Part> bodyParts
```

virtualHost
```
protected String virtualHost
```

contentLength
```
protected long contentLength
```

proxyServer
```
protected ProxyServer proxyServer
```

realm
```
protected Realm realm
```

file
```
protected File file
```

followRedirect
```
protected Boolean followRedirect
```

requestTimeout
```
protected int requestTimeout
```

rangeOffset
```
protected long rangeOffset
```

charset
```
protected Charset charset
```

channelPoolPartitioning

protected ChannelPoolPartitioning channelPoolPartitioning

nameResolver
```
protected NameResolver nameResolver
```

Constructor Detail

RequestBuilderBase

protected RequestBuilderBase(String method,
                             boolean disableUrlEncoding)

RequestBuilderBase

protected RequestBuilderBase(String method,
                             boolean disableUrlEncoding,
                             boolean validateHeaders)

RequestBuilderBase

protected RequestBuilderBase(Request prototype)

RequestBuilderBase

protected RequestBuilderBase(Request prototype,
                             boolean disableUrlEncoding,
                             boolean validateHeaders)

Method Detail

setUrl
```
public T setUrl(String url)
```

setUri
```
public T setUri(Uri uri)
```

setAddress

public T setAddress(InetAddress address)

setLocalAddress

public T setLocalAddress(InetAddress address)

setVirtualHost

public T setVirtualHost(String virtualHost)

setHeader

public T setHeader(CharSequence name,
                   String value)

addHeader

public T addHeader(CharSequence name,
                   String value)

setHeaders

public T setHeaders(io.netty.handler.codec.http.HttpHeaders headers)

setHeaders

public T setHeaders(Map<String,Collection<String>> headers)

setContentLength

public T setContentLength(int contentLength)

setCookies

public T setCookies(Collection<Cookie> cookies)

addCookie
```
public T addCookie(Cookie cookie)
```

addOrReplaceCookie

public T addOrReplaceCookie(Cookie cookie)

resetCookies
```
public void resetCookies()
```

resetQuery
```
public void resetQuery()
```

resetFormParams
```
public void resetFormParams()
```

resetNonMultipartData
```
public void resetNonMultipartData()
```

resetMultipartData
```
public void resetMultipartData()
```

setBody
```
public T setBody(File file)
```

setBody
```
public T setBody(byte[] data)
```

setBody
```
public T setBody(List<byte[]> data)
```

setBody
```
public T setBody(String data)
```

setBody
```
public T setBody(ByteBuffer data)
```

setBody
```
public T setBody(InputStream stream)
```

setBody

public T setBody(org.reactivestreams.Publisher<ByteBuffer> publisher)

setBody

public T setBody(BodyGenerator bodyGenerator)

addQueryParam

public T addQueryParam(String name,
                       String value)

addQueryParams

public T addQueryParams(List<Param> params)

setQueryParams

public T setQueryParams(Map<String,List<String>> map)

setQueryParams

public T setQueryParams(List<Param> params)

addFormParam

public T addFormParam(String name,
                      String value)

setFormParams

public T setFormParams(Map<String,List<String>> map)

setFormParams

public T setFormParams(List<Param> params)

addBodyPart
```
public T addBodyPart(Part bodyPart)
```

setBodyParts

public T setBodyParts(List<Part> bodyParts)

setProxyServer

public T setProxyServer(ProxyServer proxyServer)

setProxyServer

public T setProxyServer(ProxyServer.Builder proxyServerBuilder)

setRealm
```
public T setRealm(Realm realm)
```

setFollowRedirect

public T setFollowRedirect(boolean followRedirect)

setRequestTimeout

public T setRequestTimeout(int requestTimeout)

setRangeOffset

public T setRangeOffset(long rangeOffset)

setMethod
```
public T setMethod(String method)
```

setCharset
```
public T setCharset(Charset charset)
```

setChannelPoolPartitioning

public T setChannelPoolPartitioning(ChannelPoolPartitioning channelPoolPartitioning)

setNameResolver

public T setNameResolver(NameResolver nameResolver)

setSignatureCalculator

public T setSignatureCalculator(SignatureCalculator signatureCalculator)

build
```
public Request build()
```

Class RequestBuilderBase<T extends RequestBuilderBase<T>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uriEncoder

queryParams

signatureCalculator

method

uri

address

localAddress

headers

cookies

byteData

compositeByteData

stringData

byteBufferData

streamData

bodyGenerator

formParams

bodyParts

virtualHost

contentLength

proxyServer

realm

file

followRedirect

requestTimeout

rangeOffset

charset

channelPoolPartitioning

nameResolver

Constructor Detail

RequestBuilderBase

RequestBuilderBase

RequestBuilderBase

RequestBuilderBase

Method Detail

setUrl

setUri

setAddress

setLocalAddress

setVirtualHost

setHeader

addHeader

setHeaders

setHeaders

setContentLength

setCookies

addCookie

addOrReplaceCookie

resetCookies

resetQuery

resetFormParams

resetNonMultipartData

resetMultipartData

setBody

setBody

setBody

setBody

setBody

setBody

setBody

setBody

addQueryParam

addQueryParams

setQueryParams

setQueryParams

addFormParam

setFormParams

setFormParams

addBodyPart

setBodyParts

setProxyServer

setProxyServer

setRealm

setFollowRedirect

setRequestTimeout