com.couchbase.client.java.auth

Class ClassicAuthenticator

java.lang.Object

com.couchbase.client.java.auth.ClassicAuthenticator

All Implemented Interfaces:

Authenticator

@InterfaceStability.Committed
 @InterfaceAudience.Public
public class ClassicAuthenticator
extends Object
implements Authenticator

An Authenticator based on login/password credentials.

Since:

2.3

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
ClassicAuthenticator()

Method Summary

Modifier and Type	Method and Description
ClassicAuthenticator	bucket(String bucketName, String password) Sets the CredentialContext.BUCKET_KV / CredentialContext.BUCKET_N1QL credential for the the bucketName specific.
ClassicAuthenticator	cluster(String adminName, String adminPassword) Sets the CredentialContext.CLUSTER_MANAGEMENT credential.
List<Credential>	getCredentials(CredentialContext context, String specific) Retrieve the credentials store by this Authenticator for the given CredentialContext and optional specific.
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassicAuthenticator

public ClassicAuthenticator()

Method Detail

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.

bucket

public ClassicAuthenticator bucket(String bucketName,
                                   String password)

Sets the CredentialContext.BUCKET_KV / CredentialContext.BUCKET_N1QL credential for the the bucketName specific.

Parameters:

bucketName - the name of the bucket for which to set a password.

password - the password for the bucket.

Returns:

this ClassicAuthenticator for chaining.

cluster

public ClassicAuthenticator cluster(String adminName,
                                    String adminPassword)

Sets the CredentialContext.CLUSTER_MANAGEMENT credential. Specific is ignored in this context.

Parameters:

adminName - the administrative login to use.

adminPassword - the administrative password to use.

Returns:

this ClassicAuthenticator for chaining.