Modifier and Type	Class and Description
public static enum	ApplicationProtocolConfig.Protocol Defines which application level protocol negotiation to use.
public static enum	ApplicationProtocolConfig.SelectedListenerFailureBehavior Defines the most common behaviors for the peer which is notified of the selected protocol.
public static enum	ApplicationProtocolConfig.SelectorFailureBehavior Defines the most common behaviors for the peer that selects the application protocol.

Modifier and Type	Field and Description
public static final ApplicationProtocolConfig	DISABLED The configuration that disables application protocol negotiation.
private final ApplicationProtocolConfig.Protocol	protocol
private final ApplicationProtocolConfig.SelectedListenerFailureBehavior	selectedBehavior
private final ApplicationProtocolConfig.SelectorFailureBehavior	selectorBehavior
private final List<String>	supportedProtocols

Constructor Summary

Access	Constructor and Description
public	ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol The application protocol functionality to use. protocol, ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. selectedBehavior, Iterable<String> The order of iteration determines the preference of support for protocols. supportedProtocols) Create a new instance.
public	ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol The application protocol functionality to use. protocol, ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. selectedBehavior, String... The order of iteration determines the preference of support for protocols. supportedProtocols) Create a new instance.
private	ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol The application protocol functionality to use. protocol, ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. selectedBehavior, List<String> The order of iteration determines the preference of support for protocols. supportedProtocols) Create a new instance.
private	ApplicationProtocolConfig() A special constructor that is used to instantiate `DISABLED`.

Method Summary

Modifier and Type	Method and Description
public ApplicationProtocolConfig.Protocol	protocol() Get which application level protocol negotiation to use.
public ApplicationProtocolConfig.SelectedListenerFailureBehavior	selectedListenerFailureBehavior() Get the desired behavior for the peer who is notified of the selected protocol.
public ApplicationProtocolConfig.SelectorFailureBehavior	selectorFailureBehavior() Get the desired behavior for the peer who selects the application protocol.
public List<String>	supportedProtocols() The application level protocols supported.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DISABLED	back to summary
public static final ApplicationProtocolConfig DISABLED The configuration that disables application protocol negotiation.

protocol	back to summary
private final ApplicationProtocolConfig.Protocol protocol

selectedBehavior	back to summary
private final ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior

selectorBehavior	back to summary
private final ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior

supportedProtocols	back to summary
private final List<String> supportedProtocols

Constructor Detail

ApplicationProtocolConfig	back to summary
public ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol protocol, ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior, Iterable<String> supportedProtocols) Create a new instance. Parameters protocol:ApplicationProtocolConfig.Protocol The application protocol functionality to use. selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. supportedProtocols:Iterable<String> The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig

back to summary

public ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol protocol, ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior, Iterable<String> supportedProtocols)

Create a new instance.

Parameters

protocol:ApplicationProtocolConfig.Protocol: The application protocol functionality to use.
selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior: How the peer selecting the protocol should behave.
selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior: How the peer being notified of the selected protocol should behave.
supportedProtocols:Iterable<String>: The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig	back to summary
public ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol protocol, ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior, String... supportedProtocols) Create a new instance. Parameters protocol:ApplicationProtocolConfig.Protocol The application protocol functionality to use. selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. supportedProtocols:String[] The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig

back to summary

Create a new instance.

Parameters

protocol:ApplicationProtocolConfig.Protocol: The application protocol functionality to use.
selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior: How the peer selecting the protocol should behave.
selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior: How the peer being notified of the selected protocol should behave.
supportedProtocols:String[]: The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig	back to summary
private ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol protocol, ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior, List<String> supportedProtocols) Create a new instance. Parameters protocol:ApplicationProtocolConfig.Protocol The application protocol functionality to use. selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior How the peer selecting the protocol should behave. selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior How the peer being notified of the selected protocol should behave. supportedProtocols:List<String> The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig

back to summary

private ApplicationProtocolConfig(ApplicationProtocolConfig.Protocol protocol, ApplicationProtocolConfig.SelectorFailureBehavior selectorBehavior, ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedBehavior, List<String> supportedProtocols)

Create a new instance.

Parameters

protocol:ApplicationProtocolConfig.Protocol: The application protocol functionality to use.
selectorBehavior:ApplicationProtocolConfig.SelectorFailureBehavior: How the peer selecting the protocol should behave.
selectedBehavior:ApplicationProtocolConfig.SelectedListenerFailureBehavior: How the peer being notified of the selected protocol should behave.
supportedProtocols:List<String>: The order of iteration determines the preference of support for protocols.

