public class PasswordAuthenticator extends Object implements Authenticator
Modifier and Type | Class and Description |
---|---|
static class |
PasswordAuthenticator.Builder
Provides customization to the
PasswordAuthenticator . |
Modifier and Type | Method and Description |
---|---|
void |
authHttpRequest(ServiceType serviceType,
com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
Allows to add authentication credentials to the http request for the given service.
|
void |
authKeyValueConnection(EndpointContext ctx,
com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
Allows the authenticator to add KV handlers during connection bootstrap to perform
authentication.
|
static PasswordAuthenticator.Builder |
builder()
Creates a new
PasswordAuthenticator.Builder which allows to customize this authenticator. |
static PasswordAuthenticator |
create(String username,
String password)
Creates a new password authenticator with the default settings.
|
static PasswordAuthenticator |
ldapCompatible(String username,
String password)
Creates a LDAP compatible password authenticator which is INSECURE if not used with TLS.
|
com.couchbase.client.core.deps.io.grpc.CallCredentials |
protostellarCallCredentials() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyTlsProperties, supportsNonTls, supportsTls
public static PasswordAuthenticator.Builder builder()
PasswordAuthenticator.Builder
which allows to customize this authenticator.public static PasswordAuthenticator create(String username, String password)
username
- the username to use for all authentication.password
- the password to use alongside the username.PasswordAuthenticator
.public static PasswordAuthenticator ldapCompatible(String username, String password)
Please note that this is INSECURE and will leak user credentials on the wire to eavesdroppers. This should only be enabled in trusted environments.
username
- the username to use for all authentication.password
- the password to use alongside the username.PasswordAuthenticator
.public void authKeyValueConnection(EndpointContext ctx, com.couchbase.client.core.deps.io.netty.channel.ChannelPipeline pipeline)
Authenticator
authKeyValueConnection
in interface Authenticator
ctx
- the endpoint context.pipeline
- the pipeline when the endpoint is constructed.public void authHttpRequest(ServiceType serviceType, com.couchbase.client.core.deps.io.netty.handler.codec.http.HttpRequest request)
Authenticator
authHttpRequest
in interface Authenticator
serviceType
- the service for this request.request
- the http request.public com.couchbase.client.core.deps.io.grpc.CallCredentials protostellarCallCredentials()
protostellarCallCredentials
in interface Authenticator
Copyright © 2024 Couchbase, Inc.. All rights reserved.