Package com.couchbase.client.dcp

Interface Authenticator

All Known Implementing Classes:
CertificateAuthenticator, PasswordAuthenticator
public interface Authenticator

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
    The authenticator gets the chance to attach the client certificate to the ssl context if needed.
    default void
    authKeyValueConnection(com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
    Allows the authenticator to add KV handlers during connection bootstrap to perform authentication.
    default boolean
    requiresTls()
    If this authenticator only works with encrypted connections.

  • Method Details

    • authKeyValueConnection

      default void authKeyValueConnection(com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
      Allows the authenticator to add KV handlers during connection bootstrap to perform authentication.
      Parameters:
      pipeline - the pipeline when the endpoint is constructed.

    • applyTlsProperties

      default void applyTlsProperties(com.couchbase.client.core.deps.io.netty.handler.ssl.SslContextBuilder sslContextBuilder)
      The authenticator gets the chance to attach the client certificate to the ssl context if needed.
      Parameters:
      sslContextBuilder - the netty context builder

    • requiresTls

      default boolean requiresTls()
      If this authenticator only works with encrypted connections.