Top Description Inners Fields Constructors Methods
io.netty5.handler.ssl

public final Class OpenSslCertificateCompressionConfig

extends Object
implements Iterable<OpenSslCertificateCompressionConfig.AlgorithmConfig>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Imports
java.util.ArrayList, .Iterator, .List

Configuration for TLS1.3 certificate compression extension.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OpenSslCertificateCompressionConfig.AlgorithmConfig

The configuration for the algorithm.

public static enum
public static class

Field Summary

Modifier and TypeField and Description
private final List<OpenSslCertificateCompressionConfig.AlgorithmConfig>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public Iterator<OpenSslCertificateCompressionConfig.AlgorithmConfig>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.
public static OpenSslCertificateCompressionConfig.Builder

Returns:

a builder
newBuilder
()

Creates a new Builder for a config.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

pairListback to summary
private final List<OpenSslCertificateCompressionConfig.AlgorithmConfig> pairList

Constructor Detail

OpenSslCertificateCompressionConfigback to summary
private OpenSslCertificateCompressionConfig(OpenSslCertificateCompressionConfig.AlgorithmConfig... pairs)

Method Detail

iteratorback to summary
public Iterator<OpenSslCertificateCompressionConfig.AlgorithmConfig> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<OpenSslCertificateCompressionConfig.AlgorithmConfig>

an Iterator.

Annotations
@Override
newBuilderback to summary
public static OpenSslCertificateCompressionConfig.Builder newBuilder()

Creates a new Builder for a config.

Returns:OpenSslCertificateCompressionConfig.Builder

a builder

io.netty5.handler.ssl back to summary

public final Class OpenSslCertificateCompressionConfig.AlgorithmConfig

extends Object
Class Inheritance
  • java.lang.Object
  • io.netty5.handler.ssl.OpenSslCertificateCompressionConfig.AlgorithmConfig

The configuration for the algorithm.

Field Summary

Modifier and TypeField and Description
private final OpenSslCertificateCompressionAlgorithm
private final OpenSslCertificateCompressionConfig.AlgorithmMode

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public OpenSslCertificateCompressionAlgorithm

Returns:

the algorithm
algorithm
()

The configured OpenSslCertificateCompressionAlgorithm.

public OpenSslCertificateCompressionConfig.AlgorithmMode

Returns:

the usage mode.
mode
()

The AlgorithmMode

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmback to summary
private final OpenSslCertificateCompressionAlgorithm algorithm
modeback to summary
private final OpenSslCertificateCompressionConfig.AlgorithmMode mode

Constructor Detail

AlgorithmConfigback to summary
private AlgorithmConfig(OpenSslCertificateCompressionAlgorithm algorithm, OpenSslCertificateCompressionConfig.AlgorithmMode mode)

Method Detail

algorithmback to summary
public OpenSslCertificateCompressionAlgorithm algorithm()

The configured OpenSslCertificateCompressionAlgorithm.

Returns:OpenSslCertificateCompressionAlgorithm

the algorithm

modeback to summary
public OpenSslCertificateCompressionConfig.AlgorithmMode mode()

The AlgorithmMode

Returns:OpenSslCertificateCompressionConfig.AlgorithmMode

the usage mode.

io.netty5.handler.ssl back to summary

public final Enum OpenSslCertificateCompressionConfig.AlgorithmMode

extends Enum<OpenSslCertificateCompressionConfig.AlgorithmMode>
Class Inheritance

The usage mode of the OpenSslCertificateCompressionAlgorithm.

Field Summary

Modifier and TypeField and Description
public static final OpenSslCertificateCompressionConfig.AlgorithmMode
Both

Compression and Decompression are supported and both should be advertised.

public static final OpenSslCertificateCompressionConfig.AlgorithmMode
Compress

Compression supported and should be advertised.

public static final OpenSslCertificateCompressionConfig.AlgorithmMode
Decompress

Decompression supported and should be advertised.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static OpenSslCertificateCompressionConfig.AlgorithmMode
public static OpenSslCertificateCompressionConfig.AlgorithmMode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Bothback to summary
public static final OpenSslCertificateCompressionConfig.AlgorithmMode Both

Compression and Decompression are supported and both should be advertised.

Compressback to summary
public static final OpenSslCertificateCompressionConfig.AlgorithmMode Compress

Compression supported and should be advertised.

Decompressback to summary
public static final OpenSslCertificateCompressionConfig.AlgorithmMode Decompress

Decompression supported and should be advertised.

Constructor Detail

AlgorithmModeback to summary
private AlgorithmMode()

Method Detail

valueOfback to summary
public static OpenSslCertificateCompressionConfig.AlgorithmMode valueOf(String name)
valuesback to summary
public static OpenSslCertificateCompressionConfig.AlgorithmMode[] values()
io.netty5.handler.ssl back to summary

public final Class OpenSslCertificateCompressionConfig.Builder

extends Object
Class Inheritance
  • java.lang.Object
  • io.netty5.handler.ssl.OpenSslCertificateCompressionConfig.Builder

Builder for an OpenSslCertificateCompressionAlgorithm.

Field Summary

Modifier and TypeField and Description
private final List<OpenSslCertificateCompressionConfig.AlgorithmConfig>

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public OpenSslCertificateCompressionConfig.Builder

Returns:

self.
addAlgorithm
(OpenSslCertificateCompressionAlgorithm
implementation of the compression and or decompression algorithm as a OpenSslCertificateCompressionAlgorithm
algorithm
,
OpenSslCertificateCompressionConfig.AlgorithmMode
indicates whether decompression support should be advertized, compression should be applied for peers which support it, or both. This allows the caller to support one way compression only.
mode
)

Adds a certificate compression algorithm.

public OpenSslCertificateCompressionConfig

Returns:

a new config.
build
()

Build a new OpenSslCertificateCompressionConfig based on the previous added OpenSslCertificateCompressionAlgorithms.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

algorithmListback to summary
private final List<OpenSslCertificateCompressionConfig.AlgorithmConfig> algorithmList

Constructor Detail

Builderback to summary
private Builder()

Method Detail

addAlgorithmback to summary
public OpenSslCertificateCompressionConfig.Builder addAlgorithm(OpenSslCertificateCompressionAlgorithm algorithm, OpenSslCertificateCompressionConfig.AlgorithmMode mode)

Adds a certificate compression algorithm. For servers, algorithm preference order is dictated by the order of algorithm registration. Most preferred algorithm should be registered first.

Parameters
algorithm:OpenSslCertificateCompressionAlgorithm

implementation of the compression and or decompression algorithm as a OpenSslCertificateCompressionAlgorithm

mode:OpenSslCertificateCompressionConfig.AlgorithmMode

indicates whether decompression support should be advertized, compression should be applied for peers which support it, or both. This allows the caller to support one way compression only.

Returns:OpenSslCertificateCompressionConfig.Builder

self.

buildback to summary
public OpenSslCertificateCompressionConfig build()

Build a new OpenSslCertificateCompressionConfig based on the previous added OpenSslCertificateCompressionAlgorithms.

Returns:OpenSslCertificateCompressionConfig

a new config.