com.linkedin.r2.transport.http.client

Class HttpClientFactory

java.lang.Object

com.linkedin.r2.transport.http.client.HttpClientFactory

All Implemented Interfaces:

com.linkedin.r2.transport.common.TransportClientFactory

public class HttpClientFactory
extends java.lang.Object
implements com.linkedin.r2.transport.common.TransportClientFactory

A factory for HttpNettyClient instances. All clients created by the factory will share the same resources, in particular the EventLoopGroup and ScheduledExecutorService. In order to shutdown cleanly, all clients issued by the factory should be shutdown via TransportClient.shutdown(com.linkedin.common.callback.Callback) and the factory itself should be shut down via one of the following two methods:

• shutdown(com.linkedin.common.callback.Callback)
• shutdown(com.linkedin.common.callback.Callback, long, java.util.concurrent.TimeUnit)

See the method descriptions for more details. Note that factory shutdown and shutdown of the clients can be initiated in any order.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpClientFactory.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CHANNELPOOL_WAITER_TIMEOUT
static java.lang.String	DEFAULT_CLIENT_NAME
static int	DEFAULT_CONNECT_TIMEOUT
static int	DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT
static long	DEFAULT_IDLE_TIMEOUT
static int	DEFAULT_MAX_CHUNK_SIZE
static double	DEFAULT_MAX_CLIENT_REQUEST_RETRY_RATIO
static int	DEFAULT_MAX_CONCURRENT_CONNECTIONS
static int	DEFAULT_MAX_HEADER_SIZE
static long	DEFAULT_MAX_RESPONSE_SIZE
static int	DEFAULT_MINIMUM_STREAMING_TIMEOUT
static int	DEFAULT_POOL_MIN_SIZE
static int	DEFAULT_POOL_SIZE
static java.lang.String	DEFAULT_POOL_STATS_NAME_PREFIX
static com.linkedin.r2.transport.http.client.AsyncPoolImpl.Strategy	DEFAULT_POOL_STRATEGY
static int	DEFAULT_POOL_WAITER_SIZE
static int	DEFAULT_QUERY_POST_THRESHOLD
static int	DEFAULT_REQUEST_TIMEOUT
static com.linkedin.r2.filter.compression.EncodingType[]	DEFAULT_RESPONSE_CONTENT_ENCODINGS
static boolean	DEFAULT_SHARE_CONNECTION
static int	DEFAULT_SHUTDOWN_TIMEOUT
static int	DEFAULT_SSL_HANDSHAKE_TIMEOUT
static long	DEFAULT_SSL_IDLE_TIMEOUT
static com.linkedin.r2.filter.compression.streaming.StreamEncodingType[]	DEFAULT_STREAM_RESPONSE_CONTENT_ENCODINGS
static int	DEFAULT_STREAMING_TIMEOUT
static boolean	DEFAULT_TCP_NO_DELAY
static java.lang.String	HTTP_GRACEFUL_SHUTDOWN_TIMEOUT
static java.lang.String	HTTP_IDLE_TIMEOUT
static java.lang.String	HTTP_MAX_CHUNK_SIZE
static java.lang.String	HTTP_MAX_CLIENT_REQUEST_RETRY_RATIO
static java.lang.String	HTTP_MAX_CONCURRENT_CONNECTIONS
static java.lang.String	HTTP_MAX_HEADER_SIZE
static java.lang.String	HTTP_MAX_RESPONSE_SIZE
static java.lang.String	HTTP_POOL_MIN_SIZE
static java.lang.String	HTTP_POOL_SIZE
static java.lang.String	HTTP_POOL_STATS_NAME_PREFIX
static java.lang.String	HTTP_POOL_STRATEGY
static java.lang.String	HTTP_POOL_WAITER_SIZE
static java.lang.String	HTTP_PROTOCOL_VERSION
static java.lang.String	HTTP_QUERY_POST_THRESHOLD
static java.lang.String	HTTP_REQUEST_CONTENT_ENCODINGS
static java.lang.String	HTTP_REQUEST_TIMEOUT
static java.lang.String	HTTP_RESPONSE_COMPRESSION_OPERATIONS
static java.lang.String	HTTP_RESPONSE_CONTENT_ENCODINGS
static java.lang.String	HTTP_SERVICE_NAME
static java.lang.String	HTTP_SHUTDOWN_TIMEOUT
static java.lang.String	HTTP_SSL_CONTEXT
static java.lang.String	HTTP_SSL_IDLE_TIMEOUT
static java.lang.String	HTTP_SSL_PARAMS
static java.lang.String	HTTP_STREAMING_TIMEOUT
static java.lang.String	HTTP_TCP_NO_DELAY
static java.lang.String	HTTP_USE_RESPONSE_COMPRESSION
static int	PIPELINE_V2_MATURITY_LEVEL Helper constant to allow specify which version of pipeline v2 the code is running on.
static double	UNLIMITED_CLIENT_REQUEST_RETRY_RATIO