ApplicationProtocolConfig	back to summary
private ApplicationProtocolConfig() A special constructor that is used to instantiate `DISABLED`.

Method Detail

protocol	back to summary
public ApplicationProtocolConfig.Protocol protocol() Get which application level protocol negotiation to use.

selectedListenerFailureBehavior	back to summary
public ApplicationProtocolConfig.SelectedListenerFailureBehavior selectedListenerFailureBehavior() Get the desired behavior for the peer who is notified of the selected protocol.

selectorFailureBehavior	back to summary
public ApplicationProtocolConfig.SelectorFailureBehavior selectorFailureBehavior() Get the desired behavior for the peer who selects the application protocol.

supportedProtocols	back to summary
public List<String> supportedProtocols() The application level protocols supported.

io.netty5.handler.ssl back to summary

public final Enum ApplicationProtocolConfig.Protocol

Class Inheritance

extends Enum<ApplicationProtocolConfig.Protocol>

java.lang.Object
java.lang.Enum
io.netty5.handler.ssl.ApplicationProtocolConfig.Protocol

Defines which application level protocol negotiation to use.

Field Summary

Modifier and Type	Field and Description
public static final ApplicationProtocolConfig.Protocol	ALPN
public static final ApplicationProtocolConfig.Protocol	NONE
public static final ApplicationProtocolConfig.Protocol	NPN
public static final ApplicationProtocolConfig.Protocol	NPN_AND_ALPN

Constructor Summary

Access	Constructor and Description
private	Protocol()

Method Summary

