PasswordAuthenticator (Couchbase Java SDK)

java.lang.Object

com.couchbase.client.java.auth.PasswordAuthenticator

All Implemented Interfaces:: Authenticator

@Uncommitted
@Public
public class PasswordAuthenticator
extends Object
implements Authenticator

Authenticator for RBAC users in Couchbase

Since:: 2.4.4
Author:: Subhashni Balakrishnan

Constructor Summary

Constructors

Constructor Description

PasswordAuthenticator(String password)

PasswordAuthenticator(String username, String password)

Method Summary

Modifier and Type	Method	Description
`List<Credential>`	`getCredentials(CredentialContext context, String specific)`	Retrieve the credentials store by this `Authenticator` for the given `CredentialContext` and optional specific.
`boolean`	`isEmpty()`
`String`	`password()`
`String`	`username()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- PasswordAuthenticator
  
  public PasswordAuthenticator(String password)
- PasswordAuthenticator
  
  public PasswordAuthenticator(String username, String password)
Method Details
- getCredentials
  
  public List<Credential> getCredentials(CredentialContext context, String specific)
  
  Description copied from interface: Authenticator
  
  Retrieve the credentials store by this Authenticator for the given CredentialContext and optional specific. If no corresponding credential can be found, an empty list is returned. If the context / specific cannot be processed by this Authenticator, throws an IllegalArgumentException.
  
  Specified by:
  
  getCredentials in interface Authenticator
  
  Parameters:
  
  context - the context for which the credential(s) will be used.
  
  specific - a more restrictive sub-context specific to the context.
  
  Returns:
  
  a list of credentials that can be used for the context/operation, or empty list if none was set for this context+specific combination.
- isEmpty
  
  public boolean isEmpty()
  
  Specified by:
  
  isEmpty in interface Authenticator
  
  Returns:
  
  true if this Authenticator doesn't have any credentials set.
- username
  
  public String username()
- password
  
  public String password()