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

pack-priv Class JdkBaseApplicationProtocolNegotiator

extends Object
implements JdkApplicationProtocolNegotiator
Class Inheritance
All Implemented Interfaces
io.netty.handler.ssl.JdkApplicationProtocolNegotiator, io.netty.handler.ssl.ApplicationProtocolNegotiator
Known Direct Subclasses
io.netty.handler.ssl.JdkNpnApplicationProtocolNegotiator, io.netty.handler.ssl.JdkAlpnApplicationProtocolNegotiator
Static Imports
io.netty.handler.ssl.ApplicationProtocolUtil.toList, io.netty.util.internal.ObjectUtil.checkNotNull

Deprecated

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

Common base class for JdkApplicationProtocolNegotiator classes to inherit from.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class
private static class
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
private final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
private final List<String>
private final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
private final JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Constructor Summary

AccessConstructor and Description
pack-priv
JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory
Determines which application protocol will be used by wrapping the SSLEngine in use.
wrapperFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
How the peer selecting the protocol should behave.
selectorFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
How the peer being notified of the selected protocol should behave.
listenerFactory
,
Iterable<String>
The order of iteration determines the preference of support for protocols.
protocols
)

Create a new instance.

pack-priv
JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory
Determines which application protocol will be used by wrapping the SSLEngine in use.
wrapperFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
How the peer selecting the protocol should behave.
selectorFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
How the peer being notified of the selected protocol should behave.
listenerFactory
,
String...
The order of iteration determines the preference of support for protocols.
protocols
)

Create a new instance.

private
JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory
Determines which application protocol will be used by wrapping the SSLEngine in use.
wrapperFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
How the peer selecting the protocol should behave.
selectorFactory
,
JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
How the peer being notified of the selected protocol should behave.
listenerFactory
,
List<String>
The order of iteration determines the preference of support for protocols.
protocols
)

Create a new instance.

Method Summary

Modifier and TypeMethod and Description
public JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory
public List<String>
protocols()

Implements io.netty.handler.ssl.ApplicationProtocolNegotiator.protocols.

Get the collection of application protocols supported by this application (in preference order).
public JdkApplicationProtocolNegotiator.ProtocolSelectorFactory
public JdkApplicationProtocolNegotiator.SslEngineWrapperFactory
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FAIL_SELECTION_LISTENER_FACTORYback to summary
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory FAIL_SELECTION_LISTENER_FACTORY
FAIL_SELECTOR_FACTORYback to summary
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory FAIL_SELECTOR_FACTORY
listenerFactoryback to summary
private final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory listenerFactory
NO_FAIL_SELECTION_LISTENER_FACTORYback to summary
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory NO_FAIL_SELECTION_LISTENER_FACTORY
NO_FAIL_SELECTOR_FACTORYback to summary
pack-priv static final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory NO_FAIL_SELECTOR_FACTORY
protocolsback to summary
private final List<String> protocols
selectorFactoryback to summary
private final JdkApplicationProtocolNegotiator.ProtocolSelectorFactory selectorFactory
wrapperFactoryback to summary
private final JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory

Constructor Detail

JdkBaseApplicationProtocolNegotiatorback to summary
pack-priv JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory, JdkApplicationProtocolNegotiator.ProtocolSelectorFactory selectorFactory, JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory listenerFactory, Iterable<String> protocols)

Create a new instance.

Parameters
wrapperFactory:JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Determines which application protocol will be used by wrapping the SSLEngine in use.

selectorFactory:JdkApplicationProtocolNegotiator.ProtocolSelectorFactory

How the peer selecting the protocol should behave.

listenerFactory:JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory

How the peer being notified of the selected protocol should behave.

protocols:Iterable<String>

The order of iteration determines the preference of support for protocols.

JdkBaseApplicationProtocolNegotiatorback to summary
pack-priv JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory, JdkApplicationProtocolNegotiator.ProtocolSelectorFactory selectorFactory, JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory listenerFactory, String... protocols)

Create a new instance.

Parameters
wrapperFactory:JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Determines which application protocol will be used by wrapping the SSLEngine in use.

selectorFactory:JdkApplicationProtocolNegotiator.ProtocolSelectorFactory

How the peer selecting the protocol should behave.

listenerFactory:JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory

How the peer being notified of the selected protocol should behave.

protocols:String[]

The order of iteration determines the preference of support for protocols.

JdkBaseApplicationProtocolNegotiatorback to summary
private JdkBaseApplicationProtocolNegotiator(JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory, JdkApplicationProtocolNegotiator.ProtocolSelectorFactory selectorFactory, JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory listenerFactory, List<String> protocols)

Create a new instance.

Parameters
wrapperFactory:JdkApplicationProtocolNegotiator.SslEngineWrapperFactory

Determines which application protocol will be used by wrapping the SSLEngine in use.

selectorFactory:JdkApplicationProtocolNegotiator.ProtocolSelectorFactory

How the peer selecting the protocol should behave.

listenerFactory:JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory

How the peer being notified of the selected protocol should behave.

protocols:List<String>

The order of iteration determines the preference of support for protocols.

Method Detail

protocolListenerFactoryback to summary
public JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory protocolListenerFactory()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.protocolListenerFactory.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.protocolListenerFactory.

Get the ProtocolSelectionListenerFactory.

Annotations
@Override
protocolsback to summary
public List<String> protocols()

Implements io.netty.handler.ssl.ApplicationProtocolNegotiator.protocols.

Doc from io.netty.handler.ssl.ApplicationProtocolNegotiator.protocols.

Get the collection of application protocols supported by this application (in preference order).

