Interface ContentEncoding

All Superinterfaces:

NamedService

All Known Implementing Classes:

DeflateEncoding, GzipEncoding

public interface ContentEncoding
extends NamedService

Content encoding service created from ContentEncodingProvider, or directly implemented. Content encoding/decoding modifies bytes on the wire, for example to compress it.

Method Summary

Modifier and Type	Method	Description
ContentDecoder	decoder()	To decode bytes.
ContentEncoder	encoder()	To encode bytes.
Set<String>	ids()	Identification(s) of this scheme.
boolean	supportsDecoding()	Does this provider support decoding.
boolean	supportsEncoding()	Does this provider support encoding.

Methods inherited from interface NamedService

name, type

Modifier and Type	Method	Description
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Method Details

ids

Set<String> ids()

Identification(s) of this scheme.

Helidon accepts these identifiers in request Accept-Encoding headers. When automatic response encoding selects one of these identifiers, that selected identifier is the response Content-Encoding.

Returns:

identifications, such as deflate, gzip

supportsEncoding

boolean supportsEncoding()

Does this provider support encoding.

Returns:

encoding supported

supportsDecoding

boolean supportsDecoding()

Does this provider support decoding.

Returns:

decoding supported

decoder

ContentDecoder decoder()

To decode bytes.

Returns:

decoder

encoder

ContentEncoder encoder()

To encode bytes.

Returns:

encoder