Package com.couchbase.lite

Class ClientCertificateAuthenticator

java.lang.Object

com.couchbase.lite.internal.BaseAuthenticator

com.couchbase.lite.ClientCertificateAuthenticator

All Implemented Interfaces:

Authenticator

public final class ClientCertificateAuthenticator
extends com.couchbase.lite.internal.BaseAuthenticator

ENTERPRISE EDITION API

An authenticator for client certificate authentication which happens during the TLS handshake when connecting to a server.

The client certificate authenticator is currently used only for authenticating to a URLEndpointListener. The URLEndpointListener must have TLS enabled and must be configured with a ListenerCertificateAuthenticator to verify client certificates.

Constructor Summary

Constructors

Constructor	Description
ClientCertificateAuthenticator(TLSIdentity identity)	Creates a ClientCertificateAuthenticator object with the given client identity.

Method Summary

Modifier and Type	Method	Description
protected void	authenticate(Map<String,Object> options)
TLSIdentity	getIdentity()	Get the client identity.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientCertificateAuthenticator

public ClientCertificateAuthenticator(@NonNull
 TLSIdentity identity)

Creates a ClientCertificateAuthenticator object with the given client identity.

Parameters:

identity - client identity

Method Details

getIdentity

@NonNull
public TLSIdentity getIdentity()

Get the client identity.

Returns:

client identity

authenticate

protected void authenticate(@NonNull
 Map<String,Object> options)

Specified by:

authenticate in class com.couchbase.lite.internal.BaseAuthenticator