Interface TransportChannelProvider (2.18.7)

Provides an interface to either build a TransportChannel or provide a fixed TransportChannel that will be used to make calls to a service.

Implementations of TransportChannelProvider may choose to create a new TransportChannel for each call to #getTransportChannel, or may return a fixed TransportChannel instance.

Callers should use the following pattern to get a channel:

 TransportChannelProvider transportChannelProvider = ...;
 if (transportChannelProvider.needsHeaders()) {
   transportChannelProvider = transportChannelProvider.withHeaders(headers);
 }
 // optional: set executor for TransportChannel
 transportChannelProvider.withExecutor(executor);
 TransportChannel transportChannel = transportChannelProvider.getTransportChannel();
 

Deprecated. Pool settings should be configured on the builder of the specific implementation.

Reports whether this provider allows pool size customization.

Provides a Transport, which could either be a new instance for every call, or the same instance, depending on the implementation.

If #needsExecutor() is true, then #withExecutor(Executor) needs to be called first to provide an executor.

If #needsHeaders() is true, then #withHeaders(Map) needs to be called first to provide headers.

if #needsEndpoint() is true, then #withEndpoint(String) needs to be called first to provide an endpoint.

The name of the transport.

This string can be used for identifying transports for switching logic.

True if credentials are needed before channel creation.

True if the TransportProvider has no endpoint set.

Deprecated. Channel providers will have default executors if they need one.

True if the TransportProvider needs an executor.

True if the TransportProvider has no headers provided.

Indicates whether the TransportChannel should be closed by the containing client class.

Sets the credentials that will be applied before channel creation.

Sets the endpoint to use when constructing a new TransportChannel.

This method should only be called if #needsEndpoint() returns true.

Sets the executor to use when constructing a new TransportChannel.

Deprecated. Please use #withExecutor(Executor).

Sets the headers to use when constructing a new TransportChannel.

This method should only be called if #needsHeaders() returns true.

Deprecated. Pool settings should be configured on the builder of the specific implementation.

Number of underlying transport channels to open. Calls will be load balanced across them.