Modifier and Type	Method and Description
public static ApplicationProtocolConfig.Protocol	valueOf(String name)
public static ApplicationProtocolConfig.Protocol[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALPN	back to summary
public static final ApplicationProtocolConfig.Protocol ALPN

NONE	back to summary
public static final ApplicationProtocolConfig.Protocol NONE

NPN	back to summary
public static final ApplicationProtocolConfig.Protocol NPN

NPN_AND_ALPN	back to summary
public static final ApplicationProtocolConfig.Protocol NPN_AND_ALPN

Constructor Detail

Protocol	back to summary
private Protocol()

Method Detail

valueOf	back to summary
public static ApplicationProtocolConfig.Protocol valueOf(String name)

values	back to summary
public static ApplicationProtocolConfig.Protocol[] values()

io.netty5.handler.ssl back to summary

public final Enum ApplicationProtocolConfig.SelectedListenerFailureBehavior

Class Inheritance

extends Enum<ApplicationProtocolConfig.SelectedListenerFailureBehavior>

java.lang.Object
java.lang.Enum
io.netty5.handler.ssl.ApplicationProtocolConfig.SelectedListenerFailureBehavior

Defines the most common behaviors for the peer which is notified of the selected protocol.

Field Summary

Modifier and Type	Field and Description
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior	ACCEPT If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will continue and the application protocol is assumed to be accepted.
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior	CHOOSE_MY_LAST_PROTOCOL If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will continue assuming the last protocol supported by this peer is used.
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior	FATAL_ALERT If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will be failed with a fatal alert.

Constructor Summary

Access	Constructor and Description
private	SelectedListenerFailureBehavior()

Method Summary

Modifier and Type	Method and Description
public static ApplicationProtocolConfig.SelectedListenerFailureBehavior	valueOf(String name)
public static ApplicationProtocolConfig.SelectedListenerFailureBehavior[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ACCEPT	back to summary
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior ACCEPT If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will continue and the application protocol is assumed to be accepted.

CHOOSE_MY_LAST_PROTOCOL	back to summary
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior CHOOSE_MY_LAST_PROTOCOL If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will continue assuming the last protocol supported by this peer is used. This is used in cases where a "best effort" is desired to talk even if there is no matching protocol, and the assumption is the "most general" fallback protocol is typically listed last.

CHOOSE_MY_LAST_PROTOCOL

back to summary

public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior CHOOSE_MY_LAST_PROTOCOL

If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will continue assuming the last protocol supported by this peer is used. This is used in cases where a "best effort" is desired to talk even if there is no matching protocol, and the assumption is the "most general" fallback protocol is typically listed last.

FATAL_ALERT	back to summary
public static final ApplicationProtocolConfig.SelectedListenerFailureBehavior FATAL_ALERT If the peer who is notified what protocol was selected determines the selection was not matched, or the peer didn't advertise support for the TLS extension then the handshake will be failed with a fatal alert.

Constructor Detail

SelectedListenerFailureBehavior	back to summary
private SelectedListenerFailureBehavior()

Method Detail

valueOf	back to summary
public static ApplicationProtocolConfig.SelectedListenerFailureBehavior valueOf(String name)

values	back to summary
public static ApplicationProtocolConfig.SelectedListenerFailureBehavior[] values()

io.netty5.handler.ssl back to summary

public final Enum ApplicationProtocolConfig.SelectorFailureBehavior

Class Inheritance

extends Enum<ApplicationProtocolConfig.SelectorFailureBehavior>

java.lang.Object
java.lang.Enum
io.netty5.handler.ssl.ApplicationProtocolConfig.SelectorFailureBehavior

Defines the most common behaviors for the peer that selects the application protocol.

Field Summary

Modifier and Type	Field and Description
public static final ApplicationProtocolConfig.SelectorFailureBehavior	CHOOSE_MY_LAST_PROTOCOL If the peer who selects the application protocol doesn't find a match it will just select the last protocol it advertised support for.
public static final ApplicationProtocolConfig.SelectorFailureBehavior	FATAL_ALERT If the peer who selects the application protocol doesn't find a match this will result in the failing the handshake with a fatal alert.
public static final ApplicationProtocolConfig.SelectorFailureBehavior	NO_ADVERTISE If the peer who selects the application protocol doesn't find a match it will pretend no to support the TLS extension by not advertising support for the TLS extension in the handshake.

Constructor Summary

Access	Constructor and Description
private	SelectorFailureBehavior()

Method Summary

Modifier and Type	Method and Description
public static ApplicationProtocolConfig.SelectorFailureBehavior	valueOf(String name)
public static ApplicationProtocolConfig.SelectorFailureBehavior[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CHOOSE_MY_LAST_PROTOCOL	back to summary
public static final ApplicationProtocolConfig.SelectorFailureBehavior CHOOSE_MY_LAST_PROTOCOL If the peer who selects the application protocol doesn't find a match it will just select the last protocol it advertised support for. This is used in cases where a "best effort" is desired to talk even if there is no matching protocol, and the assumption is the "most general" fallback protocol is typically listed last. This may be illegal for some RFCs but was observed behavior by some SSL implementations, and is supported for flexibility/compatibility.

CHOOSE_MY_LAST_PROTOCOL

back to summary

public static final ApplicationProtocolConfig.SelectorFailureBehavior CHOOSE_MY_LAST_PROTOCOL

If the peer who selects the application protocol doesn't find a match it will just select the last protocol it advertised support for. This is used in cases where a "best effort" is desired to talk even if there is no matching protocol, and the assumption is the "most general" fallback protocol is typically listed last.

This may be illegal for some RFCs but was observed behavior by some SSL implementations, and is supported for flexibility/compatibility.

FATAL_ALERT	back to summary
public static final ApplicationProtocolConfig.SelectorFailureBehavior FATAL_ALERT If the peer who selects the application protocol doesn't find a match this will result in the failing the handshake with a fatal alert. For example in the case of ALPN this will result in a no_application_protocol(120) alert.

FATAL_ALERT

back to summary

public static final ApplicationProtocolConfig.SelectorFailureBehavior FATAL_ALERT

If the peer who selects the application protocol doesn't find a match this will result in the failing the handshake with a fatal alert.

For example in the case of ALPN this will result in a no_application_protocol(120) alert.

NO_ADVERTISE	back to summary
public static final ApplicationProtocolConfig.SelectorFailureBehavior NO_ADVERTISE If the peer who selects the application protocol doesn't find a match it will pretend no to support the TLS extension by not advertising support for the TLS extension in the handshake. This is used in cases where a "best effort" is desired to talk even if there is no matching protocol.

Constructor Detail

SelectorFailureBehavior	back to summary
private SelectorFailureBehavior()

Method Detail

valueOf	back to summary
public static ApplicationProtocolConfig.SelectorFailureBehavior valueOf(String name)

values	back to summary
public static ApplicationProtocolConfig.SelectorFailureBehavior[] values()

public final Class ApplicationProtocolConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ApplicationProtocolConfig.Protocol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ApplicationProtocolConfig.SelectedListenerFailureBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ApplicationProtocolConfig.SelectorFailureBehavior

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail