Class RefreshingHttpJsonChannel (2.91.0)

public class RefreshingHttpJsonChannel extends ManagedHttpJsonChannel

An implementation of ManagedHttpJsonChannel that supports dynamic mTLS certificate rotation. When the workload certificate on disk changes, #refresh() replaces the HttpTransport of the underlying channel. Calls that were already created keep using the transport they were created with, so in-flight requests are not interrupted.

Inheritance

java.lang.Object > ManagedHttpJsonChannel > RefreshingHttpJsonChannel

Constructors

RefreshingHttpJsonChannel(Supplier<HttpTransport> transportFactory, Function<HttpTransport,ManagedHttpJsonChannel> channelFactory, String workloadCertPath)

public RefreshingHttpJsonChannel(Supplier<HttpTransport> transportFactory, Function<HttpTransport,ManagedHttpJsonChannel> channelFactory, String workloadCertPath)
Parameters
Name Description
transportFactory Supplier<com.google.api.client.http.HttpTransport>

creates a transport configured with the certificate currently on disk

channelFactory Function<com.google.api.client.http.HttpTransport,ManagedHttpJsonChannel>

creates the underlying channel from the initial transport

workloadCertPath String

path of the workload certificate to monitor for rotation

Methods

<RequestT,ResponseT>newCall(ApiMethodDescriptor<RequestT,ResponseT> methodDescriptor, HttpJsonCallOptions callOptions)

public HttpJsonClientCall<RequestT,ResponseT> <RequestT,ResponseT>newCall(ApiMethodDescriptor<RequestT,ResponseT> methodDescriptor, HttpJsonCallOptions callOptions)
Parameters
Name Description
methodDescriptor ApiMethodDescriptor<RequestT,ResponseT>
callOptions HttpJsonCallOptions
Returns
Type Description
HttpJsonClientCall<RequestT,ResponseT>
Overrides

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Blocks until all work has completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Overrides
Exceptions
Type Description
InterruptedException

close()

public void close()
Overrides

getGeneration()

public long getGeneration()

Returns a monotonic generation counter tracking the number of successful refreshes or channel rotations performed by this channel. Always 0 for channels that do not refresh.

Returns
Type Description
long
Overrides

isShutdown()

public boolean isShutdown()

Returns true if this background resource has been shut down.

Returns
Type Description
boolean
Overrides

isTerminated()

public boolean isTerminated()

Returns true if all work has completed following shut down. Note that isTerminated is never true unless either shutdown or shutdownNow was called first.

Returns
Type Description
boolean
Overrides

refresh()

public void refresh()

Refreshes or recreates the underlying transport of this channel if a certificate rotation has been detected. By default, this is a no-op.

Overrides

shouldRefresh()

public boolean shouldRefresh()

Returns true if a certificate rotation has been detected on disk and this channel should be refreshed, or false otherwise. Always false for channels that do not refresh.

Returns
Type Description
boolean
Overrides

shutdown()

public void shutdown()

Initiates an orderly shutdown in which previously submitted work is finished, but no new work will be accepted. Invocation has no additional effect if already shut down.

This method does not wait for previously submitted work to complete execution. Use awaitTermination to do that.

Overrides

shutdownNow()

public void shutdownNow()

Attempts to stop all actively executing work and halts the processing of waiting work.

This method does not wait for actively executing work to terminate. Use awaitTermination to do that.

There are no guarantees beyond best-effort attempts to stop processing actively executing work. For example, typical implementations will cancel via Thread.interrupt(), so any task that fails to respond to interrupts may never terminate.

Overrides