Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	JdkApplicationProtocolNegotiator.AllocatorAwareSslEngineWrapperFactory
public static interface	JdkApplicationProtocolNegotiator.ProtocolSelectionListener A listener to be notified by which protocol was select by its peer.
public static interface	JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory Factory interface for `ProtocolSelectionListener` objects.
public static interface	JdkApplicationProtocolNegotiator.ProtocolSelector Interface to define the role of an application protocol selector in the SSL handshake process.
public static interface	JdkApplicationProtocolNegotiator.ProtocolSelectorFactory Factory interface for `ProtocolSelector` objects.
public static interface	JdkApplicationProtocolNegotiator.SslEngineWrapperFactory Abstract factory pattern for wrapping an `SSLEngine` object.

Method Summary

Modifier and Type	Method and Description
public JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory	protocolListenerFactory() Get the `ProtocolSelectionListenerFactory`.
public JdkApplicationProtocolNegotiator.ProtocolSelectorFactory	protocolSelectorFactory() Get the `ProtocolSelectorFactory`.
public JdkApplicationProtocolNegotiator.SslEngineWrapperFactory	wrapperFactory() Get the `SslEngineWrapperFactory`.

Inherited from io.netty.handler.ssl.ApplicationProtocolNegotiator:: protocols

Method Detail

protocolListenerFactory	back to summary
public JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory protocolListenerFactory() Get the `ProtocolSelectionListenerFactory`.

protocolSelectorFactory	back to summary
public JdkApplicationProtocolNegotiator.ProtocolSelectorFactory protocolSelectorFactory() Get the `ProtocolSelectorFactory`.

wrapperFactory	back to summary
public JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory() Get the `SslEngineWrapperFactory`.

io.netty.handler.ssl back to summary

public abstract Class JdkApplicationProtocolNegotiator.AllocatorAwareSslEngineWrapperFactory

Class Inheritance

extends Object
implements SslEngineWrapperFactory

java.lang.Object
io.netty.handler.ssl.JdkApplicationProtocolNegotiator.AllocatorAwareSslEngineWrapperFactory

All Implemented Interfaces

io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Known Direct Subclasses

io.netty.handler.ssl.JdkAlpnApplicationProtocolNegotiator.FailureWrapper, io.netty.handler.ssl.JdkAlpnApplicationProtocolNegotiator.AlpnWrapper

Constructor Summary

Access	Constructor and Description
public	AllocatorAwareSslEngineWrapperFactory()

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public final SSLEngine	wrapSslEngine(SSLEngine The engine to wrap. engine, JdkApplicationProtocolNegotiator The application level protocol negotiator applicationNegotiator, boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections isServer) Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine. Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. Abstract factory pattern for wrapping an `SSLEngine` object.
pack-priv abstract SSLEngine	Returns: The resulting wrapped engine. This may just be `engine`. wrapSslEngine(SSLEngine The engine to wrap. engine, ByteBufAllocator the buffer allocator. alloc, JdkApplicationProtocolNegotiator The application level protocol negotiator applicationNegotiator, boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections isServer) Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. Abstract factory pattern for wrapping an `SSLEngine` object.

public final SSLEngine

wrapSslEngine(SSLEngine

The engine to wrap.

engine, JdkApplicationProtocolNegotiator

The application level protocol negotiator

applicationNegotiator, boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

isServer)

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine.

Deprecated as a consequence of JdkApplicationProtocolNegotiator being deprecated.

Abstract factory pattern for wrapping an SSLEngine object.

pack-priv abstract SSLEngine

Returns:

The resulting wrapped engine. This may just be engine.

wrapSslEngine(SSLEngine

The engine to wrap.

engine, ByteBufAllocator

the buffer allocator.

alloc, JdkApplicationProtocolNegotiator

The application level protocol negotiator

applicationNegotiator, boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

isServer)

Deprecated as a consequence of JdkApplicationProtocolNegotiator being deprecated.

Abstract factory pattern for wrapping an SSLEngine object.

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

Constructor Detail

AllocatorAwareSslEngineWrapperFactory	back to summary
public AllocatorAwareSslEngineWrapperFactory()

Method Detail

wrapSslEngine back to summary

wrapSslEngine	back to summary
public final SSLEngine wrapSslEngine(SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer) Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine. Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine. Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. See corresponding docs for further information. Abstract factory pattern for wrapping an `SSLEngine` object. This is useful for NPN/APLN support. Parameters engine:SSLEngine The engine to wrap. applicationNegotiator:JdkApplicationProtocolNegotiator The application level protocol negotiator isServer:boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections Returns:SSLEngine The resulting wrapped engine. This may just be `engine`. Annotations @Override

public final SSLEngine wrapSslEngine(SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer)

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.SslEngineWrapperFactory.wrapSslEngine.

Deprecated

as a consequence of JdkApplicationProtocolNegotiator being deprecated. See corresponding docs for further information.

Abstract factory pattern for wrapping an SSLEngine object. This is useful for NPN/APLN support.

Parameters

engine:SSLEngine

The engine to wrap.

applicationNegotiator:JdkApplicationProtocolNegotiator

The application level protocol negotiator

isServer:boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

Returns:SSLEngine

The resulting wrapped engine. This may just be engine.

Annotations

@Override

wrapSslEngine back to summary

wrapSslEngine	back to summary
pack-priv abstract SSLEngine wrapSslEngine(SSLEngine engine, ByteBufAllocator alloc, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer) Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. See corresponding docs for further information. Abstract factory pattern for wrapping an `SSLEngine` object. This is useful for NPN/APLN support. Parameters engine:SSLEngine The engine to wrap. alloc:ByteBufAllocator the buffer allocator. applicationNegotiator:JdkApplicationProtocolNegotiator The application level protocol negotiator isServer:boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections Returns:SSLEngine The resulting wrapped engine. This may just be `engine`.

pack-priv abstract SSLEngine wrapSslEngine(SSLEngine engine, ByteBufAllocator alloc, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer)

Deprecated

as a consequence of JdkApplicationProtocolNegotiator being deprecated. See corresponding docs for further information.

Abstract factory pattern for wrapping an SSLEngine object. This is useful for NPN/APLN support.

Parameters

engine:SSLEngine

The engine to wrap.

alloc:ByteBufAllocator

the buffer allocator.

applicationNegotiator:JdkApplicationProtocolNegotiator

The application level protocol negotiator

isServer:boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

Returns:SSLEngine

The resulting wrapped engine. This may just be engine.

io.netty.handler.ssl back to summary

public Interface JdkApplicationProtocolNegotiator.ProtocolSelectionListener

Known Direct Implementers: io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelectionListener

A listener to be notified by which protocol was select by its peer. Either the ProtocolSelectionListener#unsupported() OR the ProtocolSelectionListener#selected(String) method will be called for each SSL handshake.

Method Summary

Modifier and Type	Method and Description
public void	selected(String the protocol selected by the peer. May be `null` or empty as supported by the application negotiation protocol. protocol) Callback invoked to let this application know the protocol chosen by the peer.
public void	unsupported() Callback invoked to let the application know that the peer does not support this `ApplicationProtocolNegotiator`.

Method Detail

selected back to summary

selected	back to summary
public void selected(String protocol) throws Exception Callback invoked to let this application know the protocol chosen by the peer. Parameters protocol:String the protocol selected by the peer. May be `null` or empty as supported by the application negotiation protocol. Exceptions Exception: This may be thrown if the selected protocol is not acceptable and the desired behavior is to fail the handshake with a fatal alert.

public void selected(String protocol) throws Exception

Callback invoked to let this application know the protocol chosen by the peer.

Parameters

protocol:String: the protocol selected by the peer. May be null or empty as supported by the application negotiation protocol.

Exceptions

Exception:: This may be thrown if the selected protocol is not acceptable and the desired behavior is to fail the handshake with a fatal alert.

unsupported	back to summary
public void unsupported() Callback invoked to let the application know that the peer does not support this `ApplicationProtocolNegotiator`.

io.netty.handler.ssl back to summary

public Interface JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory

Factory interface for ProtocolSelectionListener objects.

Method Summary

Modifier and Type	Method and Description
public JdkApplicationProtocolNegotiator.ProtocolSelectionListener	Returns: A new instance of `ProtocolSelectionListener`. newListener(SSLEngine The `SSLEngine` that the returned `ProtocolSelectionListener` will be used to create an instance for. engine, List<String> The protocols that are supported in preference order. supportedProtocols) Generate a new instance of `ProtocolSelectionListener`.

Method Detail

newListener back to summary

newListener	back to summary
public JdkApplicationProtocolNegotiator.ProtocolSelectionListener newListener(SSLEngine engine, List<String> supportedProtocols) Generate a new instance of `ProtocolSelectionListener`. Parameters engine:SSLEngine The `SSLEngine` that the returned `ProtocolSelectionListener` will be used to create an instance for. supportedProtocols:List<String> The protocols that are supported in preference order. Returns:JdkApplicationProtocolNegotiator.ProtocolSelectionListener A new instance of `ProtocolSelectionListener`.

public JdkApplicationProtocolNegotiator.ProtocolSelectionListener newListener(SSLEngine engine, List<String> supportedProtocols)

Generate a new instance of ProtocolSelectionListener.

Parameters

engine:SSLEngine: The SSLEngine that the returned ProtocolSelectionListener will be used to create an instance for.
supportedProtocols:List<String>: The protocols that are supported in preference order.

Returns:JdkApplicationProtocolNegotiator.ProtocolSelectionListener

A new instance of ProtocolSelectionListener.

io.netty.handler.ssl back to summary

public Interface JdkApplicationProtocolNegotiator.ProtocolSelector

Known Direct Implementers: io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelector

Interface to define the role of an application protocol selector in the SSL handshake process. Either ProtocolSelector#unsupported() OR ProtocolSelector#select(List) will be called for each SSL handshake.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public String	Returns: the protocol selected by this `ProtocolSelector`. A `null` value will indicate the no protocols were selected but the handshake should not fail. The decision to fail the handshake is left to the other end negotiating the SSL handshake. select(List<String> the protocols sent by the protocol advertiser protocols) Callback invoked to select the application level protocol from the `protocols` provided.
public void	unsupported() Callback invoked to let the application know that the peer does not support this `ApplicationProtocolNegotiator`.

public String

Returns:

the protocol selected by this ProtocolSelector. A null value will indicate the no protocols were selected but the handshake should not fail. The decision to fail the handshake is left to the other end negotiating the SSL handshake.

select(List<String>

the protocols sent by the protocol advertiser

protocols)

Callback invoked to select the application level protocol from the protocols provided.

public void

unsupported()

Callback invoked to let the application know that the peer does not support this ApplicationProtocolNegotiator.

Method Detail

select back to summary

select	back to summary
public String select(List<String> protocols) throws Exception Callback invoked to select the application level protocol from the `protocols` provided. Parameters protocols:List<String> the protocols sent by the protocol advertiser Returns:String the protocol selected by this `ProtocolSelector`. A `null` value will indicate the no protocols were selected but the handshake should not fail. The decision to fail the handshake is left to the other end negotiating the SSL handshake. Exceptions Exception: If the `protocols` provide warrant failing the SSL handshake with a fatal alert.

public String select(List<String> protocols) throws Exception

Callback invoked to select the application level protocol from the protocols provided.

Parameters

protocols:List<String>: the protocols sent by the protocol advertiser

Returns:String

Exceptions

Exception:: If the protocols provide warrant failing the SSL handshake with a fatal alert.

unsupported	back to summary
public void unsupported() Callback invoked to let the application know that the peer does not support this `ApplicationProtocolNegotiator`.

