OkHttpChannelBuilder (grpc-all 1.20.0 API)

java.lang.Object
- io.grpc.ManagedChannelBuilder<T>
- - io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>
  - - io.grpc.okhttp.OkHttpChannelBuilder

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1785")
public class OkHttpChannelBuilder
extends io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>

Convenience class for building channels with the OkHttp transport.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_FLOW_CONTROL_WINDOW
- Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder
  transportTracerFactory

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_FLOW_CONTROL_WINDOW`

Constructor Summary

Constructors
Modifier Constructor and Description

protected OkHttpChannelBuilder(String host, int port)

Constructors
Modifier	Constructor and Description
`protected`	`OkHttpChannelBuilder(String host, int port)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected io.grpc.internal.ClientTransportFactory`	`buildTransportFactory()`
`OkHttpChannelBuilder`	`connectionSpec(ConnectionSpec connectionSpec)` For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
`OkHttpChannelBuilder`	`enableKeepAlive(boolean enable)` Deprecated. Use `keepAliveTime(long, java.util.concurrent.TimeUnit)` instead
`OkHttpChannelBuilder`	`enableKeepAlive(boolean enable, long keepAliveTime, TimeUnit delayUnit, long keepAliveTimeout, TimeUnit timeoutUnit)` Deprecated. Use `keepAliveTime(long, java.util.concurrent.TimeUnit)` and `keepAliveTimeout(long, java.util.concurrent.TimeUnit)` instead
`OkHttpChannelBuilder`	`flowControlWindow(int flowControlWindow)` Sets the flow control window in bytes.
`static OkHttpChannelBuilder`	`forAddress(String host, int port)` Creates a new builder for the given server host and port.
`static OkHttpChannelBuilder`	`forTarget(String target)` Creates a new builder for the given target that will be resolved by `NameResolver`.
`protected int`	`getDefaultPort()`
`OkHttpChannelBuilder`	`hostnameVerifier(HostnameVerifier hostnameVerifier)` Set the hostname verifier to use when using TLS negotiation.
`OkHttpChannelBuilder`	`keepAliveTime(long keepAliveTime, TimeUnit timeUnit)` Sets the time without read activity before sending a keepalive ping.
`OkHttpChannelBuilder`	`keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)` Sets the time waiting for read activity after sending a keepalive ping.
`OkHttpChannelBuilder`	`keepAliveWithoutCalls(boolean enable)` Sets whether keepalive will be performed when there are no outstanding RPC on a connection.
`OkHttpChannelBuilder`	`maxInboundMetadataSize(int bytes)` Sets the maximum size of metadata allowed to be received.
`OkHttpChannelBuilder`	`negotiationType(NegotiationType type)` Deprecated. use `usePlaintext()` or `useTransportSecurity()` instead.
`OkHttpChannelBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Provides a custom scheduled executor service.
`OkHttpChannelBuilder`	`socketFactory(SocketFactory socketFactory)` Override the default `SocketFactory` used to create sockets.
`OkHttpChannelBuilder`	`sslSocketFactory(SSLSocketFactory factory)` Override the default `SSLSocketFactory` and enable TLS negotiation.
`OkHttpChannelBuilder`	`transportExecutor(Executor transportExecutor)` Override the default executor necessary for internal transport use.
`OkHttpChannelBuilder`	`usePlaintext()` Sets the negotiation type for the HTTP/2 connection to plaintext.
`OkHttpChannelBuilder`	`usePlaintext(boolean skipNegotiation)` Deprecated. use `usePlaintext()` instead.
`OkHttpChannelBuilder`	`useTransportSecurity()` Sets the negotiation type for the HTTP/2 connection to TLS (this is the default).

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder
build, checkAuthority, compressorRegistry, decompressorRegistry, defaultLoadBalancingPolicy, defaultServiceConfig, directExecutor, disableRetry, disableServiceConfigLookUp, enableFullStreamDecompression, enableRetry, executor, idleTimeout, intercept, intercept, loadBalancerFactory, maxHedgedAttempts, maxInboundMessageSize, maxInboundMessageSize, maxRetryAttempts, maxTraceEvents, nameResolverFactory, overrideAuthority, overrideCensusStatsModule, perRpcBufferLimit, proxyDetector, retryBufferSize, setBinaryLog, setStatsEnabled, setStatsRecordFinishedRpcs, setStatsRecordRealTimeMetrics, setStatsRecordStartedRpcs, setTracingEnabled, userAgent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_FLOW_CONTROL_WINDOW
```
public static final int DEFAULT_FLOW_CONTROL_WINDOW
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OkHttpChannelBuilder
```
protected OkHttpChannelBuilder(String host,
                               int port)
```
- Method Detail
  - forAddress
```
public static OkHttpChannelBuilder forAddress(String host,
                                              int port)
```
    Creates a new builder for the given server host and port.
  - forTarget
```
public static OkHttpChannelBuilder forTarget(String target)
```
    Creates a new builder for the given target that will be resolved by NameResolver.
  - transportExecutor
```
public final OkHttpChannelBuilder transportExecutor(@Nullable
                                                    Executor transportExecutor)
```
    Override the default executor necessary for internal transport use.
    The channel does not take ownership of the given executor. It is the caller' responsibility to shutdown the executor when appropriate.
  - socketFactory
```
public final OkHttpChannelBuilder socketFactory(@Nullable
                                                SocketFactory socketFactory)
```
    Override the default SocketFactory used to create sockets. If the socket factory is not set or set to null, a default one will be used.
    
    Since:
    
    1.20.0
  - negotiationType
```
@Deprecated
public final OkHttpChannelBuilder negotiationType(NegotiationType type)
```
    Deprecated. use usePlaintext() or useTransportSecurity() instead.
    
    Sets the negotiation type for the HTTP/2 connection.
    If TLS is enabled a default SSLSocketFactory is created using the best Provider available and is NOT based on SSLSocketFactory.getDefault(). To more precisely control the TLS configuration call sslSocketFactory to override the socket factory used.
    Default: TLS
  - enableKeepAlive
```
@Deprecated
public final OkHttpChannelBuilder enableKeepAlive(boolean enable)
```
    Deprecated. Use keepAliveTime(long, java.util.concurrent.TimeUnit) instead
    
    Enable keepalive with default delay and timeout.
  - enableKeepAlive
```
@Deprecated
public final OkHttpChannelBuilder enableKeepAlive(boolean enable,
                                                              long keepAliveTime,
                                                              TimeUnit delayUnit,
                                                              long keepAliveTimeout,
                                                              TimeUnit timeoutUnit)
```
    Deprecated. Use keepAliveTime(long, java.util.concurrent.TimeUnit) and keepAliveTimeout(long, java.util.concurrent.TimeUnit) instead
    
    Enable keepalive with custom delay and timeout.
  - keepAliveTime
```
public OkHttpChannelBuilder keepAliveTime(long keepAliveTime,
                                          TimeUnit timeUnit)
```
    Sets the time without read activity before sending a keepalive ping. An unreasonably small value might be increased, and 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.
    
    Overrides:
    
    keepAliveTime in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Since:
    
    1.3.0
  - keepAliveTimeout
```
public OkHttpChannelBuilder keepAliveTimeout(long keepAliveTimeout,
                                             TimeUnit timeUnit)
```
    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.
    
    Overrides:
    
    keepAliveTimeout in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Since:
    
    1.3.0
  - flowControlWindow
```
public OkHttpChannelBuilder flowControlWindow(int flowControlWindow)
```
    Sets the flow control window in bytes. If not called, the default value is DEFAULT_FLOW_CONTROL_WINDOW).
  - keepAliveWithoutCalls
```
public OkHttpChannelBuilder keepAliveWithoutCalls(boolean enable)
```
    Sets whether keepalive will be performed when there are no outstanding RPC on a connection. Defaults to 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. idleTimeout() should generally be used instead of this option.
    
    Overrides:
    
    keepAliveWithoutCalls in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Since:
    
    1.3.0
    
    See Also:
    
    keepAliveTime(long, TimeUnit)
  - sslSocketFactory
```
public final OkHttpChannelBuilder sslSocketFactory(SSLSocketFactory factory)
```
    Override the default SSLSocketFactory and enable TLS negotiation.
  - hostnameVerifier
```
public final OkHttpChannelBuilder hostnameVerifier(@Nullable
                                                   HostnameVerifier hostnameVerifier)
