Package org.apache.pulsar.client.api
Class AuthenticationFactory
java.lang.Object
org.apache.pulsar.client.api.AuthenticationFactory
Factory class that allows to create
Authentication
instances
for all the supported authentication methods.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Authentication
Create an instance of theAuthentication
object by using the plugin class name.static Authentication
Create an instance of the Authentication-Plugin.static Authentication
Create an authentication provider for TLS based authentication.static Authentication
Create an authentication provider for token based authentication.static Authentication
Create an authentication provider for token based authentication.
-
Constructor Details
-
AuthenticationFactory
public AuthenticationFactory()
-
-
Method Details
-
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
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
Create an authentication provider for TLS based authentication.- Parameters:
certFilePath
- the path to the TLS client public keykeyFilePath
- 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 theAuthentication
object by using the plugin class name.- Parameters:
authPluginClassName
- name of the Authentication-Plugin you want to useauthParamsString
- 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.UnsupportedAuthenticationExceptionCreate an instance of the Authentication-Plugin.- Parameters:
authPluginClassName
- name of the Authentication-Plugin you want to useauthParams
- map which represents parameters for the Authentication-Plugin- Returns:
- instance of the Authentication-Plugin
- Throws:
PulsarClientException.UnsupportedAuthenticationException
-