io.grpc

Class Metadata.Headers

java.lang.Object

io.grpc.Metadata

io.grpc.Metadata.Headers

Enclosing class:

Metadata

public static class Metadata.Headers
extends Metadata

Concrete instance for metadata attached to the start of a call.

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.Metadata

Metadata.AsciiMarshaller<T>, Metadata.BinaryMarshaller<T>, Metadata.Headers, Metadata.Key<T>, Metadata.Trailers

Field Summary

Fields inherited from class io.grpc.Metadata

ASCII_STRING_MARSHALLER, BINARY_HEADER_SUFFIX, INTEGER_MARSHALLER

Constructor Summary

Constructors

Constructor and Description
Headers() Called by the application layer to construct headers prior to passing them to the transport for serialization.
Headers(byte[]... headers) Called by the transport layer to create headers from their binary serialized values.

Method Summary

Modifier and Type	Method and Description
String	getAuthority() The serving authority for the operation.
String	getPath() The path for the operation.
void	merge(Metadata other) Perform a simple merge of two sets of metadata.
void	merge(Metadata other, Set<Metadata.Key<?>> keys) Merge values for the given set of keys into this set of metadata.
void	setAuthority(String authority) Override the HTTP/2 authority the channel claims to be connecting to.
void	setPath(String path)
String	toString()

Methods inherited from class io.grpc.Metadata

containsKey, get, getAll, isSerializable, put, remove, removeAll, serialize

Methods inherited from class java.lang.Object

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

Constructor Detail

Headers

public Headers(byte[]... headers)

Called by the transport layer to create headers from their binary serialized values.

Headers

public Headers()

Called by the application layer to construct headers prior to passing them to the transport for serialization.

Method Detail

getPath

public String getPath()

The path for the operation.

setPath

public void setPath(String path)

getAuthority

public String getAuthority()

The serving authority for the operation.

setAuthority

public void setAuthority(String authority)

Override the HTTP/2 authority the channel claims to be connecting to. This is not generally safe. Overriding allows advanced users to re-use a single Channel for multiple services, even if those services are hosted on different domain names. That assumes the server is virtually hosting multiple domains and is guaranteed to continue doing so. It is rare for a service provider to make such a guarantee. At this time, there is no security verification of the overridden value, such as making sure the authority matches the server's TLS certificate.

merge

public void merge(Metadata other)

Description copied from class: Metadata

Perform a simple merge of two sets of metadata.

Note that we can't merge non-serializable metadata into serializable.

Overrides:

merge in class Metadata

merge

public void merge(Metadata other,
                  Set<Metadata.Key<?>> keys)

Description copied from class: Metadata

Merge values for the given set of keys into this set of metadata.

Overrides:

merge in class Metadata

toString

public String toString()

Overrides:

toString in class Object