Packages

case class NegotiateNewSession(enabledCipherSuites: Option[Seq[String]], enabledProtocols: Option[Seq[String]], clientAuth: Option[TLSClientAuth], sslParameters: Option[SSLParameters]) extends SslTlsOutbound with Product with Serializable

Initiate a new session negotiation. Any 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.

Source
SslTlsOptions.scala
Linear Supertypes
Serializable, Product, Equals, SslTlsOutbound, AnyRef, Any
Known Subclasses
NegotiateNewSession
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NegotiateNewSession
  2. Serializable
  3. Product
  4. Equals
  5. SslTlsOutbound
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NegotiateNewSession(enabledCipherSuites: Option[Seq[String]], enabledProtocols: Option[Seq[String]], clientAuth: Option[TLSClientAuth], sslParameters: Option[SSLParameters])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toany2stringadd[NegotiateNewSession] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NegotiateNewSession, B)
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toArrowAssoc[NegotiateNewSession] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val clientAuth: Option[TLSClientAuth]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. val enabledCipherSuites: Option[Seq[String]]
  10. val enabledProtocols: Option[Seq[String]]
  11. def ensuring(cond: (NegotiateNewSession) => Boolean, msg: => Any): NegotiateNewSession
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toEnsuring[NegotiateNewSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (NegotiateNewSession) => Boolean): NegotiateNewSession
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toEnsuring[NegotiateNewSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): NegotiateNewSession
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toEnsuring[NegotiateNewSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): NegotiateNewSession
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toEnsuring[NegotiateNewSession] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val sslParameters: Option[SSLParameters]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. def withCipherSuites(s: String*): NegotiateNewSession

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

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

    Annotations
    @varargs()
  28. def withClientAuth(ca: TLSClientAuth): NegotiateNewSession

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

  29. def withParameters(p: SSLParameters): NegotiateNewSession

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

  30. def withProtocols(p: String*): NegotiateNewSession

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

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

    Annotations
    @varargs()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toStringFormat[NegotiateNewSession] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (NegotiateNewSession, B)
    Implicit
    This member is added by an implicit conversion from NegotiateNewSession toArrowAssoc[NegotiateNewSession] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SslTlsOutbound

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNegotiateNewSession to any2stringadd[NegotiateNewSession]

Inherited by implicit conversion StringFormat fromNegotiateNewSession to StringFormat[NegotiateNewSession]

Inherited by implicit conversion Ensuring fromNegotiateNewSession to Ensuring[NegotiateNewSession]

Inherited by implicit conversion ArrowAssoc fromNegotiateNewSession to ArrowAssoc[NegotiateNewSession]

Ungrouped