org.asynchttpclient.simple

Class SimpleAsyncHttpClient.Builder

java.lang.Object

org.asynchttpclient.simple.SimpleAsyncHttpClient.Builder

All Implemented Interfaces:

SimpleAsyncHttpClient.DerivedBuilder

Enclosing class:

SimpleAsyncHttpClient

public static final class SimpleAsyncHttpClient.Builder
extends Object
implements SimpleAsyncHttpClient.DerivedBuilder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleAsyncHttpClient.Builder	addBodyPart(Part part)
SimpleAsyncHttpClient.Builder	addCookie(Cookie cookie)
SimpleAsyncHttpClient.Builder	addFormParam(String key, String value)
SimpleAsyncHttpClient.Builder	addHeader(String name, String value)
SimpleAsyncHttpClient.Builder	addQueryParam(String name, String value)
SimpleAsyncHttpClient	build()
SimpleAsyncHttpClient.Builder	setAcceptAnyCertificate(boolean acceptAnyCertificate)
SimpleAsyncHttpClient.Builder	setAllowPoolingConnections(boolean allowPoolingConnections)
SimpleAsyncHttpClient.Builder	setCompressionEnforced(boolean compressionEnforced)
SimpleAsyncHttpClient.Builder	setConnectTimeout(int connectTimeuot)
SimpleAsyncHttpClient.Builder	setDefaultThrowableHandler(ThrowableHandler throwableHandler)
SimpleAsyncHttpClient.Builder	setErrorDocumentBehaviour(SimpleAsyncHttpClient.ErrorDocumentBehaviour behaviour) This setting controls whether an error document should be written via the BodyConsumer after an error status code was received (e.g.
SimpleAsyncHttpClient.Builder	setExecutorService(ExecutorService applicationThreadPool)
SimpleAsyncHttpClient.Builder	setFollowRedirect(boolean followRedirect)
SimpleAsyncHttpClient.Builder	setFormParams(List<Param> params)
SimpleAsyncHttpClient.Builder	setFormParams(Map<String,List<String>> parameters)
SimpleAsyncHttpClient.Builder	setHeader(String name, String value)
SimpleAsyncHttpClient.Builder	setHeaders(FluentCaseInsensitiveStringsMap headers)
SimpleAsyncHttpClient.Builder	setHeaders(Map<String,Collection<String>> headers)
SimpleAsyncHttpClient.Builder	setListener(SimpleAHCTransferListener listener) Set the listener to notify about connection progress.
SimpleAsyncHttpClient.Builder	setMaxConnections(int defaultMaxConnections)
SimpleAsyncHttpClient.Builder	setMaxConnectionsPerHost(int defaultMaxConnectionsPerHost)
SimpleAsyncHttpClient.Builder	setMaxRedirects(int maxRedirects)
SimpleAsyncHttpClient.Builder	setMaxRequestRetry(int maxRequestRetry) Set the number of time a request will be retried when an IOException occurs because of a Network exception.
SimpleAsyncHttpClient.Builder	setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)
SimpleAsyncHttpClient.Builder	setProxyHost(String host)
SimpleAsyncHttpClient.Builder	setProxyPassword(String password)
SimpleAsyncHttpClient.Builder	setProxyPort(int port)
SimpleAsyncHttpClient.Builder	setProxyPrincipal(String principal)
SimpleAsyncHttpClient.Builder	setProxyProtocol(ProxyServer.Protocol protocol)
SimpleAsyncHttpClient.Builder	setRealmCharset(Charset charset)
SimpleAsyncHttpClient.Builder	setRealmName(String realmName)
SimpleAsyncHttpClient.Builder	setRealmNtlmDomain(String domain)
SimpleAsyncHttpClient.Builder	setRealmPassword(String password)
SimpleAsyncHttpClient.Builder	setRealmPrincipal(String principal)
SimpleAsyncHttpClient.Builder	setRealmScheme(Realm.AuthScheme scheme)
SimpleAsyncHttpClient.Builder	setRealmUsePreemptiveAuth(boolean usePreemptiveAuth)
SimpleAsyncHttpClient.Builder	setRequestTimeout(int defaultRequestTimeout)
SimpleAsyncHttpClient.Builder	setResumableDownload(boolean enableResumableDownload) Enable resumable downloads for the SimpleAHC.
SimpleAsyncHttpClient.Builder	setSSLContext(SSLContext sslContext)
SimpleAsyncHttpClient.Builder	setUrl(String url)
SimpleAsyncHttpClient.Builder	setUserAgent(String userAgent)
SimpleAsyncHttpClient.Builder	setVirtualHost(String virtualHost)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addBodyPart

public SimpleAsyncHttpClient.Builder addBodyPart(Part part)

Specified by:

addBodyPart in interface SimpleAsyncHttpClient.DerivedBuilder

addCookie

public SimpleAsyncHttpClient.Builder addCookie(Cookie cookie)

Specified by:

addCookie in interface SimpleAsyncHttpClient.DerivedBuilder

addHeader

public SimpleAsyncHttpClient.Builder addHeader(String name,
                                               String value)

Specified by:

addHeader in interface SimpleAsyncHttpClient.DerivedBuilder

addFormParam

public SimpleAsyncHttpClient.Builder addFormParam(String key,
                                                  String value)

Specified by:

addFormParam in interface SimpleAsyncHttpClient.DerivedBuilder

addQueryParam

public SimpleAsyncHttpClient.Builder addQueryParam(String name,
                                                   String value)

Specified by:

addQueryParam in interface SimpleAsyncHttpClient.DerivedBuilder

setHeader

public SimpleAsyncHttpClient.Builder setHeader(String name,
                                               String value)

Specified by:

setHeader in interface SimpleAsyncHttpClient.DerivedBuilder