Constructor Summary

Constructors

Constructor and Description
HttpClientFactory() Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(java.util.concurrent.ExecutorService callbackExecutor, boolean shutdownCallbackExecutor) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, boolean deprecatedTcpNoDelay) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, boolean deprecatedTcpNoDelay, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.concurrent.Executor compressionExecutor) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, boolean useClientCompression) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, boolean useClientCompression) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, boolean deprecatedTcpNoDelay, java.util.concurrent.Executor compressionExecutor) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, boolean deprecatedTcpNoDelay, java.util.concurrent.Executor compressionExecutor, com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, java.util.concurrent.Executor compressionExecutor, com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, java.util.concurrent.Executor compressionExecutor, com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion, boolean shareConnection) Deprecated. Use HttpClientFactory.Builder instead.
HttpClientFactory(com.linkedin.r2.filter.FilterChain filters, io.netty.channel.EventLoopGroup eventLoopGroup, boolean shutdownFactory, java.util.concurrent.ScheduledExecutorService executor, boolean shutdownExecutor, java.util.concurrent.ExecutorService callbackExecutorGroup, boolean shutdownCallbackExecutor, com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager, int requestCompressionThresholdDefault, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs, java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs, java.util.concurrent.Executor compressionExecutor, com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion, boolean shareConnection, com.linkedin.r2.event.EventProviderRegistry eventProviderRegistry) Deprecated. Use HttpClientFactory.Builder instead.

Method Summary

Modifier and Type	Method and Description
com.linkedin.r2.transport.common.bridge.client.TransportClient	getClient(java.util.Map<java.lang.String,? extends java.lang.Object> properties)
void	shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback) Initiates an orderly shutdown of the factory wherein no more clients will be created, and the shutdown will complete when all existing clients have been shut down.
void	shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback, long timeout, java.util.concurrent.TimeUnit timeoutUnit) Initiates an orderly shutdown similar to shutdown(com.linkedin.common.callback.Callback).

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_QUERY_POST_THRESHOLD

public static final java.lang.String HTTP_QUERY_POST_THRESHOLD

See Also:

Constant Field Values

HTTP_REQUEST_TIMEOUT

public static final java.lang.String HTTP_REQUEST_TIMEOUT

See Also:

Constant Field Values

HTTP_STREAMING_TIMEOUT

public static final java.lang.String HTTP_STREAMING_TIMEOUT

See Also:

Constant Field Values

HTTP_MAX_RESPONSE_SIZE

public static final java.lang.String HTTP_MAX_RESPONSE_SIZE

See Also:

Constant Field Values

HTTP_POOL_SIZE

public static final java.lang.String HTTP_POOL_SIZE

See Also:

Constant Field Values

HTTP_POOL_WAITER_SIZE

public static final java.lang.String HTTP_POOL_WAITER_SIZE

See Also:

Constant Field Values

HTTP_IDLE_TIMEOUT

public static final java.lang.String HTTP_IDLE_TIMEOUT

See Also:

Constant Field Values

HTTP_SSL_IDLE_TIMEOUT

public static final java.lang.String HTTP_SSL_IDLE_TIMEOUT

