nl.topicus.jdbc.shaded.io.grpc.ManagedChannelBuilder Maven / Gradle / Ivy
Show all versions of spanner-jdbc Show documentation
/*
* Copyright 2015, gRPC Authors All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package nl.topicus.jdbc.shaded.io.grpc;
import java.util.List;
import java.util.concurrent.Executor;
import java.util.concurrent.TimeUnit;
/**
* A builder for {@link ManagedChannel} instances.
*
* @param The concrete type of this builder.
*/
public abstract class ManagedChannelBuilder> {
/**
* Creates a channel with the target's address and port number.
*
* @see #forTarget(String)
* @since 1.0.0
*/
public static ManagedChannelBuilder forAddress(String name, int port) {
return ManagedChannelProvider.provider().builderForAddress(name, port);
}
/**
* Creates a channel with a target string, which can be either a valid {@link
* NameResolver}-compliant URI, or an authority string.
*
* A {@code NameResolver}-compliant URI is an absolute hierarchical URI as defined by {@link
* java.net.URI}. Example URIs:
*
* - {@code "dns:///foo.googleapis.com:8080"}
* - {@code "dns:///foo.googleapis.com"}
* - {@code "dns:///%5B2001:db8:85a3:8d3:1319:8a2e:370:7348%5D:443"}
* - {@code "dns://8.8.8.8/foo.googleapis.com:8080"}
* - {@code "dns://8.8.8.8/foo.googleapis.com"}
* - {@code "zookeeper://zk.example.com:9900/example_service"}
*
*
* An authority string will be converted to a {@code NameResolver}-compliant URI, which has
* {@code "dns"} as the scheme, no authority, and the original authority string as its path after
* properly escaped. Example authority strings:
*
* - {@code "localhost"}
* - {@code "127.0.0.1"}
* - {@code "localhost:8080"}
* - {@code "foo.googleapis.com:8080"}
* - {@code "127.0.0.1:8080"}
* - {@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]"}
* - {@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"}
*
*
* @since 1.0.0
*/
public static ManagedChannelBuilder forTarget(String target) {
return ManagedChannelProvider.provider().builderForTarget(target);
}
/**
* Execute application code directly in the transport thread.
*
* Depending on the underlying transport, using a direct executor may lead to substantial
* performance improvements. However, it also requires the application to not block under
* any circumstances.
*
*
Calling this method is semantically equivalent to calling {@link #executor(Executor)} and
* passing in a direct executor. However, this is the preferred way as it may allow the transport
* to perform special optimizations.
*
* @return this
* @since 1.0.0
*/
public abstract T directExecutor();
/**
* Provides a custom executor.
*
*
It's an optional parameter. If the user has not provided an executor when the channel is
* built, the builder will use a static cached thread pool.
*
*
The channel won't take ownership of the given executor. It's caller's responsibility to
* shut down the executor when it's desired.
*
* @return this
* @since 1.0.0
*/
public abstract T executor(Executor executor);
/**
* Adds interceptors that will be called before the channel performs its real work. This is
* functionally equivalent to using {@link ClientInterceptors#intercept(Channel, List)}, but while
* still having access to the original {@code ManagedChannel}.
*
* @return this
* @since 1.0.0
*/
public abstract T intercept(List interceptors);
/**
* Adds interceptors that will be called before the channel performs its real work. This is
* functionally equivalent to using {@link ClientInterceptors#intercept(Channel,
* ClientInterceptor...)}, but while still having access to the original {@code ManagedChannel}.
*
* @return this
* @since 1.0.0
*/
public abstract T intercept(ClientInterceptor... interceptors);
/**
* Provides a custom {@code User-Agent} for the application.
*
* It's an optional parameter. The library will provide a user agent independent of this
* option. If provided, the given agent will prepend the library's user agent information.
*
* @return this
* @since 1.0.0
*/
public abstract T userAgent(String userAgent);
/**
* Overrides the authority used with TLS and HTTP virtual hosting. It does not change what host is
* actually connected to. Is commonly in the form {@code host:port}.
*
*
This method is intended for testing, but may safely be used outside of tests as an
* alternative to DNS overrides.
*
* @return this
* @since 1.0.0
*/
public abstract T overrideAuthority(String authority);
/**
* Use of a plaintext connection to the server. By default a secure connection mechanism
* such as TLS will be used.
*
*
Should only be used for testing or for APIs where the use of such API or the data
* exchanged is not sensitive.
*
* @param skipNegotiation @{code true} if there is a priori knowledge that the endpoint supports
* plaintext, {@code false} if plaintext use must be negotiated.
*
* @throws UnsupportedOperationException if plaintext mode is not supported.
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1772")
public abstract T usePlaintext(boolean skipNegotiation);
/**
* Makes the client use TLS.
*
* @return this
* @throws UnsupportedOperationException if transport security is not supported.
* @since 1.9.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/3713")
public T useTransportSecurity() {
throw new UnsupportedOperationException();
}
/**
* Provides a custom {@link NameResolver.Factory} for the channel. If this method is not called,
* the builder will try the providers listed by {@link NameResolverProvider#providers()} for the
* given target.
*
*
This method should rarely be used, as name resolvers should provide a {@code
* NameResolverProvider} and users rely on service loading to find implementations in the class
* path. That allows application's configuration to easily choose the name resolver via the
* 'target' string passed to {@link ManagedChannelBuilder#forTarget(String)}.
*
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
public abstract T nameResolverFactory(NameResolver.Factory resolverFactory);
/**
* Provides a custom {@link LoadBalancer.Factory} for the channel.
*
*
If this method is not called, the builder will use {@link PickFirstBalancerFactory}
* for the channel.
*
*
This method is implemented by all stock channel builders that
* are shipped with gRPC, but may not be implemented by custom channel builders, in which case
* this method will throw.
*
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1771")
public abstract T loadBalancerFactory(LoadBalancer.Factory loadBalancerFactory);
/**
* Enables full-stream decompression of inbound streams. This will cause the channel's outbound
* headers to advertise support for GZIP compressed streams, and gRPC servers which support the
* feature may respond with a GZIP compressed stream.
*
*
EXPERIMENTAL: This method is here to enable an experimental feature, and may be changed or
* removed once the feature is stable.
*
* @throws UnsupportedOperationException if unsupported
* @since 1.7.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/3399")
public T enableFullStreamDecompression() {
throw new UnsupportedOperationException();
}
/**
* Set the decompression registry for use in the channel. This is an advanced API call and
* shouldn't be used unless you are using custom message encoding. The default supported
* decompressors are in {@link DecompressorRegistry#getDefaultInstance}.
*
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1704")
public abstract T decompressorRegistry(DecompressorRegistry registry);
/**
* Set the compression registry for use in the channel. This is an advanced API call and
* shouldn't be used unless you are using custom message encoding. The default supported
* compressors are in {@link CompressorRegistry#getDefaultInstance}.
*
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1704")
public abstract T compressorRegistry(CompressorRegistry registry);
/**
* Set the duration without ongoing RPCs before going to idle mode.
*
*
In idle mode the channel shuts down all connections, the NameResolver and the
* LoadBalancer. A new RPC would take the channel out of idle mode. A channel starts in idle mode.
*
*
By default the channel will never go to idle mode after it leaves the initial idle
* mode.
*
*
This is an advisory option. Do not rely on any specific behavior related to this option.
*
* @return this
* @since 1.0.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2022")
public abstract T idleTimeout(long value, TimeUnit unit);
/**
* Sets the maximum message size allowed to be received on the channel. If not called,
* defaults to 4 MiB. The default provides protection to clients who haven't considered the
* possibility of receiving large messages while trying to be large enough to not be hit in normal
* usage.
*
*
This method is advisory, and implementations may decide to not enforce this. Currently,
* the only known transport to not enforce this is {@code InProcessTransport}.
*
* @param max the maximum number of bytes a single message can be.
* @throws IllegalArgumentException if max is negative.
* @return this
* @since 1.1.0
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2307")
public T maxInboundMessageSize(int max) {
// intentional nop
return thisT();
}
/**
* Sets the time without read activity before sending a keepalive ping. An unreasonably small
* value might be increased, and {@code Long.MAX_VALUE} nano seconds or an unreasonably large
* value will disable keepalive. Defaults to infinite.
*
*
Clients must receive permission from the service owner before enabling this option.
* Keepalives can increase the load on services and are commonly "invisible" making it hard to
* notice when they are causing excessive load. Clients are strongly encouraged to use only as
* small of a value as necessary.
*
* @throws UnsupportedOperationException if unsupported
* @since 1.7.0
*/
public T keepAliveTime(long keepAliveTime, TimeUnit timeUnit) {
throw new UnsupportedOperationException();
}
/**
* Sets the time waiting for read activity after sending a keepalive ping. If the time expires
* without any read activity on the connection, the connection is considered dead. An unreasonably
* small value might be increased. Defaults to 20 seconds.
*
*
This value should be at least multiple times the RTT to allow for lost packets.
*
* @throws UnsupportedOperationException if unsupported
* @since 1.7.0
*/
public T keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) {
throw new UnsupportedOperationException();
}
/**
* Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
* Defaults to {@code false}.
*
*
Clients must receive permission from the service owner before enabling this option.
* Keepalives on unused connections can easilly accidentally consume a considerable amount of
* bandwidth and CPU. {@link ManagedChannelBuilder#idleTimeout idleTimeout()} should generally be
* used instead of this option.
*
* @throws UnsupportedOperationException if unsupported
* @see #keepAliveTime(long, TimeUnit)
* @since 1.7.0
*/
public T keepAliveWithoutCalls(boolean enable) {
throw new UnsupportedOperationException();
}
/**
* Builds a channel using the given parameters.
*
* @since 1.0.0
*/
public abstract ManagedChannel build();
/**
* Returns the correctly typed version of the builder.
*/
private T thisT() {
@SuppressWarnings("unchecked")
T thisT = (T) this;
return thisT;
}
}