Overrides javax.net.ssl.SSLEngine.getApplicationProtocol.

Doc from javax.net.ssl.SSLEngine.getApplicationProtocol.

Returns the most recent application protocol value negotiated for this connection.

If supported by the underlying SSL/TLS/DTLS implementation, application name negotiation mechanisms such as RFC 7301 , the Application-Layer Protocol Negotiation (ALPN), can negotiate application-level values between peers.

Returns:String

null if it has not yet been determined if application protocols might be used for this connection, an empty String if application protocols values will not be used, or a non-empty application protocol String if a value was successfully negotiated.

Overrides javax.net.ssl.SSLEngine.getHandshakeApplicationProtocol.

Doc from javax.net.ssl.SSLEngine.getHandshakeApplicationProtocol.

Returns the application protocol value negotiated on a SSL/TLS handshake currently in progress.

Like getHandshakeSession(), a connection may be in the middle of a handshake. The application protocol may or may not yet be available.

Returns:String

null if it has not yet been determined if application protocols might be used for this handshake, an empty String if application protocols values will not be used, or a non-empty application protocol String if a value was successfully negotiated.

Overrides javax.net.ssl.SSLEngine.getHandshakeApplicationProtocolSelector.

Doc from javax.net.ssl.SSLEngine.getHandshakeApplicationProtocolSelector.

Retrieves the callback function that selects an application protocol value during a SSL/TLS/DTLS handshake. See setHandshakeApplicationProtocolSelector for the function's type parameters.

Returns:BiFunction<SSLEngine, List<String>, String>

the callback function, or null if none has been set.

Overrides io.netty.handler.ssl.JdkSslEngine.getNegotiatedApplicationProtocol.

Implements io.netty.handler.ssl.ApplicationProtocolAccessor.getNegotiatedApplicationProtocol.

Doc from io.netty.handler.ssl.ApplicationProtocolAccessor.getNegotiatedApplicationProtocol.

Returns the name of the negotiated application-level protocol.

Returns:String

the application-level protocol name or null if the negotiation failed or the client does not have ALPN/NPN extension

Annotations

@Override

Overrides javax.net.ssl.SSLEngine.setHandshakeApplicationProtocolSelector.

Doc from javax.net.ssl.SSLEngine.setHandshakeApplicationProtocolSelector.

Registers a callback function that selects an application protocol value for a SSL/TLS/DTLS handshake. The function overrides any values supplied using SSLParameters.setApplicationProtocols and it supports the following type parameters:

SSLEngine

The function's first argument allows the current SSLEngine to be inspected, including the handshake session and configuration settings.

List<String>

The function's second argument lists the application protocol names advertised by the TLS peer.

String

The function's result is an application protocol name, or null to indicate that none of the advertised names are acceptable. If the return value is an empty String then application protocol indications will not be used. If the return value is null (no value chosen) or is a value that was not advertised by the peer, the underlying protocol will determine what action to take. (For example, ALPN will send a "no_application_protocol" alert and terminate the connection.)

serverEngine.setHandshakeApplicationProtocolSelector(
        (serverEngine, clientProtocols) -> {
            SSLSession session = serverEngine.getHandshakeSession();
            return chooseApplicationProtocol(
                serverEngine,
                clientProtocols,
                session.getProtocol(),
                session.getCipherSuite());
        });

Parameters

selector:BiFunction<SSLEngine, List<String>, String>

the callback function, or null to disable the callback functionality.

Overrides io.netty.handler.ssl.JdkSslEngine.unwrap.

Doc from javax.net.ssl.SSLEngine.unwrap.

Attempts to decode SSL/TLS/DTLS network data into a plaintext application data buffer.

An invocation of this method behaves in exactly the same manner as the invocation:

engine.unwrap(src, new ByteBuffer[] { dst }, 0, 1);

Parameters

src:ByteBuffer

a ByteBuffer containing inbound network data.

dst:ByteBuffer

a ByteBuffer to hold inbound application data.

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.

Overrides io.netty.handler.ssl.JdkSslEngine.unwrap.

Doc from javax.net.ssl.SSLEngine.unwrap.

Attempts to decode SSL/TLS/DTLS network data into a sequence of plaintext application data buffers.

An invocation of this method behaves in exactly the same manner as the invocation:

engine.unwrap(src, dsts, 0, dsts.length);

Parameters

src:ByteBuffer

a ByteBuffer containing inbound network data.

dsts:ByteBuffer[]

an array of ByteBuffers to hold inbound application data.

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.

Overrides io.netty.handler.ssl.JdkSslEngine.unwrap.

Doc from javax.net.ssl.SSLEngine.unwrap.

