Class DatabaseClientFactory.ProgressDataCloudAuthContext

All Implemented Interfaces:

DatabaseClientFactory.SecurityContext

Enclosing class:

DatabaseClientFactory

Since:

7.2.0 Replaced MarkLogicCloudAuthContext which was removed in 8.0.0

• Constructor Summary

  Constructors
  Constructor

  Description

  ProgressDataCloudAuthContext(String apiKey)

   

  ProgressDataCloudAuthContext(String apiKey, Integer tokenDuration)

   

  ProgressDataCloudAuthContext(String apiKey, String tokenEndpoint, String grantType)

  Only intended to be used in the scenario that the token endpoint of "/token" and the grant type of "apikey" are not the intended values.

  ProgressDataCloudAuthContext(String apiKey, String tokenEndpoint, String grantType, Integer tokenDuration)

  Only intended to be used in the scenario that the token endpoint of "/token" and the grant type of "apikey" are not the intended values.

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  String

  getApiKey()

   

  String

  getGrantType()

   

  SSLContext

  getSSLContext()

  Returns the SSLContext for an SSL client.

  DatabaseClientFactory.SSLHostnameVerifier

  getSSLHostnameVerifier()

   

  Integer

  getTokenDuration()

   

  String

  getTokenEndpoint()

   

  X509TrustManager

  getTrustManager()

   

  void

  setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

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

  DatabaseClientFactory.ProgressDataCloudAuthContext

  withSSLContext(SSLContext context, X509TrustManager trustManager)

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

  DatabaseClientFactory.ProgressDataCloudAuthContext

  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

  • ProgressDataCloudAuthContext

    public ProgressDataCloudAuthContext(String apiKey)

    Parameters:

    apiKey - user's API key for accessing Progress Data Cloud

  • ProgressDataCloudAuthContext

    public ProgressDataCloudAuthContext(String apiKey, Integer tokenDuration)

    Parameters:

    apiKey - user's API key for accessing Progress Data Cloud

    tokenDuration - length in minutes until the generated access token expires

  • ProgressDataCloudAuthContext

    public ProgressDataCloudAuthContext(String apiKey, String tokenEndpoint, String grantType)
    Only intended to be used in the scenario that the token endpoint of "/token" and the grant type of "apikey" are not the intended values.

    Parameters:

    apiKey - user's API key for accessing Progress Data Cloud

    tokenEndpoint - for overriding the default token endpoint if necessary

    grantType - for overriding the default grant type if necessary

  • ProgressDataCloudAuthContext

    public ProgressDataCloudAuthContext(String apiKey, String tokenEndpoint, String grantType, Integer tokenDuration)
    Only intended to be used in the scenario that the token endpoint of "/token" and the grant type of "apikey" are not the intended values.

    Parameters:

    apiKey - user's API key for accessing Progress Data Cloud

    tokenEndpoint - for overriding the default token endpoint if necessary

    grantType - for overriding the default grant type if necessary

    tokenDuration - length in minutes until the generated access token expires

• Method Details

  • getTokenEndpoint

    public String getTokenEndpoint()

  • getGrantType

    public String getGrantType()

  • getApiKey

    public String getApiKey()

  • getTokenDuration

    public Integer getTokenDuration()

  • withSSLContext

    public DatabaseClientFactory.ProgressDataCloudAuthContext 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

  • withSSLHostnameVerifier

    public DatabaseClientFactory.ProgressDataCloudAuthContext 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

  • 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

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