Class PasswordAuthenticator

java.lang.Object
com.couchbase.client.core.env.PasswordAuthenticator
All Implemented Interfaces:
Authenticator

public class PasswordAuthenticator extends Object implements Authenticator
Performs authentication against a couchbase server cluster using username and password.
  • Method Details

    • builder

      public static PasswordAuthenticator.Builder builder()
      Creates a new PasswordAuthenticator.Builder which allows to customize this authenticator.
    • create

      public static PasswordAuthenticator create(String username, String password)
      Creates a new password authenticator with the default settings.
      Parameters:
      username - the username to use for all authentication.
      password - the password to use alongside the username.
      Returns:
      the instantiated PasswordAuthenticator.
    • ldapCompatible

      public static PasswordAuthenticator ldapCompatible(String username, String password)
      Creates a LDAP compatible password authenticator which is INSECURE if not used with TLS.

      Please note that this is INSECURE and will leak user credentials on the wire to eavesdroppers. This should only be enabled in trusted environments.

      Parameters:
      username - the username to use for all authentication.
      password - the password to use alongside the username.
      Returns:
      the instantiated PasswordAuthenticator.
    • authKeyValueConnection

      public void authKeyValueConnection(EndpointContext ctx, com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
      Description copied from interface: Authenticator
      Allows the authenticator to add KV handlers during connection bootstrap to perform authentication.
      Specified by:
      authKeyValueConnection in interface Authenticator
      Parameters:
      ctx - the endpoint context.
      pipeline - the pipeline when the endpoint is constructed.
    • authHttpRequest

      public void authHttpRequest(ServiceType serviceType, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
      Description copied from interface: Authenticator
      Allows to add authentication credentials to the http request for the given service.
      Specified by:
      authHttpRequest in interface Authenticator
      Parameters:
      serviceType - the service for this request.
      request - the http request.
    • protostellarCallCredentials

      public com.couchbase.client.core.deps.io.grpc.CallCredentials protostellarCallCredentials()
      Specified by:
      protostellarCallCredentials in interface Authenticator