io.netty.handler.ssl back to summary

public Interface JdkApplicationProtocolNegotiator.ProtocolSelectorFactory

Factory interface for ProtocolSelector objects.

Method Summary

Modifier and Type	Method and Description
public JdkApplicationProtocolNegotiator.ProtocolSelector	Returns: A new instance of `ProtocolSelector`. newSelector(SSLEngine The `SSLEngine` that the returned `ProtocolSelector` will be used to create an instance for. engine, Set<String> The protocols that are supported. supportedProtocols) Generate a new instance of `ProtocolSelector`.

Method Detail

newSelector back to summary

newSelector	back to summary
public JdkApplicationProtocolNegotiator.ProtocolSelector newSelector(SSLEngine engine, Set<String> supportedProtocols) Generate a new instance of `ProtocolSelector`. Parameters engine:SSLEngine The `SSLEngine` that the returned `ProtocolSelector` will be used to create an instance for. supportedProtocols:Set<String> The protocols that are supported. Returns:JdkApplicationProtocolNegotiator.ProtocolSelector A new instance of `ProtocolSelector`.

public JdkApplicationProtocolNegotiator.ProtocolSelector newSelector(SSLEngine engine, Set<String> supportedProtocols)

Generate a new instance of ProtocolSelector.

Parameters

engine:SSLEngine: The SSLEngine that the returned ProtocolSelector will be used to create an instance for.
supportedProtocols:Set<String>: The protocols that are supported.

Returns:JdkApplicationProtocolNegotiator.ProtocolSelector

A new instance of ProtocolSelector.

io.netty.handler.ssl back to summary

public Interface JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Known Direct Implementers: io.netty.handler.ssl.JdkApplicationProtocolNegotiator.AllocatorAwareSslEngineWrapperFactory

Abstract factory pattern for wrapping an SSLEngine object. This is useful for NPN/APLN JDK support.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public SSLEngine	Returns: The resulting wrapped engine. This may just be `engine`. wrapSslEngine(SSLEngine The engine to wrap. engine, JdkApplicationProtocolNegotiator The application level protocol negotiator applicationNegotiator, boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections isServer) Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. Abstract factory pattern for wrapping an `SSLEngine` object.

public SSLEngine

Returns:

The resulting wrapped engine. This may just be engine.

wrapSslEngine(SSLEngine

The engine to wrap.

engine, JdkApplicationProtocolNegotiator

The application level protocol negotiator

applicationNegotiator, boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

isServer)

Deprecated as a consequence of JdkApplicationProtocolNegotiator being deprecated.

Abstract factory pattern for wrapping an SSLEngine object.

Method Detail

wrapSslEngine back to summary

wrapSslEngine	back to summary
public SSLEngine wrapSslEngine(SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer) Deprecated as a consequence of `JdkApplicationProtocolNegotiator` being deprecated. See corresponding docs for further information. Abstract factory pattern for wrapping an `SSLEngine` object. This is useful for NPN/APLN support. Parameters engine:SSLEngine The engine to wrap. applicationNegotiator:JdkApplicationProtocolNegotiator The application level protocol negotiator isServer:boolean `true` if the engine is for server side of connections `false` if the engine is for client side of connections Returns:SSLEngine The resulting wrapped engine. This may just be `engine`.

public SSLEngine wrapSslEngine(SSLEngine engine, JdkApplicationProtocolNegotiator applicationNegotiator, boolean isServer)

Deprecated

as a consequence of JdkApplicationProtocolNegotiator being deprecated. See corresponding docs for further information.

Abstract factory pattern for wrapping an SSLEngine object. This is useful for NPN/APLN support.

Parameters

engine:SSLEngine

The engine to wrap.

applicationNegotiator:JdkApplicationProtocolNegotiator

The application level protocol negotiator

isServer:boolean

true if the engine is for server side of connections
false if the engine is for client side of connections

Returns:SSLEngine

The resulting wrapped engine. This may just be engine.