Package org.apache.qpid.protonj2.engine.sasl.client

Interface SaslCredentialsProvider

public interface SaslCredentialsProvider
Interface for a supplier of login credentials used by the SASL Authenticator to select and configure the client SASL mechanism.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isSecure()
    Returns true if the transport IO layer is operating over a secure means such as TLS which provides encryption in flight.
    Principal
    localPrincipal()
    Returns the local principal for use in SASL authentication which is generally provided by the IO layer (TLS).
    default Map<String,Object>
    options()
     
    String
    password()
     
    String
    username()
     
    String
    vhost()
     

  • Method Details

    • vhost

      String vhost()
      Returns:
      the virtual host value to use when performing SASL authentication.

    • username

      String username()
      Returns:
      the user name value to use when performing SASL authentication.

    • password

      String password()
      Returns:
      the password value to use when performing SASL authentication.

    • isSecure

      default boolean isSecure()
      Returns true if the transport IO layer is operating over a secure means such as TLS which provides encryption in flight.
      Returns:
      true if the IO layer is secured (encrypted).

    • localPrincipal

      Principal localPrincipal()
      Returns the local principal for use in SASL authentication which is generally provided by the IO layer (TLS). This method can return null if there is no local Principal in use.
      Returns:
      the local principal value to use when performing SASL authentication.

    • options

      default Map<String,Object> options()
      Returns:
      a Map of optional values to use when performing SASL authentication.