com.couchbase.client.java.error

Class AuthenticatorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.couchbase.client.core.CouchbaseException

com.couchbase.client.java.error.AuthenticatorException

All Implemented Interfaces:

Serializable

public class AuthenticatorException
extends CouchbaseException

This exception is commonly raised when an attempt to retrieve a credential in an Authenticator is made, but cannot be fulfilled. The exception allows to retrieve the CredentialContext and specific for which the request was made.

Since:

2.3

Author:

Simon Baslé

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticatorException(String message, CredentialContext context, String specific, int found)

Method Summary

Modifier and Type	Method and Description
CredentialContext	context()
int	foundCredentials()
String	specific()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticatorException

public AuthenticatorException(String message,
                              CredentialContext context,
                              String specific,
                              int found)

Method Detail

context

public CredentialContext context()

Returns:

the context enum in which the credential was requested.

specific

public String specific()

Returns:

the specific sub-context for which the credential was request (can be null).

foundCredentials

public int foundCredentials()

Returns:

the number of credentials found for the failing request.