```
    Set the hostname verifier to use when using TLS negotiation. The hostnameVerifier is only used if using TLS negotiation. If the hostname verifier is not set, a default hostname verifier is used.
    Be careful when setting a custom hostname verifier! By setting a non-null value, you are replacing all default verification behavior. If the hostname verifier you supply does not effectively supply the same checks, you may be removing the security assurances that TLS aims to provide.
    
    This method should not be used to avoid hostname verification, even during testing, since AbstractManagedChannelImplBuilder.overrideAuthority(java.lang.String) is a safer alternative as it does not disable any security checks.
    
    Returns:
    
    this
    
    Since:
    
    1.6.0
    
    See Also:
    
    OkHostnameVerifier
  - connectionSpec
```
public final OkHttpChannelBuilder connectionSpec(ConnectionSpec connectionSpec)
```
    For secure connection, provides a ConnectionSpec to specify Cipher suite and TLS versions.
    By default a modern, HTTP/2-compatible spec will be used.
    This method is only used when building a secure connection. For plaintext connection, use usePlaintext() instead.
    
    Throws:
    
    IllegalArgumentException - If connectionSpec is not with TLS
  - usePlaintext
```
@Deprecated
public final OkHttpChannelBuilder usePlaintext(boolean skipNegotiation)
```
    Deprecated. use usePlaintext() instead.
    
    Equivalent to using negotiationType with PLAINTEXT.
    
    Overrides:
    
    usePlaintext in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Parameters:
    
    skipNegotiation - @{code true} if there is a priori knowledge that the endpoint supports plaintext, false if plaintext use must be negotiated.
    
    Returns:
    
    this
  - usePlaintext
```
public final OkHttpChannelBuilder usePlaintext()
```
    Sets the negotiation type for the HTTP/2 connection to plaintext.
    
    Overrides:
    
    usePlaintext in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Returns:
    
    this
  - useTransportSecurity
```
public final OkHttpChannelBuilder useTransportSecurity()
```
    Sets the negotiation type for the HTTP/2 connection to TLS (this is the default).
    With TLS enabled, a default SSLSocketFactory is created using the best Provider available and is NOT based on SSLSocketFactory.getDefault(). To more precisely control the TLS configuration call sslSocketFactory to override the socket factory used.
    
    Overrides:
    
    useTransportSecurity in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Returns:
    
    this
  - scheduledExecutorService
```
public final OkHttpChannelBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Provides a custom scheduled executor service.
    It's an optional parameter. If the user has not provided a scheduled executor service when the channel is built, the builder will use a static cached thread pool.
    
    Returns:
    
    this
    
    Since:
    
    1.11.0
  - maxInboundMetadataSize
```
public OkHttpChannelBuilder maxInboundMetadataSize(int bytes)
```
    Sets the maximum size of metadata allowed to be received. Integer.MAX_VALUE disables the enforcement. Defaults to no limit (Integer.MAX_VALUE).
    The implementation does not currently limit memory usage; this value is checked only after the metadata is decoded from the wire. It does prevent large metadata from being passed to the application.
    
    Overrides:
    
    maxInboundMetadataSize in class ManagedChannelBuilder<OkHttpChannelBuilder>
    
    Parameters:
    
    bytes - the maximum size of received metadata
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if bytes is non-positive
    
    Since:
    
    1.17.0
  - buildTransportFactory
```
@Internal
protected final io.grpc.internal.ClientTransportFactory buildTransportFactory()
```
    Specified by:
    
    buildTransportFactory in class io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>
  - getDefaultPort
```
protected int getDefaultPort()
```
    Overrides:
    
    getDefaultPort in class io.grpc.internal.AbstractManagedChannelImplBuilder<OkHttpChannelBuilder>

Class OkHttpChannelBuilder

Field Summary

Fields inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

Constructor Summary

Method Summary

Methods inherited from class io.grpc.internal.AbstractManagedChannelImplBuilder

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FLOW_CONTROL_WINDOW

Constructor Detail

OkHttpChannelBuilder

Method Detail

forAddress

forTarget

transportExecutor

socketFactory

negotiationType

enableKeepAlive

enableKeepAlive

keepAliveTime

keepAliveTimeout

flowControlWindow

keepAliveWithoutCalls

sslSocketFactory

hostnameVerifier

connectionSpec

usePlaintext

usePlaintext

useTransportSecurity

scheduledExecutorService

maxInboundMetadataSize

buildTransportFactory

getDefaultPort