c

com.couchbase.client.scala.env

SecurityConfig

case class SecurityConfig(tlsEnabled: Option[Boolean] = None, nativeTlsEnabled: Option[Boolean] = None, trustCertificates: Option[Seq[X509Certificate]] = None, trustManagerFactory: Option[TrustManagerFactory] = None, enableHostnameVerification: Option[Boolean] = None, trustCertificate: Option[Path] = None, ciphers: Option[Seq[String]] = None, trustKeyStore: Option[KeyStore] = None, trustStoreFile: Option[TrustStoreFile] = None) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SecurityConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SecurityConfig(tlsEnabled: Option[Boolean] = None, nativeTlsEnabled: Option[Boolean] = None, trustCertificates: Option[Seq[X509Certificate]] = None, trustManagerFactory: Option[TrustManagerFactory] = None, enableHostnameVerification: Option[Boolean] = None, trustCertificate: Option[Path] = None, ciphers: Option[Seq[String]] = None, trustKeyStore: Option[KeyStore] = None, trustStoreFile: Option[TrustStoreFile] = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def ciphers(value: Seq[String]): SecurityConfig

    Customize the list of ciphers that is negotiated with the cluster.

    Customize the list of ciphers that is negotiated with the cluster.

    Note that this method is considered advanced API, please only customize the cipher list if you know what you are doing (for example if you want to shrink the cipher list down to a very specific subset for security or compliance reasons).

    If no custom ciphers are configured, the default set will be used.

    returns

    this for chaining purposes.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def enableHostnameVerification(value: Boolean): SecurityConfig

    Enables or disable hostname verification (enabled by default).

    Enables or disable hostname verification (enabled by default).

    Note that disabling hostname verification will cause the TLS connection to not verify that the hostname/ip is actually part of the certificate and as a result not detect certain kinds of attacks. Only disable if you understand the impact and risks!

    returns

    this for chaining purposes.

  8. def enableNativeTls(value: Boolean): SecurityConfig

    Enables/disables native TLS (enabled by default).

    Enables/disables native TLS (enabled by default).

    returns

    this for chaining purposes.

  9. def enableTls(value: Boolean): SecurityConfig

    Enables TLS for all client/server communication (disabled by default).

    Enables TLS for all client/server communication (disabled by default).

    returns

    this for chaining purposes.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def trustCertificate(value: Path): SecurityConfig

    Loads a X.509 trust certificate from the given path and uses it.

    Loads a X.509 trust certificate from the given path and uses it.

    returns

    this for chaining purposes.

  18. def trustCertificates(values: Seq[X509Certificate]): SecurityConfig

    Loads the given list of X.509 certificates into the trust store.

    Loads the given list of X.509 certificates into the trust store.

    returns

    this for chaining purposes.

  19. def trustManagerFactory(value: TrustManagerFactory): SecurityConfig

    Provide a trust manager factory directly for maximum flexibility.

    Provide a trust manager factory directly for maximum flexibility.

    While providing the most flexibility, most users will find the other overloads more convenient, like passing in a trustStore directly or via filepath String, Optional).

    returns

    this for chaining purposes.

  20. def trustStore(trustStorePath: Path, trustStorePassword: String, trustStoreType: Option[String] = None): SecurityConfig
  21. def trustStore(value: KeyStore): SecurityConfig
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped