akka.stream

Class TLSProtocol.NegotiateNewSession

java.lang.Object

akka.stream.TLSProtocol.NegotiateNewSession

All Implemented Interfaces:

TLSProtocol.SslTlsOutbound, java.io.Serializable, scala.Equals, scala.Product

Direct Known Subclasses:

TLSProtocol.NegotiateNewSession$

Enclosing class:

TLSProtocol

public static class TLSProtocol.NegotiateNewSession
extends java.lang.Object
implements TLSProtocol.SslTlsOutbound, scala.Product, scala.Serializable

Initiate a new session negotiation. Any TLSProtocol.SendBytes commands following this one will be held back (i.e. back-pressured) until the new handshake is completed, meaning that the bytes following this message will be encrypted according to the requirements outlined here.

Each of the values in this message is optional and will have the following effect if provided:

- enabledCipherSuites will be passed to SSLEngine::setEnabledCipherSuites() - enabledProtocols will be passed to SSLEngine::setEnabledProtocols() - clientAuth will be passed to SSLEngine::setWantClientAuth() or SSLEngine.setNeedClientAuth(), respectively - sslParameters will be passed to SSLEngine::setSSLParameters()

Please note that passing clientAuth = None means that no change is done on client authentication requirements while clientAuth = Some(ClientAuth.None) switches off client authentication.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NegotiateNewSession(scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledCipherSuites, scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledProtocols, scala.Option<TLSClientAuth> clientAuth, scala.Option<javax.net.ssl.SSLParameters> sslParameters)

Method Summary

Modifier and Type	Method and Description
scala.Option<TLSClientAuth>	clientAuth()
scala.Option<scala.collection.immutable.Seq<java.lang.String>>	enabledCipherSuites()
scala.Option<scala.collection.immutable.Seq<java.lang.String>>	enabledProtocols()
scala.Option<javax.net.ssl.SSLParameters>	sslParameters()
TLSProtocol.NegotiateNewSession	withCipherSuites(scala.collection.Seq<java.lang.String> s) Java API: Make a copy of this message with the given enabledCipherSuites.
TLSProtocol.NegotiateNewSession	withCipherSuites(java.lang.String... s) Java API: Make a copy of this message with the given enabledCipherSuites.
TLSProtocol.NegotiateNewSession	withClientAuth(TLSClientAuth ca) Java API: Make a copy of this message with the given TLSClientAuth setting.
TLSProtocol.NegotiateNewSession	withParameters(javax.net.ssl.SSLParameters p) Java API: Make a copy of this message with the given SSLParameters.
TLSProtocol.NegotiateNewSession	withProtocols(scala.collection.Seq<java.lang.String> p) Java API: Make a copy of this message with the given enabledProtocols.
TLSProtocol.NegotiateNewSession	withProtocols(java.lang.String... p) Java API: Make a copy of this message with the given enabledProtocols.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

NegotiateNewSession

public NegotiateNewSession(scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledCipherSuites,
                           scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledProtocols,
                           scala.Option<TLSClientAuth> clientAuth,
                           scala.Option<javax.net.ssl.SSLParameters> sslParameters)

Method Detail

withCipherSuites

public TLSProtocol.NegotiateNewSession withCipherSuites(java.lang.String... s)

Java API: Make a copy of this message with the given enabledCipherSuites.

Parameters:

s - (undocumented)

Returns:

(undocumented)

withProtocols

public TLSProtocol.NegotiateNewSession withProtocols(java.lang.String... p)

Java API: Make a copy of this message with the given enabledProtocols.

Parameters:

p - (undocumented)

Returns:

(undocumented)

enabledCipherSuites

public scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledCipherSuites()

enabledProtocols

public scala.Option<scala.collection.immutable.Seq<java.lang.String>> enabledProtocols()

clientAuth

public scala.Option<TLSClientAuth> clientAuth()

sslParameters

public scala.Option<javax.net.ssl.SSLParameters> sslParameters()

withCipherSuites

public TLSProtocol.NegotiateNewSession withCipherSuites(scala.collection.Seq<java.lang.String> s)

Java API: Make a copy of this message with the given enabledCipherSuites.

Parameters:

s - (undocumented)

Returns:

(undocumented)

withProtocols

public TLSProtocol.NegotiateNewSession withProtocols(scala.collection.Seq<java.lang.String> p)

Java API: Make a copy of this message with the given enabledProtocols.

Parameters:

p - (undocumented)

Returns:

(undocumented)

withClientAuth

public TLSProtocol.NegotiateNewSession withClientAuth(TLSClientAuth ca)

Java API: Make a copy of this message with the given TLSClientAuth setting.

Parameters:

ca - (undocumented)

Returns:

(undocumented)

withParameters

public TLSProtocol.NegotiateNewSession withParameters(javax.net.ssl.SSLParameters p)

Java API: Make a copy of this message with the given SSLParameters.

Parameters:

p - (undocumented)

Returns:

(undocumented)