Class AuthenticationFactory

java.lang.Object
org.apache.pulsar.client.api.AuthenticationFactory

@LimitedPrivate @Stable public final class AuthenticationFactory extends Object
Factory class that allows to create Authentication instances for all the supported authentication methods.
  • Constructor Details

    • AuthenticationFactory

      public AuthenticationFactory()
  • Method Details

    • token

      public static Authentication token(String token)
      Create an authentication provider for token based authentication.
      Parameters:
      token - the client auth token
      Returns:
      the Authentication object initialized with the token credentials
    • token

      public static Authentication token(Supplier<String> tokenSupplier)
      Create an authentication provider for token based authentication.
      Parameters:
      tokenSupplier - a supplier of the client auth token
      Returns:
      the Authentication object initialized with the token credentials
    • TLS

      public static Authentication TLS(String certFilePath, String keyFilePath)
      Create an authentication provider for TLS based authentication.
      Parameters:
      certFilePath - the path to the TLS client public key
      keyFilePath - the path to the TLS client private key
      Returns:
      the Authentication object initialized with the TLS credentials
    • create

      public static Authentication create(String authPluginClassName, String authParamsString) throws PulsarClientException.UnsupportedAuthenticationException
      Create an instance of the Authentication object by using the plugin class name.
      Parameters:
      authPluginClassName - name of the Authentication-Plugin you want to use
      authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
      Returns:
      instance of the Authentication object
      Throws:
      PulsarClientException.UnsupportedAuthenticationException
    • create

      public static Authentication create(String authPluginClassName, Map<String,String> authParams) throws PulsarClientException.UnsupportedAuthenticationException
      Create an instance of the Authentication-Plugin.
      Parameters:
      authPluginClassName - name of the Authentication-Plugin you want to use
      authParams - map which represents parameters for the Authentication-Plugin
      Returns:
      instance of the Authentication-Plugin
      Throws:
      PulsarClientException.UnsupportedAuthenticationException