com.twitter.hbc

Class ClientBuilder

java.lang.Object

com.twitter.hbc.ClientBuilder

public class ClientBuilder
extends Object

A builder class for our BasicClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected Authentication	auth
protected int	connectionTimeoutMillis
protected boolean	enableGZip
protected StreamingEndpoint	endpoint
protected BlockingQueue<Event>	eventQueue
protected ExecutorService	executorService
protected Hosts	hosts
protected String	name
protected HosebirdMessageProcessor	processor
protected RateTracker	rateTracker
protected ReconnectionManager	reconnectionManager
protected org.apache.http.conn.scheme.SchemeRegistry	schemeRegistry
protected int	socketTimeoutMillis

Constructor Summary

Constructors

Constructor and Description
ClientBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ClientBuilder	authentication(Authentication auth)
BasicClient	build()
ClientBuilder	connectionTimeout(int millis)
ClientBuilder	endpoint(StreamingEndpoint endpoint)
ClientBuilder	endpoint(String uri, String httpMethod)
ClientBuilder	eventMessageQueue(BlockingQueue<Event> events)
ClientBuilder	gzipEnabled(boolean gzip)
ClientBuilder	hosts(Hosts hosts)
ClientBuilder	hosts(String host)
ClientBuilder	name(String name)
ClientBuilder	processor(HosebirdMessageProcessor processor)
ClientBuilder	rateTracker(RateTracker rateTracker)
ClientBuilder	reconnectionManager(ReconnectionManager manager)
ClientBuilder	retries(int retries)
ClientBuilder	schemeRegistry(org.apache.http.conn.scheme.SchemeRegistry schemeRegistry)
ClientBuilder	socketTimeout(int millis)

Methods inherited from class java.lang.Object

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

Field Detail

auth

protected Authentication auth

hosts

protected Hosts hosts

processor

protected HosebirdMessageProcessor processor

endpoint

protected StreamingEndpoint endpoint

enableGZip

protected boolean enableGZip

name

protected String name

rateTracker

protected RateTracker rateTracker

executorService

protected final ExecutorService executorService

eventQueue

protected BlockingQueue<Event> eventQueue

reconnectionManager

protected ReconnectionManager reconnectionManager

socketTimeoutMillis

protected int socketTimeoutMillis

connectionTimeoutMillis

protected int connectionTimeoutMillis

schemeRegistry

protected org.apache.http.conn.scheme.SchemeRegistry schemeRegistry

Constructor Detail

ClientBuilder

public ClientBuilder()

Method Detail

name

public ClientBuilder name(String name)

Parameters:

name - Name of the client used for logging and other diagnostic purposes.

gzipEnabled

public ClientBuilder gzipEnabled(boolean gzip)

Parameters:

gzip - Turn gzip on or off. Enabled by default

hosts

public ClientBuilder hosts(String host)

Parameters:

host - Http host in the form of ://

hosts

public ClientBuilder hosts(Hosts hosts)

endpoint

public ClientBuilder endpoint(StreamingEndpoint endpoint)

Parameters:

endpoint - StreamingEndpoint that the client will connect to

authentication

public ClientBuilder authentication(Authentication auth)

processor

public ClientBuilder processor(HosebirdMessageProcessor processor)

eventMessageQueue

public ClientBuilder eventMessageQueue(BlockingQueue<Event> events)

socketTimeout

public ClientBuilder socketTimeout(int millis)

connectionTimeout

public ClientBuilder connectionTimeout(int millis)

retries

public ClientBuilder retries(int retries)

Parameters:

retries - Number of retries to attempt when we experience retryable connection errors

reconnectionManager

public ClientBuilder reconnectionManager(ReconnectionManager manager)

endpoint

public ClientBuilder endpoint(String uri,
                     String httpMethod)

rateTracker

public ClientBuilder rateTracker(RateTracker rateTracker)

schemeRegistry

public ClientBuilder schemeRegistry(org.apache.http.conn.scheme.SchemeRegistry schemeRegistry)

build

public BasicClient build()