Package org.asynchttpclient
Class RequestBuilderBase<T extends RequestBuilderBase<T>>
- 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 forRequest
-
-
Field Summary
Fields Modifier and Type Field 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 ArrayList<io.netty.handler.codec.http.cookie.Cookie>
cookies
static io.netty.resolver.NameResolver<InetAddress>
DEFAULT_NAME_RESOLVER
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 io.netty.resolver.NameResolver<InetAddress>
nameResolver
protected ProxyServer
proxyServer
protected List<Param>
queryParams
protected long
rangeOffset
protected int
readTimeout
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 Description protected
RequestBuilderBase(String method, boolean disableUrlEncoding)
protected
RequestBuilderBase(String method, boolean disableUrlEncoding, boolean validateHeaders)
protected
RequestBuilderBase(Request prototype)
protected
RequestBuilderBase(Request prototype, boolean disableUrlEncoding, boolean validateHeaders)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description T
addBodyPart(Part bodyPart)
T
addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
T
addFormParam(String name, String value)
T
addHeader(CharSequence name, Iterable<?> values)
Add header values for the request.T
addHeader(CharSequence name, Object value)
Add a header value for the request.T
addHeader(CharSequence name, String value)
T
addOrReplaceCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
Add/replace a cookie based on its nameT
addQueryParam(String name, String value)
T
addQueryParams(List<Param> params)
Request
build()
T
clearHeaders()
Remove all added headersvoid
resetCookies()
void
resetFormParams()
void
resetMultipartData()
void
resetNonMultipartData()
void
resetQuery()
T
setAddress(InetAddress address)
T
setBody(byte[] data)
T
setBody(File file)
T
setBody(InputStream stream)
T
setBody(String data)
T
setBody(ByteBuffer data)
T
setBody(List<byte[]> data)
T
setBody(BodyGenerator bodyGenerator)
T
setBodyParts(List<Part> bodyParts)
T
setChannelPoolPartitioning(ChannelPoolPartitioning channelPoolPartitioning)
T
setCharset(Charset charset)
T
setCookies(Collection<io.netty.handler.codec.http.cookie.Cookie> cookies)
T
setFollowRedirect(boolean followRedirect)
T
setFormParams(List<Param> params)
T
setFormParams(Map<String,List<String>> map)
T
setHeader(CharSequence name, Iterable<?> values)
Set multi-values header for the requestT
setHeader(CharSequence name, Object value)
Set uni-value header for the requestT
setHeader(CharSequence name, String value)
T
setHeaders(io.netty.handler.codec.http.HttpHeaders headers)
T
setHeaders(Map<? extends CharSequence,? extends Iterable<?>> headers)
Set request headers using a mapheaders
of pair (Header name, Header values) This method could be used to setup multi-valued headersT
setLocalAddress(InetAddress address)
T
setMethod(String method)
T
setNameResolver(io.netty.resolver.NameResolver<InetAddress> nameResolver)
T
setProxyServer(ProxyServer proxyServer)
T
setProxyServer(ProxyServer.Builder proxyServerBuilder)
T
setQueryParams(List<Param> params)
T
setQueryParams(Map<String,List<String>> map)
T
setRangeOffset(long rangeOffset)
T
setReadTimeout(int readTimeout)
T
setRealm(Realm realm)
T
setRealm(Realm.Builder realm)
T
setRequestTimeout(int requestTimeout)
T
setSignatureCalculator(SignatureCalculator signatureCalculator)
T
setSingleHeaders(Map<? extends CharSequence,?> headers)
Set single-value request headers using a mapheaders
of pairs (Header name, Header value).T
setUri(Uri uri)
T
setUrl(String url)
T
setVirtualHost(String virtualHost)
-
-
-
Field Detail
-
DEFAULT_NAME_RESOLVER
public static final io.netty.resolver.NameResolver<InetAddress> DEFAULT_NAME_RESOLVER
-
uriEncoder
protected UriEncoder uriEncoder
-
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<io.netty.handler.codec.http.cookie.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
-
virtualHost
protected String virtualHost
-
proxyServer
protected ProxyServer proxyServer
-
realm
protected Realm realm
-
file
protected File file
-
followRedirect
protected Boolean followRedirect
-
requestTimeout
protected int requestTimeout
-
readTimeout
protected int readTimeout
-
rangeOffset
protected long rangeOffset
-
charset
protected Charset charset
-
channelPoolPartitioning
protected ChannelPoolPartitioning channelPoolPartitioning
-
nameResolver
protected io.netty.resolver.NameResolver<InetAddress> 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
-
setAddress
public T setAddress(InetAddress address)
-
setLocalAddress
public T setLocalAddress(InetAddress address)
-
clearHeaders
public T clearHeaders()
Remove all added headers- Returns:
this
-
setHeader
public T setHeader(CharSequence name, String value)
- Parameters:
name
- header namevalue
- header value to set- Returns:
this
- See Also:
setHeader(CharSequence, Object)
-
setHeader
public T setHeader(CharSequence name, Object value)
Set uni-value header for the request- Parameters:
name
- header namevalue
- header value to set- Returns:
this
-
setHeader
public T setHeader(CharSequence name, Iterable<?> values)
Set multi-values header for the request- Parameters:
name
- header namevalues
-Iterable
with multiple header values to set- Returns:
this
-
addHeader
public T addHeader(CharSequence name, String value)
- Parameters:
name
- header namevalue
- header value to add- Returns:
this
- See Also:
addHeader(CharSequence, Object)
-
addHeader
public T addHeader(CharSequence name, Object value)
Add a header value for the request. If a header withname
was setup for this request already - call will add one more header value and convert it to multi-value header- Parameters:
name
- header namevalue
- header value to add- Returns:
this
-
addHeader
public T addHeader(CharSequence name, Iterable<?> values)
Add header values for the request. If a header withname
was setup for this request already - call will add more header values and convert it to multi-value header- Parameters:
name
- header namevalues
-Iterable
with multiple header values to add- Returns:
-
setHeaders
public T setHeaders(io.netty.handler.codec.http.HttpHeaders headers)
-
setHeaders
public T setHeaders(Map<? extends CharSequence,? extends Iterable<?>> headers)
Set request headers using a mapheaders
of pair (Header name, Header values) This method could be used to setup multi-valued headers- Parameters:
headers
- map of header names as the map keys and header valuesIterable
as the map values- Returns:
this
-
setSingleHeaders
public T setSingleHeaders(Map<? extends CharSequence,?> headers)
Set single-value request headers using a mapheaders
of pairs (Header name, Header value). To set headers with multiple values usesetHeaders(Map)
- Parameters:
headers
- map of header names as the map keys and header values as the map values- Returns:
this
-
setCookies
public T setCookies(Collection<io.netty.handler.codec.http.cookie.Cookie> cookies)
-
addCookie
public T addCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
-
addOrReplaceCookie
public T addOrReplaceCookie(io.netty.handler.codec.http.cookie.Cookie cookie)
Add/replace a cookie based on its name- Parameters:
cookie
- the new cookie- Returns:
- this
-
resetCookies
public void resetCookies()
-
resetQuery
public void resetQuery()
-
resetFormParams
public void resetFormParams()
-
resetNonMultipartData
public void resetNonMultipartData()
-
resetMultipartData
public void resetMultipartData()
-
setBody
public T setBody(byte[] data)
-
setBody
public T setBody(ByteBuffer data)
-
setBody
public T setBody(InputStream stream)
-
setBody
public T setBody(BodyGenerator bodyGenerator)
-
setProxyServer
public T setProxyServer(ProxyServer proxyServer)
-
setProxyServer
public T setProxyServer(ProxyServer.Builder proxyServerBuilder)
-
setRealm
public T setRealm(Realm.Builder realm)
-
setFollowRedirect
public T setFollowRedirect(boolean followRedirect)
-
setRequestTimeout
public T setRequestTimeout(int requestTimeout)
-
setReadTimeout
public T setReadTimeout(int readTimeout)
-
setRangeOffset
public T setRangeOffset(long rangeOffset)
-
setChannelPoolPartitioning
public T setChannelPoolPartitioning(ChannelPoolPartitioning channelPoolPartitioning)
-
setNameResolver
public T setNameResolver(io.netty.resolver.NameResolver<InetAddress> nameResolver)
-
setSignatureCalculator
public T setSignatureCalculator(SignatureCalculator signatureCalculator)
-
build
public Request build()
-
-