org.glassfish.jersey.client.spi

Interface ConnectorProvider

All Known Implementing Classes:

Apache5ConnectorProvider, ApacheConnectorProvider, CachingConnectorProvider, GrizzlyConnectorProvider, HttpUrlConnectorProvider, JdkConnectorProvider, JettyConnectorProvider, NettyConnectorProvider

public interface ConnectorProvider

Jersey client connector provider contract. Connector provider is invoked by Jersey client runtime to provide a client connector to be used to send client requests over the wire to server-side resources. There can be only one connector provider registered in a single Jersey client instance.

Note that unlike most of the other Jersey SPI extension contracts, ConnectorProvider is not a typical runtime extension and as such cannot be registered using a configuration register(...) method. Instead, it must be registered using via JerseyClientBuilder using it's ClientConfig.connectorProvider(ConnectorProvider) initializer method.

Since:

2.5

Author:

Marek Potociar

Method Summary

Modifier and Type	Method and Description
Connector	getConnector(jakarta.ws.rs.client.Client client, jakarta.ws.rs.core.Configuration runtimeConfig) Get a Jersey client connector instance for a given client instance and Jersey client runtime configuration.

Method Detail

getConnector

Connector getConnector(jakarta.ws.rs.client.Client client,
                       jakarta.ws.rs.core.Configuration runtimeConfig)

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.

Parameters:

client - Jersey client instance.

runtimeConfig - Jersey client runtime configuration.

Returns:

configured Connector instance to be used by the client.