org.glassfish.jersey.client

Class HttpUrlConnectorProvider

java.lang.Object

org.glassfish.jersey.client.HttpUrlConnectorProvider

All Implemented Interfaces:

ConnectorProvider

public class HttpUrlConnectorProvider
extends Object
implements ConnectorProvider

Default Jersey client connector provider that provides connector instances which delegate HTTP requests to HttpURLConnection for processing.

The provided connector instances override default behaviour of the property ClientProperties.REQUEST_ENTITY_PROCESSING and use RequestEntityProcessing.BUFFERED request entity processing by default.

Due to a bug in the chunked transport coding support of HttpURLConnection that causes requests to fail unpredictably, this connector provider allows to configure the provided connector instances to use HttpURLConnection's fixed-length streaming mode as a workaround. This workaround can be enabled via useFixedLengthStreaming() method or via USE_FIXED_LENGTH_STREAMING Jersey client configuration property.

Author:

Marek Potociar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpUrlConnectorProvider.ConnectionFactory A factory for HttpURLConnection instances.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SET_METHOD_WORKAROUND A value of true declares that the client will try to set unsupported HTTP method to HttpURLConnection via reflection as a workaround for a missing HTTP method.
static String	USE_FIXED_LENGTH_STREAMING If true, the HttpUrlConnector (if used) will assume the content length from the value of "Content-Length" request header (if present).

Constructor Summary

Constructors

Constructor and Description
HttpUrlConnectorProvider() Create new HttpURLConnection-based Jersey client connector provider.

Method Summary

Modifier and Type	Method and Description
HttpUrlConnectorProvider	chunkSize(int chunkSize) Set chunk size for requests transferred using a HTTP chunked transfer coding.
HttpUrlConnectorProvider	connectionFactory(HttpUrlConnectorProvider.ConnectionFactory connectionFactory) Set a custom HttpURLConnection factory.
protected Connector	createHttpUrlConnector(Client client, HttpUrlConnectorProvider.ConnectionFactory connectionFactory, int chunkSize, boolean fixLengthStreaming, boolean setMethodWorkaround) Create HttpUrlConnector.
boolean	equals(Object o)
Connector	getConnector(Client client, Configuration config) Get a Jersey client connector instance for a given client instance and Jersey client runtime configuration.
int	hashCode()
HttpUrlConnectorProvider	useFixedLengthStreaming() Instruct the provided connectors to use the fixed-length streaming mode on the underlying HTTP URL connection instance when sending requests.
HttpUrlConnectorProvider	useSetMethodWorkaround() Instruct the provided connectors to use reflection when setting the HTTP method value.See SET_METHOD_WORKAROUND property documentation for more details.

Methods inherited from class java.lang.Object

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

Field Detail

USE_FIXED_LENGTH_STREAMING

public static final String USE_FIXED_LENGTH_STREAMING

If true, the HttpUrlConnector (if used) will assume the content length from the value of "Content-Length" request header (if present).

When this property is enabled and the request has a valid non-zero content length value specified in its "Content-Length" request header, that this value will be used as an input to the HttpURLConnection.setFixedLengthStreamingMode(int) method call invoked on the underlying connection. This will also suppress the entity buffering in the @{code HttpURLConnection}, which is undesirable in certain scenarios, e.g. when streaming large entities.

Note that the content length value defined in the request header must exactly match the real size of the entity. If the HttpHeaders.CONTENT_LENGTH header is explicitly specified in a request, this property will be ignored and the request entity will be still buffered by the underlying @{code HttpURLConnection} infrastructure.

This property also overrides the behaviour enabled by the ClientProperties.CHUNKED_ENCODING_SIZE property. Chunked encoding will only be used, if the size is not specified in the header of the request.

Note that this property only applies to client run-times that are configured to use the default HttpUrlConnector as the client connector. The property is ignored by other connectors.

The default value is false.

The name of the configuration property is "jersey.config.client.httpUrlConnector.useFixedLengthStreaming".

Since:

2.5

See Also:

Constant Field Values

SET_METHOD_WORKAROUND

public static final String SET_METHOD_WORKAROUND

A value of true declares that the client will try to set unsupported HTTP method to HttpURLConnection via reflection as a workaround for a missing HTTP method.