See Also:

Constant Field Values

HTTP_SHUTDOWN_TIMEOUT

public static final java.lang.String HTTP_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

HTTP_GRACEFUL_SHUTDOWN_TIMEOUT

public static final java.lang.String HTTP_GRACEFUL_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

HTTP_SSL_CONTEXT

public static final java.lang.String HTTP_SSL_CONTEXT

See Also:

Constant Field Values

HTTP_SSL_PARAMS

public static final java.lang.String HTTP_SSL_PARAMS

See Also:

Constant Field Values

HTTP_RESPONSE_COMPRESSION_OPERATIONS

public static final java.lang.String HTTP_RESPONSE_COMPRESSION_OPERATIONS

See Also:

Constant Field Values

HTTP_RESPONSE_CONTENT_ENCODINGS

public static final java.lang.String HTTP_RESPONSE_CONTENT_ENCODINGS

See Also:

Constant Field Values

HTTP_REQUEST_CONTENT_ENCODINGS

public static final java.lang.String HTTP_REQUEST_CONTENT_ENCODINGS

See Also:

Constant Field Values

HTTP_USE_RESPONSE_COMPRESSION

public static final java.lang.String HTTP_USE_RESPONSE_COMPRESSION

See Also:

Constant Field Values

HTTP_SERVICE_NAME

public static final java.lang.String HTTP_SERVICE_NAME

See Also:

Constant Field Values

HTTP_POOL_STATS_NAME_PREFIX

public static final java.lang.String HTTP_POOL_STATS_NAME_PREFIX

See Also:

Constant Field Values

HTTP_POOL_STRATEGY

public static final java.lang.String HTTP_POOL_STRATEGY

See Also:

Constant Field Values

HTTP_POOL_MIN_SIZE

public static final java.lang.String HTTP_POOL_MIN_SIZE

See Also:

Constant Field Values

HTTP_MAX_HEADER_SIZE

public static final java.lang.String HTTP_MAX_HEADER_SIZE

See Also:

Constant Field Values

HTTP_MAX_CHUNK_SIZE

public static final java.lang.String HTTP_MAX_CHUNK_SIZE

See Also:

Constant Field Values

HTTP_MAX_CONCURRENT_CONNECTIONS

public static final java.lang.String HTTP_MAX_CONCURRENT_CONNECTIONS

See Also:

Constant Field Values

HTTP_TCP_NO_DELAY

public static final java.lang.String HTTP_TCP_NO_DELAY

See Also:

Constant Field Values

HTTP_PROTOCOL_VERSION

public static final java.lang.String HTTP_PROTOCOL_VERSION

See Also:

Constant Field Values

HTTP_MAX_CLIENT_REQUEST_RETRY_RATIO

public static final java.lang.String HTTP_MAX_CLIENT_REQUEST_RETRY_RATIO

See Also:

Constant Field Values

DEFAULT_QUERY_POST_THRESHOLD

public static final int DEFAULT_QUERY_POST_THRESHOLD

See Also:

Constant Field Values

DEFAULT_POOL_WAITER_SIZE

public static final int DEFAULT_POOL_WAITER_SIZE

See Also:

Constant Field Values

DEFAULT_POOL_SIZE

public static final int DEFAULT_POOL_SIZE

See Also:

Constant Field Values

DEFAULT_REQUEST_TIMEOUT

public static final int DEFAULT_REQUEST_TIMEOUT

See Also:

Constant Field Values

DEFAULT_STREAMING_TIMEOUT

public static final int DEFAULT_STREAMING_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MINIMUM_STREAMING_TIMEOUT

public static final int DEFAULT_MINIMUM_STREAMING_TIMEOUT

See Also:

Constant Field Values

DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT

public static final int DEFAULT_GRACEFUL_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

DEFAULT_IDLE_TIMEOUT

public static final long DEFAULT_IDLE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SSL_IDLE_TIMEOUT

public static final long DEFAULT_SSL_IDLE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SHUTDOWN_TIMEOUT