Attempts to decode SSL/TLS/DTLS network data into a subsequence of plaintext application data buffers. This "scattering" operation decodes, in a single invocation, a sequence of bytes into one or more of a given sequence of buffers. Scattering unwraps are often useful when implementing network protocols or file formats that, for example, group data into segments consisting of one or more fixed-length headers followed by a variable-length body. See java.nio.channels.ScatteringByteChannel for more information on scattering, and java.nio.channels.ScatteringByteChannel#read(ByteBuffer[], int, int) for more information on the subsequence behavior.

Depending on the state of the SSLEngine, this method may consume network data without producing any application data (for example, it may consume handshake data.)

The application is responsible for reliably obtaining the network data from the peer, and for invoking unwrap() on the data in the order it was received. The application must properly synchronize multiple calls to this method.

If this SSLEngine has not yet started its initial handshake, this method will automatically start the handshake.

This method will attempt to consume one complete SSL/TLS/DTLS network packet, but will never consume more than the sum of the bytes remaining in the buffers. Each ByteBuffer's position is updated to reflect the amount of data consumed or produced. The limits remain the same.

The underlying memory used by the src and dsts ByteBuffers must not be the same.

The inbound network buffer, src, may be modified as a result of this call: therefore if the network data packet is required for some secondary purpose, the data should be duplicated before calling this method.

Parameters

src:ByteBuffer

a ByteBuffer containing inbound network data.

dst:ByteBuffer[]

an array of ByteBuffers to hold inbound application data.

offset:int

The offset within the buffer array of the first buffer from which bytes are to be transferred; it must be non-negative and no larger than dsts.length.

len:int

The maximum number of buffers to be accessed; it must be non-negative and no larger than dsts.length - offset.

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.

Overrides io.netty.handler.ssl.JdkSslEngine.wrap.

Doc from javax.net.ssl.SSLEngine.wrap.

Attempts to encode a buffer of plaintext application data into SSL/TLS/DTLS network data.

An invocation of this method behaves in exactly the same manner as the invocation:

engine.wrap(new ByteBuffer[] { src }, 0, 1, dst);

Parameters

src:ByteBuffer

a ByteBuffer containing outbound application data

dst:ByteBuffer

a ByteBuffer to hold outbound network data

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.

Overrides io.netty.handler.ssl.JdkSslEngine.wrap.

Doc from javax.net.ssl.SSLEngine.wrap.

Attempts to encode plaintext bytes from a sequence of data buffers into SSL/TLS/DTLS network data.

An invocation of this method behaves in exactly the same manner as the invocation:

engine.wrap(srcs, 0, srcs.length, dst);

Parameters

srcs:ByteBuffer[]

an array of ByteBuffers containing the outbound application data

dst:ByteBuffer

a ByteBuffer to hold outbound network data

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.

Overrides io.netty.handler.ssl.JdkSslEngine.wrap.

Doc from javax.net.ssl.SSLEngine.wrap.

Attempts to encode plaintext bytes from a subsequence of data buffers into SSL/TLS/DTLS network data. This "gathering" operation encodes, in a single invocation, a sequence of bytes from one or more of a given sequence of buffers. Gathering wraps are often useful when implementing network protocols or file formats that, for example, group data into segments consisting of one or more fixed-length headers followed by a variable-length body. See java.nio.channels.GatheringByteChannel for more information on gathering, and java.nio.channels.GatheringByteChannel#write(ByteBuffer[], int, int) for more information on the subsequence behavior.

Depending on the state of the SSLEngine, this method may produce network data without consuming any application data (for example, it may generate handshake data.)

The application is responsible for reliably transporting the network data to the peer, and for ensuring that data created by multiple calls to wrap() is transported in the same order in which it was generated. The application must properly synchronize multiple calls to this method.

If this SSLEngine has not yet started its initial handshake, this method will automatically start the handshake.

This method will attempt to produce SSL/TLS/DTLS records, and will consume as much source data as possible, but will never consume more than the sum of the bytes remaining in each buffer. Each ByteBuffer's position is updated to reflect the amount of data consumed or produced. The limits remain the same.

The underlying memory used by the srcs and dst ByteBuffers must not be the same.

See the class description for more information on engine closure.

Parameters

srcs:ByteBuffer[]

an array of ByteBuffers containing the outbound application data

offset:int

The offset within the buffer array of the first buffer from which bytes are to be retrieved; it must be non-negative and no larger than srcs.length

len:int

The maximum number of buffers to be accessed; it must be non-negative and no larger than srcs.length - offset

dst:ByteBuffer

a ByteBuffer to hold outbound network data

Returns:SSLEngineResult

an SSLEngineResult describing the result of this operation.

Annotations

@Override

Exceptions

SSLException:

A problem was encountered while processing the data that caused the SSLEngine to abort. See the class description for more information on engine closure.