nl.topicus.jdbc.shaded.io.grpc.stub.MetadataUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation
Show all versions of spanner-jdbc Show documentation
JDBC Driver for Google Cloud Spanner
/*
* Copyright 2014, 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.stub;
import static nl.topicus.jdbc.shaded.com.google.common.base.Preconditions.checkNotNull;
import nl.topicus.jdbc.shaded.io.grpc.CallOptions;
import nl.topicus.jdbc.shaded.io.grpc.Channel;
import nl.topicus.jdbc.shaded.io.grpc.ClientCall;
import nl.topicus.jdbc.shaded.io.grpc.ClientInterceptor;
import nl.topicus.jdbc.shaded.io.grpc.ExperimentalApi;
import nl.topicus.jdbc.shaded.io.grpc.ForwardingClientCall.SimpleForwardingClientCall;
import nl.topicus.jdbc.shaded.io.grpc.ForwardingClientCallListener.SimpleForwardingClientCallListener;
import nl.topicus.jdbc.shaded.io.grpc.Metadata;
import nl.topicus.jdbc.shaded.io.grpc.MethodDescriptor;
import nl.topicus.jdbc.shaded.io.grpc.Status;
import java.util.concurrent.atomic.AtomicReference;
/**
* Utility functions for binding and receiving headers.
*/
public final class MetadataUtils {
// Prevent instantiation
private MetadataUtils() {}
/**
* Attaches a set of request headers to a stub.
*
* @param stub to bind the headers to.
* @param extraHeaders the headers to be passed by each call on the returned stub.
* @return an implementation of the stub with {@code extraHeaders} bound to each call.
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1789")
public static > T attachHeaders(T stub, Metadata extraHeaders) {
return stub.withInterceptors(newAttachHeadersInterceptor(extraHeaders));
}
/**
* Returns a client interceptor that attaches a set of headers to requests.
*
* @param extraHeaders the headers to be passed by each call that is processed by the returned
* interceptor
*/
public static ClientInterceptor newAttachHeadersInterceptor(Metadata extraHeaders) {
return new HeaderAttachingClientInterceptor(extraHeaders);
}
private static final class HeaderAttachingClientInterceptor implements ClientInterceptor {
private final Metadata extraHeaders;
// Non private to avoid synthetic class
HeaderAttachingClientInterceptor(Metadata extraHeaders) {
this.extraHeaders = checkNotNull(extraHeaders, extraHeaders);
}
@Override
public ClientCall interceptCall(
MethodDescriptor method, CallOptions callOptions, Channel next) {
return new HeaderAttachingClientCall(next.newCall(method, callOptions));
}
private final class HeaderAttachingClientCall
extends SimpleForwardingClientCall {
// Non private to avoid synthetic class
HeaderAttachingClientCall(ClientCall call) {
super(call);
}
@Override
public void start(Listener responseListener, Metadata headers) {
headers.merge(extraHeaders);
super.start(responseListener, headers);
}
}
}
/**
* Captures the last received metadata for a stub. Useful for testing
*
* @param stub to capture for
* @param headersCapture to record the last received headers
* @param trailersCapture to record the last received trailers
* @return an implementation of the stub that allows to access the last received call's
* headers and trailers via {@code headersCapture} and {@code trailersCapture}.
*/
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1789")
public static > T captureMetadata(
T stub,
AtomicReference headersCapture,
AtomicReference trailersCapture) {
return stub.withInterceptors(
newCaptureMetadataInterceptor(headersCapture, trailersCapture));
}
/**
* Captures the last received metadata on a channel. Useful for testing.
*
* @param headersCapture to record the last received headers
* @param trailersCapture to record the last received trailers
* @return an implementation of the channel with captures installed.
*/
public static ClientInterceptor newCaptureMetadataInterceptor(
AtomicReference headersCapture, AtomicReference trailersCapture) {
return new MetadataCapturingClientInterceptor(headersCapture, trailersCapture);
}
private static final class MetadataCapturingClientInterceptor implements ClientInterceptor {
final AtomicReference headersCapture;
final AtomicReference trailersCapture;
// Non private to avoid synthetic class
MetadataCapturingClientInterceptor(
AtomicReference headersCapture, AtomicReference trailersCapture) {
this.headersCapture = checkNotNull(headersCapture, "headersCapture");
this.trailersCapture = checkNotNull(trailersCapture, "trailersCapture");
}
@Override
public ClientCall interceptCall(
MethodDescriptor method, CallOptions callOptions, Channel next) {
return new MetadataCapturingClientCall(next.newCall(method, callOptions));
}
private final class MetadataCapturingClientCall
extends SimpleForwardingClientCall {
// Non private to avoid synthetic class
MetadataCapturingClientCall(ClientCall call) {
super(call);
}
@Override
public void start(ClientCall.Listener responseListener, Metadata headers) {
headersCapture.set(null);
trailersCapture.set(null);
super.start(new MetadataCapturingClientCallListener(responseListener), headers);
}
private final class MetadataCapturingClientCallListener
extends SimpleForwardingClientCallListener {
MetadataCapturingClientCallListener(ClientCall.Listener responseListener) {
super(responseListener);
}
@Override
public void onHeaders(Metadata headers) {
headersCapture.set(headers);
super.onHeaders(headers);
}
@Override
public void onClose(Status status, Metadata trailers) {
trailersCapture.set(trailers);
super.onClose(status, trailers);
}
}
}
}
}