com.google.api.gax.rpc

Interface TransportChannelProvider

All Known Implementing Classes:

FixedTransportChannelProvider, InstantiatingGrpcChannelProvider, InstantiatingHttpJsonChannelProvider

@InternalExtensionOnly
public interface TransportChannelProvider

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.needsExecutor()) {
   transportChannelProvider = transportChannelProvider.withExecutor(executor);
 }
 if (transportChannelProvider.needsHeaders()) {
   transportChannelProvider = transportChannelProvider.withHeaders(headers);
 }
 TransportChannel transportChannel = transportChannelProvider.getTransportChannel();
 

Method Summary

Modifier and Type	Method and Description
boolean	acceptsPoolSize() Reports whether this provider allows pool size customization.
TransportChannel	getTransportChannel() Provides a Transport, which could either be a new instance for every call, or the same instance, depending on the implementation.
java.lang.String	getTransportName() The name of the transport.
boolean	needsCredentials() True if credentials are needed before channel creation.
boolean	needsEndpoint() True if the TransportProvider has no endpoint set.
boolean	needsExecutor() True if the TransportProvider needs an executor.
boolean	needsHeaders() True if the TransportProvider has no headers provided.
boolean	shouldAutoClose() Indicates whether the TransportChannel should be closed by the containing client class.
TransportChannelProvider	withCredentials(com.google.auth.Credentials credentials) Sets the credentials that will be applied before channel creation.
TransportChannelProvider	withEndpoint(java.lang.String endpoint) Sets the endpoint to use when constructing a new TransportChannel.
TransportChannelProvider	withExecutor(java.util.concurrent.Executor executor) Sets the executor to use when constructing a new TransportChannel..
TransportChannelProvider	withExecutor(java.util.concurrent.ScheduledExecutorService executor) Deprecated. Please use withExecutor(Executor).
TransportChannelProvider	withHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets the headers to use when constructing a new TransportChannel..
TransportChannelProvider	withPoolSize(int size) Number of underlying transport channels to open.

Method Detail

shouldAutoClose

boolean shouldAutoClose()

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

needsExecutor

boolean needsExecutor()

True if the TransportProvider needs an executor.

withExecutor

TransportChannelProvider withExecutor(java.util.concurrent.Executor executor)

Sets the executor to use when constructing a new TransportChannel..

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

withExecutor

@Deprecated
TransportChannelProvider withExecutor(java.util.concurrent.ScheduledExecutorService executor)

Deprecated. Please use withExecutor(Executor).

needsHeaders

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
boolean needsHeaders()

True if the TransportProvider has no headers provided.

withHeaders

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
TransportChannelProvider withHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets the headers to use when constructing a new TransportChannel..

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

needsEndpoint

boolean needsEndpoint()

True if the TransportProvider has no endpoint set.

withEndpoint

TransportChannelProvider withEndpoint(java.lang.String endpoint)

Sets the endpoint to use when constructing a new TransportChannel.

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

acceptsPoolSize

@BetaApi(value="The surface for customizing pool size is not stable yet and may change in the future.")
boolean acceptsPoolSize()

Reports whether this provider allows pool size customization.

withPoolSize

@BetaApi(value="The surface for customizing pool size is not stable yet and may change in the future.")
TransportChannelProvider withPoolSize(int size)

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

needsCredentials

@BetaApi(value="The surface to customize credentials is not stable yet and may change in the future.")
boolean needsCredentials()

True if credentials are needed before channel creation.

withCredentials

@BetaApi(value="The surface to customize credentials is not stable yet and may change in the future.")
TransportChannelProvider withCredentials(com.google.auth.Credentials credentials)

Sets the credentials that will be applied before channel creation.

getTransportChannel

TransportChannel getTransportChannel()
                              throws java.io.IOException

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.

Throws:

java.io.IOException

getTransportName

java.lang.String getTransportName()

The name of the transport.

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