NOTE: Enabling this property may cause security related warnings/errors and it may break when other JDK implementation is used. Use only when you know what you are doing.

The value MUST be an instance of Boolean.

The default value is false.

The name of the configuration property is "jersey.config.client.httpUrlConnection.setMethodWorkaround".

Since JDK 16 the JDK internal classes are not opened for reflection and the workaround method does not work, unless --add-opens java.base/java.net=ALL-UNNAMED for HTTP requests and additional --add-opens java.base/sun.net.www.protocol.https=ALL-UNNAMED for HTTPS (HttpsUrlConnection) options are set.

See Also:

Constant Field Values

Constructor Detail

HttpUrlConnectorProvider

public HttpUrlConnectorProvider()

Create new HttpURLConnection-based Jersey client connector provider.

Method Detail

connectionFactory

public HttpUrlConnectorProvider connectionFactory(HttpUrlConnectorProvider.ConnectionFactory connectionFactory)

Set a custom HttpURLConnection factory.

Parameters:

connectionFactory - custom HTTP URL connection factory. Must not be null.

Returns:

updated connector provider instance.

Throws:

NullPointerException - in case the supplied connectionFactory is null.

chunkSize

public HttpUrlConnectorProvider chunkSize(int chunkSize)

Set chunk size for requests transferred using a HTTP chunked transfer coding. If no value is set, the default chunk size of 4096 bytes will be used.

Note that this programmatically set value can be overridden by setting the ClientProperties.CHUNKED_ENCODING_SIZE property specified in the Jersey client instance configuration.

Parameters:

chunkSize - chunked transfer coding chunk size to be used.

Returns:

updated connector provider instance.

Throws:

IllegalArgumentException - in case the specified chunk size is negative.

useFixedLengthStreaming

public HttpUrlConnectorProvider useFixedLengthStreaming()

Instruct the provided connectors to use the fixed-length streaming mode on the underlying HTTP URL connection instance when sending requests. See USE_FIXED_LENGTH_STREAMING property documentation for more details.

Note that this programmatically set value can be overridden by setting the USE_FIXED_LENGTH_STREAMING property specified in the Jersey client instance configuration.

Returns:

updated connector provider instance.

useSetMethodWorkaround

public HttpUrlConnectorProvider useSetMethodWorkaround()

Instruct the provided connectors to use reflection when setting the HTTP method value.See SET_METHOD_WORKAROUND property documentation for more details.

Note that this programmatically set value can be overridden by setting the SET_METHOD_WORKAROUND property specified in the Jersey client instance configuration or in the request properties.

Returns:

updated connector provider instance.

getConnector

public Connector getConnector(Client client,
                              Configuration config)

Description copied from interface: ConnectorProvider

Get a Jersey client connector instance for a given client instance and Jersey client runtime configuration.

Note that the supplied runtime configuration can be different from the client instance configuration as a single client can be used to serve multiple differently configured runtimes. While the SSL context or hostname verifier are shared, other configuration properties may change in each runtime.

Based on the supplied client and runtime configuration data, it is up to each connector provider implementation to decide whether a new dedicated connector instance is required or if the existing, previously create connector instance can be reused.

Specified by:

getConnector in interface ConnectorProvider

Parameters:

client - Jersey client instance.

config - Jersey client runtime configuration.

Returns:

configured Connector instance to be used by the client.

createHttpUrlConnector

protected Connector createHttpUrlConnector(Client client,
                                           HttpUrlConnectorProvider.ConnectionFactory connectionFactory,
                                           int chunkSize,
                                           boolean fixLengthStreaming,
                                           boolean setMethodWorkaround)

Create HttpUrlConnector.

Parameters:

client - JAX-RS client instance for which the connector is being created.

connectionFactory - HttpsURLConnection factory to be used when creating connections.

chunkSize - chunk size to use when using HTTP chunked transfer coding.

fixLengthStreaming - specify if the the fixed-length streaming mode on the underlying HTTP URL connection instances should be used when sending requests.

setMethodWorkaround - specify if the reflection workaround should be used to set HTTP URL connection method name. See SET_METHOD_WORKAROUND for details.

Returns:

created HttpUrlConnector instance.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object