io.grpc

Class DecompressorRegistry

java.lang.Object

io.grpc.DecompressorRegistry

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/492")
public final class DecompressorRegistry
extends Object

Encloses classes related to the compression and decompression of messages.

Method Summary

Modifier and Type	Method and Description
static Set<String>	getAdvertisedMessageEncodings() Provides a list of all message encodings that have decompressors available and should be advertised.
static Set<String>	getKnownMessageEncodings() Provides a list of all message encodings that have decompressors available.
static Decompressor	lookupDecompressor(String messageEncoding) Returns a decompressor for the given message encoding, or null if none has been registered.
static void	register(Decompressor d, boolean advertised) Registers a decompressor for both decompression and message encoding negotiation.

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register(Decompressor d,
                            boolean advertised)

Registers a decompressor for both decompression and message encoding negotiation.

Parameters:

d - The decompressor to register

advertised - If true, the message encoding will be listed in the Accept-Encoding header.

Throws:

IllegalArgumentException - if another compressor by the same name is already registered.

getKnownMessageEncodings

public static Set<String> getKnownMessageEncodings()

Provides a list of all message encodings that have decompressors available.

getAdvertisedMessageEncodings

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/492")
public static Set<String> getAdvertisedMessageEncodings()

Provides a list of all message encodings that have decompressors available and should be advertised.

lookupDecompressor

@Nullable
public static Decompressor lookupDecompressor(String messageEncoding)

Returns a decompressor for the given message encoding, or null if none has been registered.

This ignores whether the compressor is advertised. According to the spec, if we know how to process this encoding, we attempt to, regardless of whether or not it is part of the encodings sent to the remote host.