Annotations
@Override
protocolSelectorFactoryback to summary
public JdkApplicationProtocolNegotiator.ProtocolSelectorFactory protocolSelectorFactory()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.protocolSelectorFactory.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.protocolSelectorFactory.

Get the ProtocolSelectorFactory.

Annotations
@Override
wrapperFactoryback to summary
public JdkApplicationProtocolNegotiator.SslEngineWrapperFactory wrapperFactory()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.wrapperFactory.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.wrapperFactory.

Get the SslEngineWrapperFactory.

Annotations
@Override
io.netty.handler.ssl back to summary

private final Class JdkBaseApplicationProtocolNegotiator.FailProtocolSelectionListener

extends NoFailProtocolSelectionListener
Class Inheritance

Constructor Summary

AccessConstructor and Description
pack-priv
FailProtocolSelectionListener(JdkSslEngine engineWrapper, List<String> supportedProtocols)

Method Summary

Modifier and TypeMethod and Description
protected void
Inherited from io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelectionListener:
selectedunsupported

Constructor Detail

FailProtocolSelectionListenerback to summary
pack-priv FailProtocolSelectionListener(JdkSslEngine engineWrapper, List<String> supportedProtocols)

Method Detail

noSelectedMatchFoundback to summary
protected void noSelectedMatchFound(String protocol) throws Exception

Overrides io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelectionListener.noSelectedMatchFound.

Annotations
@Override
io.netty.handler.ssl back to summary

private final Class JdkBaseApplicationProtocolNegotiator.FailProtocolSelector

extends NoFailProtocolSelector
Class Inheritance

Constructor Summary

AccessConstructor and Description
pack-priv
FailProtocolSelector(JdkSslEngine engineWrapper, Set<String> supportedProtocols)

Method Summary

Modifier and TypeMethod and Description
public String
Inherited from io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelector:
selectunsupported

Constructor Detail

FailProtocolSelectorback to summary
pack-priv FailProtocolSelector(JdkSslEngine engineWrapper, Set<String> supportedProtocols)

Method Detail

noSelectMatchFoundback to summary
public String noSelectMatchFound() throws Exception

Overrides io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelector.noSelectMatchFound.

Annotations
@Override
io.netty.handler.ssl back to summary

private Class JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelectionListener

extends Object
implements ProtocolSelectionListener
Class Inheritance
  • java.lang.Object
  • io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelectionListener
All Implemented Interfaces
io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener
Known Direct Subclasses
io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.FailProtocolSelectionListener

Field Summary

Modifier and TypeField and Description
private final JdkSslEngine
private final List<String>

Constructor Summary

AccessConstructor and Description
pack-priv
NoFailProtocolSelectionListener(JdkSslEngine engineWrapper, List<String> supportedProtocols)

Method Summary

Modifier and TypeMethod and Description
protected void
public void
selected(String
the protocol selected by the peer. May be null or empty as supported by the application negotiation protocol.
protocol
)

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.selected.

Callback invoked to let this application know the protocol chosen by the peer.
public void
unsupported()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.unsupported.

Callback invoked to let the application know that the peer does not support this ApplicationProtocolNegotiator.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

engineWrapperback to summary
private final JdkSslEngine engineWrapper
supportedProtocolsback to summary
private final List<String> supportedProtocols

Constructor Detail

NoFailProtocolSelectionListenerback to summary
pack-priv NoFailProtocolSelectionListener(JdkSslEngine engineWrapper, List<String> supportedProtocols)

Method Detail

noSelectedMatchFoundback to summary
protected void noSelectedMatchFound(String protocol) throws Exception
selectedback to summary
public void selected(String protocol) throws Exception

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.selected.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.selected.

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.

Annotations
@Override
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.
unsupportedback to summary
public void unsupported()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.unsupported.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelectionListener.unsupported.

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

Annotations
@Override
io.netty.handler.ssl back to summary

pack-priv Class JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelector

extends Object
implements ProtocolSelector
Class Inheritance
  • java.lang.Object
  • io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.NoFailProtocolSelector
All Implemented Interfaces
io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector
Known Direct Subclasses
io.netty.handler.ssl.JdkBaseApplicationProtocolNegotiator.FailProtocolSelector

Field Summary

Modifier and TypeField and Description
private final JdkSslEngine
private final Set<String>

Constructor Summary

AccessConstructor and Description
pack-priv
NoFailProtocolSelector(JdkSslEngine engineWrapper, Set<String> supportedProtocols)

Method Summary

Modifier and TypeMethod and Description
public String
public String
select(List<String>
the protocols sent by the protocol advertiser
protocols
)

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.select.

Callback invoked to select the application level protocol from the protocols provided.
public void
unsupported()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.unsupported.

Callback invoked to let the application know that the peer does not support this ApplicationProtocolNegotiator.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

engineWrapperback to summary
private final JdkSslEngine engineWrapper
supportedProtocolsback to summary
private final Set<String> supportedProtocols

Constructor Detail

NoFailProtocolSelectorback to summary
pack-priv NoFailProtocolSelector(JdkSslEngine engineWrapper, Set<String> supportedProtocols)

Method Detail

noSelectMatchFoundback to summary
public String noSelectMatchFound() throws Exception
selectback to summary
public String select(List<String> protocols) throws Exception

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.select.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.select.

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.

Annotations
@Override
Exceptions
Exception:
If the protocols provide warrant failing the SSL handshake with a fatal alert.
unsupportedback to summary
public void unsupported()

Implements io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.unsupported.

Doc from io.netty.handler.ssl.JdkApplicationProtocolNegotiator.ProtocolSelector.unsupported.

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

Annotations
@Override