public static final int DEFAULT_SHUTDOWN_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_RESPONSE_SIZE

public static final long DEFAULT_MAX_RESPONSE_SIZE

See Also:

Constant Field Values

DEFAULT_CLIENT_NAME

public static final java.lang.String DEFAULT_CLIENT_NAME

See Also:

Constant Field Values

DEFAULT_POOL_STATS_NAME_PREFIX

public static final java.lang.String DEFAULT_POOL_STATS_NAME_PREFIX

See Also:

Constant Field Values

DEFAULT_POOL_STRATEGY

public static final com.linkedin.r2.transport.http.client.AsyncPoolImpl.Strategy DEFAULT_POOL_STRATEGY

DEFAULT_POOL_MIN_SIZE

public static final int DEFAULT_POOL_MIN_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_HEADER_SIZE

public static final int DEFAULT_MAX_HEADER_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_CHUNK_SIZE

public static final int DEFAULT_MAX_CHUNK_SIZE

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final int DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_SSL_HANDSHAKE_TIMEOUT

public static final int DEFAULT_SSL_HANDSHAKE_TIMEOUT

See Also:

Constant Field Values

DEFAULT_CHANNELPOOL_WAITER_TIMEOUT

public static final int DEFAULT_CHANNELPOOL_WAITER_TIMEOUT

See Also:

Constant Field Values

DEFAULT_MAX_CLIENT_REQUEST_RETRY_RATIO

public static final double DEFAULT_MAX_CLIENT_REQUEST_RETRY_RATIO

See Also:

Constant Field Values

UNLIMITED_CLIENT_REQUEST_RETRY_RATIO

public static final double UNLIMITED_CLIENT_REQUEST_RETRY_RATIO

See Also:

Constant Field Values

PIPELINE_V2_MATURITY_LEVEL

public static final int PIPELINE_V2_MATURITY_LEVEL

Helper constant to allow specify which version of pipeline v2 the code is running on. Since it is a feature in active development, we want to be able to enable the pipeline through configs, only for clients that have loaded a specific version of code

See Also:

Constant Field Values

DEFAULT_TCP_NO_DELAY

public static final boolean DEFAULT_TCP_NO_DELAY

See Also:

Constant Field Values

DEFAULT_SHARE_CONNECTION

public static final boolean DEFAULT_SHARE_CONNECTION

See Also:

Constant Field Values

DEFAULT_MAX_CONCURRENT_CONNECTIONS

public static final int DEFAULT_MAX_CONCURRENT_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_RESPONSE_CONTENT_ENCODINGS

public static final com.linkedin.r2.filter.compression.EncodingType[] DEFAULT_RESPONSE_CONTENT_ENCODINGS

DEFAULT_STREAM_RESPONSE_CONTENT_ENCODINGS

public static final com.linkedin.r2.filter.compression.streaming.StreamEncodingType[] DEFAULT_STREAM_RESPONSE_CONTENT_ENCODINGS

Constructor Detail

HttpClientFactory

@Deprecated
public HttpClientFactory()

Deprecated. Use HttpClientFactory.Builder instead.

Construct a new instance using an empty filter chain.

HttpClientFactory

@Deprecated
public HttpClientFactory(java.util.concurrent.ExecutorService callbackExecutor,
                                     boolean shutdownCallbackExecutor)

Deprecated. Use HttpClientFactory.Builder instead.

Construct a new instance with a specified callback executor.

Parameters:

callbackExecutor - an optional executor to invoke user callbacks that otherwise will be invoked by scheduler executor.

shutdownCallbackExecutor - if true, the callback executor will be shut down when this factory is shut down

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters)

Deprecated. Use HttpClientFactory.Builder instead.

Construct a new instance using the specified filter chain.

Parameters:

filters - the FilterChain shared by all Clients created by this factory.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor)

Deprecated. Use HttpClientFactory.Builder instead.

Creates a new HttpClientFactory.

Parameters:

filters - the filter chain shared by all Clients created by this factory

eventLoopGroup - the EventLoopGroup that all Clients created by this factory will share

