io.grpc.stub

Class MetadataUtils

java.lang.Object

io.grpc.stub.MetadataUtils

public final class MetadataUtils
extends Object

Utility functions for binding and receiving headers.

Method Summary

Modifier and Type	Method and Description
static <T extends AbstractStub<T>> T	attachHeaders(T stub, io.grpc.Metadata extraHeaders) Deprecated. Use stub.withInterceptors(newAttachHeadersInterceptor(...)) instead.
static <T extends AbstractStub<T>> T	captureMetadata(T stub, AtomicReference<io.grpc.Metadata> headersCapture, AtomicReference<io.grpc.Metadata> trailersCapture) Deprecated. Use stub.withInterceptors(newCaptureMetadataInterceptor()) instead.
static io.grpc.ClientInterceptor	newAttachHeadersInterceptor(io.grpc.Metadata extraHeaders) Returns a client interceptor that attaches a set of headers to requests.
static io.grpc.ClientInterceptor	newCaptureMetadataInterceptor(AtomicReference<io.grpc.Metadata> headersCapture, AtomicReference<io.grpc.Metadata> trailersCapture) Captures the last received metadata on a channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

attachHeaders

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1789")
 @Deprecated
 @InlineMe(replacement="stub.withInterceptors(MetadataUtils.newAttachHeadersInterceptor(extraHeaders))",
          imports="io.grpc.stub.MetadataUtils")
public static <T extends AbstractStub<T>> T attachHeaders(T stub,
                                                                                                                                                                                                                                                                                                        io.grpc.Metadata extraHeaders)

Deprecated. Use stub.withInterceptors(newAttachHeadersInterceptor(...)) instead.

Attaches a set of request headers to a stub.

Parameters:

stub - to bind the headers to.

extraHeaders - the headers to be passed by each call on the returned stub.

Returns:

an implementation of the stub with extraHeaders bound to each call.

newAttachHeadersInterceptor

public static io.grpc.ClientInterceptor newAttachHeadersInterceptor(io.grpc.Metadata extraHeaders)

Returns a client interceptor that attaches a set of headers to requests.

Parameters:

extraHeaders - the headers to be passed by each call that is processed by the returned interceptor

captureMetadata

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1789")
 @Deprecated
 @InlineMe(replacement="stub.withInterceptors(MetadataUtils.newCaptureMetadataInterceptor(headersCapture, trailersCapture))",
          imports="io.grpc.stub.MetadataUtils")
public static <T extends AbstractStub<T>> T captureMetadata(T stub,
                                                                                                                                                                                                                                                                                                                               AtomicReference<io.grpc.Metadata> headersCapture,
                                                                                                                                                                                                                                                                                                                               AtomicReference<io.grpc.Metadata> trailersCapture)

Deprecated. Use stub.withInterceptors(newCaptureMetadataInterceptor()) instead.

Captures the last received metadata for a stub. Useful for testing

Parameters:

stub - to capture for

headersCapture - to record the last received headers

trailersCapture - to record the last received trailers

Returns:

an implementation of the stub that allows to access the last received call's headers and trailers via headersCapture and trailersCapture.

newCaptureMetadataInterceptor

public static io.grpc.ClientInterceptor newCaptureMetadataInterceptor(AtomicReference<io.grpc.Metadata> headersCapture,
                                                                      AtomicReference<io.grpc.Metadata> trailersCapture)

Captures the last received metadata on a channel. Useful for testing.

Parameters:

headersCapture - to record the last received headers

trailersCapture - to record the last received trailers

Returns:

an implementation of the channel with captures installed.