Packages

final case class SessionBytes(session: SSLSession, bytes: ByteString) extends SslTlsInbound with ScalaSessionAPI with Product with Serializable

Plaintext bytes emitted by the SSLEngine are received over one specific encryption session and this class bundles the bytes with the SSLSession object. When the session changes due to renegotiation (which can be initiated by either party) the new session value will not compare equal to the previous one.

The Java API for getting session information is given by the SSLSession object, the Scala API adapters are offered below.

Source
SslTlsOptions.scala
Linear Supertypes
Serializable, Product, Equals, ScalaSessionAPI, SslTlsInbound, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SessionBytes
  2. Serializable
  3. Product
  4. Equals
  5. ScalaSessionAPI
  6. SslTlsInbound
  7. AnyRef
  8. 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 SessionBytes(session: SSLSession, bytes: ByteString)

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 SessionBytes toany2stringadd[SessionBytes] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SessionBytes, B)
    Implicit
    This member is added by an implicit conversion from SessionBytes toArrowAssoc[SessionBytes] 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 bytes: ByteString
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (SessionBytes) => Boolean, msg: => Any): SessionBytes
    Implicit
    This member is added by an implicit conversion from SessionBytes toEnsuring[SessionBytes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SessionBytes) => Boolean): SessionBytes
    Implicit
    This member is added by an implicit conversion from SessionBytes toEnsuring[SessionBytes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): SessionBytes
    Implicit
    This member is added by an implicit conversion from SessionBytes toEnsuring[SessionBytes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SessionBytes
    Implicit
    This member is added by an implicit conversion from SessionBytes toEnsuring[SessionBytes] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def localCertificates: List[Certificate]

    Scala API: Extract the certificates that were actually used by this engine during this session’s negotiation.

    Scala API: Extract the certificates that were actually used by this engine during this session’s negotiation. The list is empty if no certificates were used.

    Definition Classes
    ScalaSessionAPI
  17. def localPrincipal: Option[Principal]

    Scala API: Extract the Principal that was actually used by this engine during this session’s negotiation.

    Scala API: Extract the Principal that was actually used by this engine during this session’s negotiation.

    Definition Classes
    ScalaSessionAPI
  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 peerCertificates: List[Certificate]

    Scala API: Extract the certificates that were used by the peer engine during this session’s negotiation.

    Scala API: Extract the certificates that were used by the peer engine during this session’s negotiation. The list is empty if no certificates were used.

    Definition Classes
    ScalaSessionAPI
  22. def peerPrincipal: Option[Principal]

    Scala API: Extract the Principal that the peer engine presented during this session’s negotiation.

    Scala API: Extract the Principal that the peer engine presented during this session’s negotiation.

    Definition Classes
    ScalaSessionAPI
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. val session: SSLSession

    The underlying javax.net.ssl.SSLSession.

    The underlying javax.net.ssl.SSLSession.

    Definition Classes
    SessionBytes → ScalaSessionAPI
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 SessionBytes toStringFormat[SessionBytes] 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): (SessionBytes, B)
    Implicit
    This member is added by an implicit conversion from SessionBytes toArrowAssoc[SessionBytes] 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 ScalaSessionAPI

Inherited from SslTlsInbound

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSessionBytes to any2stringadd[SessionBytes]

Inherited by implicit conversion StringFormat fromSessionBytes to StringFormat[SessionBytes]

Inherited by implicit conversion Ensuring fromSessionBytes to Ensuring[SessionBytes]

Inherited by implicit conversion ArrowAssoc fromSessionBytes to ArrowAssoc[SessionBytes]

Ungrouped