com.marklogic.client

Class DatabaseClientFactory.CertificateAuthContext

java.lang.Object

com.marklogic.client.DatabaseClientFactory.CertificateAuthContext

All Implemented Interfaces:

DatabaseClientFactory.SecurityContext

Enclosing class:

DatabaseClientFactory

public static class DatabaseClientFactory.CertificateAuthContext
extends Object

Constructor Summary

Constructors

Constructor and Description
CertificateAuthContext(SSLContext context) Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed.
CertificateAuthContext(SSLContext context, DatabaseClientFactory.SSLHostnameVerifier verifier) Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed and assigns the SSLHostnameVerifier passed to be used for checking host names.
CertificateAuthContext(String certFile) Creates a CertificateAuthContext with a PKCS12 file.
CertificateAuthContext(String certFile, String certPassword) Creates a CertificateAuthContext with a PKCS12 file.

Method Summary

Modifier and Type	Method and Description
String	getCertificate()
String	getCertificatePassword()
DatabaseClientFactory.CertificateAuthContext	withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

CertificateAuthContext

public CertificateAuthContext(SSLContext context)

Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed. The KeyManager of the SSLContext should be initialized with the appropriate client certificate and client’s private key

Parameters:

context - the SSLContext with which we initialize the CertificateAuthContext

CertificateAuthContext

public CertificateAuthContext(SSLContext context,
                              DatabaseClientFactory.SSLHostnameVerifier verifier)

Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed and assigns the SSLHostnameVerifier passed to be used for checking host names. The KeyManager of the SSLContext should be initialized with the appropriate client certificate and client’s private key

Parameters:

context - the SSLContext with which we initialize the CertificateAuthContext

verifier - a callback for checking host names

CertificateAuthContext

public CertificateAuthContext(String certFile)
                       throws CertificateException,
                              IOException,
                              UnrecoverableKeyException,
                              KeyManagementException

Creates a CertificateAuthContext with a PKCS12 file. The SSLContext is created from the information in the PKCS12 file. This constructor should be called when the export password of the PKCS12 file is empty.

Parameters:

certFile - the p12 file which contains the client’s private key and the client’s certificate chain

Throws:

CertificateException - if any of the certificates in the certFile cannot be loaded

UnrecoverableKeyException - if the certFile has an export password

KeyManagementException - if initializing the SSLContext with the KeyManager fails

IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect or if the certFile path is invalid or if the file is not found If the error is due to a wrong password, the cause of the IOException should be an UnrecoverableKeyException.

CertificateAuthContext

public CertificateAuthContext(String certFile,
                              String certPassword)
                       throws CertificateException,
                              IOException,
                              UnrecoverableKeyException,
                              KeyManagementException

Creates a CertificateAuthContext with a PKCS12 file. The SSLContext is created from the information in the PKCS12 file. This constructor should be called when the export password of the PKCS12 file is non-empty.

Parameters:

certFile - the p12 file which contains the client’s private key and the client’s certificate chain

certPassword - the export password of the p12 file

Throws:

CertificateException - if any of the certificates in the certFile cannot be loaded

UnrecoverableKeyException - if the certFile has an export password

KeyManagementException - if initializing the SSLContext with the KeyManager fails

IOException - if there is an I/O or format problem with the keystore data, if a password is required but not given, or if the given password was incorrect or if the certFile path is invalid or if the file is not found If the error is due to a wrong password, the cause of the IOException should be an UnrecoverableKeyException.

Method Detail

withSSLHostnameVerifier

public DatabaseClientFactory.CertificateAuthContext withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

Specified by:

withSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

getCertificate

public String getCertificate()

getCertificatePassword

public String getCertificatePassword()