PasswordAuthenticator (Couchbase JVM Core IO 2.0.0 API)

java.lang.Object
- com.couchbase.client.core.env.PasswordAuthenticator

All Implemented Interfaces:: Authenticator

public class PasswordAuthenticator
extends Object
implements Authenticator

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PasswordAuthenticator.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`
`static PasswordAuthenticator`	`create(String username, String password)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.couchbase.client.core.env.Authenticator
applyTlsProperties, supportsNonTls, supportsTls

- Method Detail
  - builder
```
public static PasswordAuthenticator.Builder builder()
```
  - create
```
public static PasswordAuthenticator create(String username,
                                           String password)
```
  - 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.