Package org.glassfish.jersey.netty.connector

Class NettyConnectorProvider.Config

java.lang.Object

org.glassfish.jersey.client.innate.ConnectorConfiguration<N>

org.glassfish.jersey.netty.connector.NettyConnectorProvider.Config

Enclosing class:

NettyConnectorProvider

public static final class NettyConnectorProvider.Config
extends org.glassfish.jersey.client.innate.ConnectorConfiguration<N>

Nested Class Summary

Nested classes/interfaces inherited from class org.glassfish.jersey.client.innate.ConnectorConfiguration

org.glassfish.jersey.client.innate.ConnectorConfiguration.NullableRef<T extends Object>, org.glassfish.jersey.client.innate.ConnectorConfiguration.PrefixedConfiguration, org.glassfish.jersey.client.innate.ConnectorConfiguration.Read<CC extends org.glassfish.jersey.client.innate.ConnectorConfiguration<CC> & org.glassfish.jersey.client.innate.ConnectorConfiguration.Read<CC>>

Field Summary

Fields inherited from class org.glassfish.jersey.client.innate.ConnectorConfiguration

connectTimeout, expect100Continue, expect100continueThreshold, followRedirects, prefix, proxyPassword, proxyUri, proxyUserName, readTimeout, requestEntityProcessing, sniHostname, sslContextSupplier, threadPoolSize

Method Summary

Modifier and Type	Method	Description
NettyConnectorProvider	build()
NettyConnectorProvider.Config	connectionController(NettyConnectionController controller)	Set the connection pooling controller for the Netty Connector.
NettyConnectorProvider.Config	enableLoggingHandler(boolean enable)	Enable or disable the Netty logging by LoggingHandler(Level.DEBUG).
NettyConnectorProvider.Config	enableSslHostnameVerification(boolean enable)	Enable or disable the endpoint identification algorithm to HTTPS.
NettyConnectorProvider.Config	expect100ContinueTimeout(int millis)	This setting determines waiting time in milliseconds for 100-Continue response when 100-Continue is sent by the client.
NettyConnectorProvider.Config	filterHeadersForProxy(boolean filter)	Filter the HTTP headers for requests (CONNECT) towards the proxy except for PROXY-prefixed and HOST headers when true.
NettyConnectorProvider.Config	idleConnectionPruneTimeout(int seconds)	This property determines the number of seconds the idle connections are kept in the pool before pruned.
NettyConnectorProvider.Config	initialHttpHeaderLineLength(int length)	Set the maximum length of the first line of the HTTP header.
NettyConnectorProvider.Config	maxChunkSize(int size)	Set the maximum chunk size for the Netty connector.
NettyConnectorProvider.Config	maxConnectionsPerDestination(int maxCount)	This setting determines the maximum number of idle connections that will be simultaneously kept alive, per destination.
NettyConnectorProvider.Config	maxHeaderSize(int size)	Set the maximum header size in bytes for the HTTP headers processed by Netty.
NettyConnectorProvider.Config	maxRedirects(int max)	Set the maximum number of redirects to prevent infinite redirect loop.
NettyConnectorProvider.Config	maxTotalConnections(int max)	Set the maximum number of idle connections that will be simultaneously kept alive.
NettyConnectorProvider.Config	preserveMethodOnRedirect(boolean preserve)	Set the preservation of methods during HTTP redirect.
NettyConnectorProvider.Config	redirectController(NettyHttpRedirectController controller)	Set the Netty Connector HTTP redirect controller.
protected NettyConnectorProvider.Config	self()

Methods inherited from class org.glassfish.jersey.client.innate.ConnectorConfiguration

asyncThreadPoolSize, connectTimeout, expect100Continue, expect100ContinueThreshold, followRedirects, prefix, proxy, proxyPassword, proxyUri, proxyUri, proxyUserName, readTimeout, requestEntityProcessing, sniHostName, sslContextSupplier

Methods inherited from class java.lang.Object

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

Method Details

build

public NettyConnectorProvider build()

connectionController

public NettyConnectorProvider.Config connectionController(NettyConnectionController controller)

Set the connection pooling controller for the Netty Connector.

Parameters:

controller - the connection pooling controller.

Returns:

updated configuration.

expect100ContinueTimeout

public NettyConnectorProvider.Config expect100ContinueTimeout(int millis)

This setting determines waiting time in milliseconds for 100-Continue response when 100-Continue is sent by the client. The property NettyClientProperties.EXPECT_100_CONTINUE_TIMEOUT has precedence over this setting.

Parameters:

millis - the timeout for 100-Continue response.

Returns:

updated configuration.

enableSslHostnameVerification

public NettyConnectorProvider.Config enableSslHostnameVerification(boolean enable)

Enable or disable the endpoint identification algorithm to HTTPS. The property NettyClientProperties.ENABLE_SSL_HOSTNAME_VERIFICATION takes precedence over this setting.

Parameters:

enable - enable or disable the hostname verification.

Returns:

updated configuration.

enableLoggingHandler

public NettyConnectorProvider.Config enableLoggingHandler(boolean enable)

Enable or disable the Netty logging by LoggingHandler(Level.DEBUG). Disabled by default. The property NettyClientProperties.LOGGING_ENABLED takes precedence over this setting.

Parameters:

enable - to enable or disable.

Returns:

updated configuration.

filterHeadersForProxy

public NettyConnectorProvider.Config filterHeadersForProxy(boolean filter)

Filter the HTTP headers for requests (CONNECT) towards the proxy except for PROXY-prefixed and HOST headers when true. The property NettyClientProperties.FILTER_HEADERS_FOR_PROXY has precedence over this setting.

Parameters:

filter - to filter or not. The default is true.

Returns:

updated configuration.

idleConnectionPruneTimeout

public NettyConnectorProvider.Config idleConnectionPruneTimeout(int seconds)

This property determines the number of seconds the idle connections are kept in the pool before pruned. The default is 60. Specify 0 to disable. The property NettyClientProperties.IDLE_CONNECTION_PRUNE_TIMEOUT has precedence over this setting.

Parameters:

seconds - the timeout in seconds.

Returns:

updated configuration.

initialHttpHeaderLineLength

public NettyConnectorProvider.Config initialHttpHeaderLineLength(int length)

Set the maximum length of the first line of the HTTP header. The property NettyClientProperties.MAX_INITIAL_LINE_LENGTH has precedence over this setting.

Parameters:

length - the length of the first line of the HTTP header.

Returns:

updated configuration.

maxChunkSize

public NettyConnectorProvider.Config maxChunkSize(int size)

Set the maximum chunk size for the Netty connector. The property NettyClientProperties.MAX_CHUNK_SIZE has precedence over this setting.

Parameters:

size - the new size of chunks.

Returns:

updated configuration.

maxConnectionsPerDestination

public NettyConnectorProvider.Config maxConnectionsPerDestination(int maxCount)

This setting determines the maximum number of idle connections that will be simultaneously kept alive, per destination. The default is 5. The property NettyClientProperties.MAX_CONNECTIONS takes precedence over this setting.

Parameters:

maxCount - maximum number of idle connections per destination.

Returns:

updated configuration.

maxHeaderSize

public NettyConnectorProvider.Config maxHeaderSize(int size)

Set the maximum header size in bytes for the HTTP headers processed by Netty. The property NettyClientProperties.MAX_HEADER_SIZE has precedence over this setting.

Parameters:

size - the new maximum header size.

Returns:

updated configuration.

maxRedirects

public NettyConnectorProvider.Config maxRedirects(int max)

Set the maximum number of redirects to prevent infinite redirect loop. The default is 5. The property NettyClientProperties.MAX_REDIRECTS has precedence over this setting.

Parameters:

max - the maximum number of redirects.

Returns:

updated configuration.

maxTotalConnections

public NettyConnectorProvider.Config maxTotalConnections(int max)

Set the maximum number of idle connections that will be simultaneously kept alive. The property NettyClientProperties.MAX_CONNECTIONS_TOTAL has precedence over this setting.

Parameters:

max - the maximum number of idle connections.

Returns:

updated configuration.

preserveMethodOnRedirect

public NettyConnectorProvider.Config preserveMethodOnRedirect(boolean preserve)

Set the preservation of methods during HTTP redirect. By default, the HTTP POST request are not transformed into HTTP GET for status 301 & 302. The property NettyClientProperties.PRESERVE_METHOD_ON_REDIRECT has precedence over this setting.

Parameters:

preserve - to preserve or not to preserve.

Returns:

updated configuration.

redirectController

public NettyConnectorProvider.Config redirectController(NettyHttpRedirectController controller)

Set the Netty Connector HTTP redirect controller. The property NettyClientProperties.HTTP_REDIRECT_CONTROLLER has precedence over this setting.

Parameters:

controller - the HTTP redirect controller.

Returns:

updated configuration.

self

protected NettyConnectorProvider.Config self()

Overrides:

self in class org.glassfish.jersey.client.innate.ConnectorConfiguration<N extends org.glassfish.jersey.netty.connector.NettyConnectorConfiguration<N>>