Package org.apache.pulsar.client.api

Class AuthenticationFactory

java.lang.Object

org.apache.pulsar.client.api.AuthenticationFactory

@LimitedPrivate
@Stable
public final class AuthenticationFactory
extends java.lang.Object

Factory class that allows to create Authentication instances for all the supported authentication methods.

Constructor Summary

Constructors

Constructor	Description
AuthenticationFactory()

Method Summary

Modifier and Type	Method	Description
static Authentication	create(java.lang.String authPluginClassName, java.lang.String authParamsString)	Create an instance of the Authentication object by using the plugin class name.
static Authentication	create(java.lang.String authPluginClassName, java.util.Map<java.lang.String,java.lang.String> authParams)	Create an instance of the Authentication-Plugin.
static Authentication	TLS(java.lang.String certFilePath, java.lang.String keyFilePath)	Create an authentication provider for TLS based authentication.
static Authentication	token(java.lang.String token)	Create an authentication provider for token based authentication.
static Authentication	token(java.util.function.Supplier<java.lang.String> tokenSupplier)	Create an authentication provider for token based authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationFactory

public AuthenticationFactory()

Method Detail

token

public static Authentication token(java.lang.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(java.util.function.Supplier<java.lang.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(java.lang.String certFilePath,
                                 java.lang.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(java.lang.String authPluginClassName,
                                    java.lang.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(java.lang.String authPluginClassName,
                                    java.util.Map<java.lang.String,java.lang.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