shutdownFactory - if true, the channelFactory will be shut down when this factory is shut down

executor - an executor shared by all Clients created by this factory to schedule tasks

shutdownExecutor - if true, the executor will be shut down when this factory is shut down

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor)

Deprecated. Use HttpClientFactory.Builder instead.

Creates a new HttpClientFactory.

Parameters:

filters - the filter chain shared by all Clients created by this factory

eventLoopGroup - the EventLoopGroup that all Clients created by this factory will share

shutdownFactory - if true, the channelFactory will be shut down when this factory is shut down

executor - an executor shared by all Clients created by this factory to schedule tasks

shutdownExecutor - if true, the executor will be shut down when this factory is shut down

callbackExecutorGroup - an optional executor group to execute user callbacks that otherwise will be executed by eventLoopGroup.

shutdownCallbackExecutor - if true, the callback executor will be shut down when this factory is shut down

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     boolean useClientCompression)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     boolean useClientCompression)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     boolean deprecatedTcpNoDelay)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     boolean deprecatedTcpNoDelay,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.concurrent.Executor compressionExecutor)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     boolean deprecatedTcpNoDelay,
                                     java.util.concurrent.Executor compressionExecutor)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     boolean deprecatedTcpNoDelay,
                                     java.util.concurrent.Executor compressionExecutor,
                                     com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     java.util.concurrent.Executor compressionExecutor,
                                     com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     java.util.concurrent.Executor compressionExecutor,
                                     com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion,
                                     boolean shareConnection)

Deprecated. Use HttpClientFactory.Builder instead.

HttpClientFactory

@Deprecated
public HttpClientFactory(com.linkedin.r2.filter.FilterChain filters,
                                     io.netty.channel.EventLoopGroup eventLoopGroup,
                                     boolean shutdownFactory,
                                     java.util.concurrent.ScheduledExecutorService executor,
                                     boolean shutdownExecutor,
                                     java.util.concurrent.ExecutorService callbackExecutorGroup,
                                     boolean shutdownCallbackExecutor,
                                     com.linkedin.r2.transport.http.client.AbstractJmxManager jmxManager,
                                     int requestCompressionThresholdDefault,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> requestCompressionConfigs,
                                     java.util.Map<java.lang.String,com.linkedin.r2.filter.CompressionConfig> responseCompressionConfigs,
                                     java.util.concurrent.Executor compressionExecutor,
                                     com.linkedin.r2.transport.http.common.HttpProtocolVersion defaultHttpVersion,
                                     boolean shareConnection,
                                     com.linkedin.r2.event.EventProviderRegistry eventProviderRegistry)

Deprecated. Use HttpClientFactory.Builder instead.

Method Detail

getClient

public com.linkedin.r2.transport.common.bridge.client.TransportClient getClient(java.util.Map<java.lang.String,? extends java.lang.Object> properties)

Specified by:

getClient in interface com.linkedin.r2.transport.common.TransportClientFactory

shutdown

public void shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback)

Initiates an orderly shutdown of the factory wherein no more clients will be created, and the shutdown will complete when all existing clients have been shut down. If some clients fail to shutdown, the factory will never shut down. Shutdown of the clients must be initiated independently, but can occur before or after factory shutdown is initiated. After all clients have shut down, the ClientSocketChannelFactory and ScheduledExecutorService will be shut down, if these options were selected at construction time.

Specified by:

shutdown in interface com.linkedin.r2.transport.common.TransportClientFactory

Parameters:

callback - invoked after all outstanding clients and this factory have completed shutdown

shutdown

public void shutdown(com.linkedin.common.callback.Callback<com.linkedin.common.util.None> callback,
                     long timeout,
                     java.util.concurrent.TimeUnit timeoutUnit)

Initiates an orderly shutdown similar to shutdown(com.linkedin.common.callback.Callback). However, in the case that some clients fail to shutdown, the factory shutdown will still complete after the specified timeout.

Parameters:

callback - invoked after all clients shutdown (or the timeout expires) and the factory has shut down

timeout - the timeout

timeoutUnit - the timeout unit