Class DatabaseClientFactory.SAMLAuthContext

All Implemented Interfaces:

DatabaseClientFactory.SecurityContext

Enclosing class:

DatabaseClientFactory

• Nested Class Summary

  Nested Classes
  Modifier and Type

  Class

  Description

  static interface 

  DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback

  A callback for getting a SAML assertions token from the IDP (Identity Provider).

  static interface 

  DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth

  ExpiringSAMLAuth is used by SAMLAuthContext when renewing a SAML assertions token.

  static interface 

  DatabaseClientFactory.SAMLAuthContext.RenewerCallback

  A callback for renewing the SAML assertions token with the IDP (Identity Provider) by extending the expiration time.

• Constructor Summary

  Constructors
  Constructor

  Description

  SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback authorizer)

  Constructs a context for authorization using an authorizer callback.

  SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth authorization, DatabaseClientFactory.SAMLAuthContext.RenewerCallback renewer)

  Constructs a context for authorization using a SAML assertions token and a renewer callback.

  SAMLAuthContext(String authorizationToken)

  Constructs a context for authorization using a SAML assertions token.

• Method Summary

  All MethodsStatic MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth

  getAuthorization()

  Gets the object with the SAML assertions token and expiration when specified during construction of the SAMLAuthContext or renewed by the renewer callback.

  DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback

  getAuthorizer()

  Gets the authorizer callback when specified during construction of the SAMLAuthContext.

  DatabaseClientFactory.SAMLAuthContext.RenewerCallback

  getRenewer()

  Gets the renewer callback when specified during construction of the SAMLAuthContext.

  SSLContext

  getSSLContext()

  Gets the SSL context when using SSL.

  DatabaseClientFactory.SSLHostnameVerifier

  getSSLHostnameVerifier()

  Gets the hostname verifier when using SSL.

  String

  getToken()

  Gets the SAML authentication token

  X509TrustManager

  getTrustManager()

  Gets the trust manager when using SSL.

  static DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth

  newExpiringSAMLAuth(String authorizationToken, Instant expiry)

  Constructs an ExpiringSAMLAuth with a SAML assertions token and the expiration time stamp for the token.

  void

  setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

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

  DatabaseClientFactory.SAMLAuthContext

  withSSLContext(SSLContext context, X509TrustManager trustManager)

  Configures the SSL context and trust manager for a SAML authorization context

  DatabaseClientFactory.SAMLAuthContext

  withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)

  Configures the SSL hostname verifier for a SAML authorization context

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • SAMLAuthContext

    public SAMLAuthContext(String authorizationToken)
    Constructs a context for authorization using a SAML assertions token.

    Parameters:

    authorizationToken - the token with the SAML assertions

  • SAMLAuthContext

    public SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback authorizer)
    Constructs a context for authorization using an authorizer callback. The authorizer must get a SAML assertions token from the IDP (Identity Provider) for the first request and when the current SAML assertions token is expiring.

    Parameters:

    authorizer - the callback returning the assertions token

  • SAMLAuthContext

    public SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth authorization, DatabaseClientFactory.SAMLAuthContext.RenewerCallback renewer)
    Constructs a context for authorization using a SAML assertions token and a renewer callback. The renewer callback must renew the SAML assertions token with the IDP (Identity Provider) when the SAML assertions token is expiring.

    Parameters:

    authorization - the expiring object with the SAML assertions token and expiry

    renewer - the renewer callback

• Method Details

  • getToken

    public String getToken()
    Gets the SAML authentication token

    Returns:

    the SAML authentication token.

  • getAuthorizer

    public DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback getAuthorizer()
    Gets the authorizer callback when specified during construction of the SAMLAuthContext.

    Returns:

    the callback

  • getRenewer

    public DatabaseClientFactory.SAMLAuthContext.RenewerCallback getRenewer()
    Gets the renewer callback when specified during construction of the SAMLAuthContext.

    Returns:

    the callback

  • getAuthorization

    public DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth getAuthorization()
    Gets the object with the SAML assertions token and expiration when specified during construction of the SAMLAuthContext or renewed by the renewer callback.

    Returns:

    the object with the assertions token and expiration

  • newExpiringSAMLAuth

    public static DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth newExpiringSAMLAuth(String authorizationToken, Instant expiry)
    Constructs an ExpiringSAMLAuth with a SAML assertions token and the expiration time stamp for the token.

    Parameters:

    authorizationToken - refers to the new SAML token.

    expiry - refers to the expiration time stamp of authorizationToken.

    Returns:

    an ExpiringSAMLAuth instance.

  • withSSLContext

    public DatabaseClientFactory.SAMLAuthContext withSSLContext(SSLContext context, X509TrustManager trustManager)
    Configures the SSL context and trust manager for a SAML authorization context

    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:

    this SAML authorization context for chained configuration

  • withSSLHostnameVerifier

    public DatabaseClientFactory.SAMLAuthContext withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier verifier)
    Configures the SSL hostname verifier for a SAML authorization context

    Specified by:

    withSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

    Parameters:

    verifier - the host verifier

    Returns:

    this SAML authorization context for chained configuration

  • getTrustManager

    public X509TrustManager getTrustManager()
    Gets the trust manager when using SSL.

    Specified by:

    getTrustManager in interface DatabaseClientFactory.SecurityContext

    Returns:

    the X509TrustManager used for authentication

  • getSSLContext

    public SSLContext getSSLContext()
    Gets the SSL context when using SSL.

    Specified by:

    getSSLContext in interface DatabaseClientFactory.SecurityContext

    Returns:

    the SSLContext used for authentication

  • getSSLHostnameVerifier

    public DatabaseClientFactory.SSLHostnameVerifier getSSLHostnameVerifier()
    Gets the hostname verifier when using SSL.

    Specified by:

    getSSLHostnameVerifier in interface DatabaseClientFactory.SecurityContext

    Returns:

    the hostname verifier used for authentication

  • 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

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