Class DatabaseClientFactory.CertificateAuthContext

All Implemented Interfaces:

DatabaseClientFactory.SecurityContext

Enclosing class:

DatabaseClientFactory

• Constructor Summary

  Constructors
  Constructor

  Description

  CertificateAuthContext(String certFile, String certPassword, X509TrustManager trustManager)

  Creates a CertificateAuthContext with a PKCS12 file.

  CertificateAuthContext(String certFile, String certPassword, X509TrustManager trustManager, String sslProtocol)

  Creates a CertificateAuthContext with a PKCS12 file.

  CertificateAuthContext(String certFile, X509TrustManager trustManager)

  Creates a CertificateAuthContext with a PKCS12 file.

  CertificateAuthContext(String certFile, X509TrustManager trustManager, String sslProtocol)

  Creates a CertificateAuthContext with a PKCS12 file.

  CertificateAuthContext(SSLContext context, DatabaseClientFactory.SSLHostnameVerifier verifier, X509TrustManager trustManager)

  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(SSLContext context, X509TrustManager trustManager)

  Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed and using the TrustManger passed.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  String

  getCertificate()

   

  String

  getCertificatePassword()

   

  SSLContext

  getSSLContext()

  Returns the SSLContext for an SSL client.

  DatabaseClientFactory.SSLHostnameVerifier

  getSSLHostnameVerifier()

   

  X509TrustManager

  getTrustManager()

   

  void

  setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

  Specifies the host verifier for a client that verifies hosts for additional security.

  DatabaseClientFactory.SecurityContext

  withSSLContext(SSLContext context, X509TrustManager trustManager)

  The SSLContext should be initialized with KeyManager and TrustManager using a KeyStore.

  DatabaseClientFactory.CertificateAuthContext

  withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

  Specifies the host verifier for a client that verifies hosts for additional security.

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • CertificateAuthContext

    public CertificateAuthContext(SSLContext context, X509TrustManager trustManager)
    Creates a CertificateAuthContext by initializing the SSLContext of the HTTPS channel with the SSLContext object passed and using the TrustManger 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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

  • CertificateAuthContext

    public CertificateAuthContext(SSLContext context, DatabaseClientFactory.SSLHostnameVerifier verifier, X509TrustManager trustManager)
    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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

  • CertificateAuthContext

    public CertificateAuthContext(String certFile, X509TrustManager trustManager) 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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

    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, X509TrustManager trustManager, String sslProtocol) 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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

    sslProtocol - the version of the SSL protocol to use.

    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, X509TrustManager trustManager) 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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

    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.

  • CertificateAuthContext

    public CertificateAuthContext(String certFile, String certPassword, X509TrustManager trustManager, String sslProtocol) 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

    trustManager - the X509TrustManager object which is responsible for deciding if a credential should be trusted or not.

    certPassword - the export password of the p12 file

    sslProtocol - the version of the SSL protocol to use.

    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 Details

  • withSSLHostnameVerifier

    public DatabaseClientFactory.CertificateAuthContext withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)
    Description copied from interface: DatabaseClientFactory.SecurityContext
    Specifies the host verifier for a client that verifies hosts for additional security.

    Specified by:

    withSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

    Parameters:

    verifier - the host verifier

    Returns:

    a context configured with the host verifier

  • getCertificate

    public String getCertificate()

  • getCertificatePassword

    public String getCertificatePassword()

  • getSSLContext

    public SSLContext getSSLContext()
    Description copied from interface: DatabaseClientFactory.SecurityContext
    Returns the SSLContext for an SSL client.

    Specified by:

    getSSLContext in interface DatabaseClientFactory.SecurityContext

    Returns:

    the SSL context

  • getSSLHostnameVerifier

    public DatabaseClientFactory.SSLHostnameVerifier getSSLHostnameVerifier()

    Specified by:

    getSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

  • setSSLHostnameVerifier

    public void setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)
    Description copied from interface: DatabaseClientFactory.SecurityContext
    Specifies the host verifier for a client that verifies hosts for additional security.

    Specified by:

    setSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

    Parameters:

    verifier - the host verifier

  • getTrustManager

    public X509TrustManager getTrustManager()

    Specified by:

    getTrustManager in interface DatabaseClientFactory.SecurityContext

    Returns:

    the trust manager for this connection

  • withSSLContext

    public DatabaseClientFactory.SecurityContext withSSLContext(SSLContext context, X509TrustManager trustManager)
    Description copied from interface: DatabaseClientFactory.SecurityContext
    The SSLContext should be initialized with KeyManager and TrustManager using a KeyStore.
    
    If we init the sslContext with null TrustManager, it would use the <java-home>/lib/security/cacerts file for trusted root certificates, if javax.net.ssl.trustStore system property is not set and <java-home>/lib/security/jssecacerts is not present. See JSSE Reference Guide for more information on SSL and TrustManagers.
    
    If self signed certificates, signed by CAs created internally are used, then the internal CA's root certificate should be added to the keystore. See this link for adding a root certificate in the keystore.

    Specified by:

    withSSLContext in interface DatabaseClientFactory.SecurityContext

    Parameters:

    context - - the SSLContext object required for the SSL connection

    trustManager - - X509TrustManager with which we initialize the SSLContext

    Returns:

    a context containing authentication information

Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.