setHeaders

public SimpleAsyncHttpClient.Builder setHeaders(FluentCaseInsensitiveStringsMap headers)

Specified by:

setHeaders in interface SimpleAsyncHttpClient.DerivedBuilder

setHeaders

public SimpleAsyncHttpClient.Builder setHeaders(Map<String,Collection<String>> headers)

Specified by:

setHeaders in interface SimpleAsyncHttpClient.DerivedBuilder

setFormParams

public SimpleAsyncHttpClient.Builder setFormParams(Map<String,List<String>> parameters)

Specified by:

setFormParams in interface SimpleAsyncHttpClient.DerivedBuilder

setFormParams

public SimpleAsyncHttpClient.Builder setFormParams(List<Param> params)

Specified by:

setFormParams in interface SimpleAsyncHttpClient.DerivedBuilder

setUrl

public SimpleAsyncHttpClient.Builder setUrl(String url)

Specified by:

setUrl in interface SimpleAsyncHttpClient.DerivedBuilder

setVirtualHost

public SimpleAsyncHttpClient.Builder setVirtualHost(String virtualHost)

Specified by:

setVirtualHost in interface SimpleAsyncHttpClient.DerivedBuilder

setFollowRedirect

public SimpleAsyncHttpClient.Builder setFollowRedirect(boolean followRedirect)

Specified by:

setFollowRedirect in interface SimpleAsyncHttpClient.DerivedBuilder

setMaxConnections

public SimpleAsyncHttpClient.Builder setMaxConnections(int defaultMaxConnections)

setMaxConnectionsPerHost

public SimpleAsyncHttpClient.Builder setMaxConnectionsPerHost(int defaultMaxConnectionsPerHost)

setConnectTimeout

public SimpleAsyncHttpClient.Builder setConnectTimeout(int connectTimeuot)

setPooledConnectionIdleTimeout

public SimpleAsyncHttpClient.Builder setPooledConnectionIdleTimeout(int pooledConnectionIdleTimeout)

setRequestTimeout

public SimpleAsyncHttpClient.Builder setRequestTimeout(int defaultRequestTimeout)

setMaxRedirects

public SimpleAsyncHttpClient.Builder setMaxRedirects(int maxRedirects)

setCompressionEnforced

public SimpleAsyncHttpClient.Builder setCompressionEnforced(boolean compressionEnforced)

setUserAgent

public SimpleAsyncHttpClient.Builder setUserAgent(String userAgent)

setAllowPoolingConnections

public SimpleAsyncHttpClient.Builder setAllowPoolingConnections(boolean allowPoolingConnections)

setExecutorService

public SimpleAsyncHttpClient.Builder setExecutorService(ExecutorService applicationThreadPool)

setSSLContext

public SimpleAsyncHttpClient.Builder setSSLContext(SSLContext sslContext)

setRealmNtlmDomain

public SimpleAsyncHttpClient.Builder setRealmNtlmDomain(String domain)

setRealmPrincipal

public SimpleAsyncHttpClient.Builder setRealmPrincipal(String principal)

setRealmPassword

public SimpleAsyncHttpClient.Builder setRealmPassword(String password)

setRealmScheme

public SimpleAsyncHttpClient.Builder setRealmScheme(Realm.AuthScheme scheme)

setRealmName

public SimpleAsyncHttpClient.Builder setRealmName(String realmName)

setRealmUsePreemptiveAuth

public SimpleAsyncHttpClient.Builder setRealmUsePreemptiveAuth(boolean usePreemptiveAuth)

setRealmCharset

public SimpleAsyncHttpClient.Builder setRealmCharset(Charset charset)

setProxyProtocol

public SimpleAsyncHttpClient.Builder setProxyProtocol(ProxyServer.Protocol protocol)

setProxyHost

public SimpleAsyncHttpClient.Builder setProxyHost(String host)

setProxyPrincipal

public SimpleAsyncHttpClient.Builder setProxyPrincipal(String principal)

setProxyPassword

public SimpleAsyncHttpClient.Builder setProxyPassword(String password)

setProxyPort

public SimpleAsyncHttpClient.Builder setProxyPort(int port)

setDefaultThrowableHandler

public SimpleAsyncHttpClient.Builder setDefaultThrowableHandler(ThrowableHandler throwableHandler)

setErrorDocumentBehaviour

public SimpleAsyncHttpClient.Builder setErrorDocumentBehaviour(SimpleAsyncHttpClient.ErrorDocumentBehaviour behaviour)

This setting controls whether an error document should be written via the BodyConsumer after an error status code was received (e.g. 404). Default is SimpleAsyncHttpClient.ErrorDocumentBehaviour.WRITE.

setResumableDownload

public SimpleAsyncHttpClient.Builder setResumableDownload(boolean enableResumableDownload)

Enable resumable downloads for the SimpleAHC. Resuming downloads will only work for GET requests with an instance of ResumableBodyConsumer.

Specified by:

setResumableDownload in interface SimpleAsyncHttpClient.DerivedBuilder

setListener

public SimpleAsyncHttpClient.Builder setListener(SimpleAHCTransferListener listener)

Set the listener to notify about connection progress.

setMaxRequestRetry

public SimpleAsyncHttpClient.Builder setMaxRequestRetry(int maxRequestRetry)

Set the number of time a request will be retried when an IOException occurs because of a Network exception.

Parameters:

maxRequestRetry - the number of time a request will be retried

Returns:

this

setAcceptAnyCertificate

public SimpleAsyncHttpClient.Builder setAcceptAnyCertificate(boolean acceptAnyCertificate)

build

public SimpleAsyncHttpClient build()

Specified by:

build in interface SimpleAsyncHttpClient.DerivedBuilder