org.apache.pulsar.client.impl.auth

Class AuthenticationBasic

java.lang.Object

org.apache.pulsar.client.impl.auth.AuthenticationBasic

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Authentication, EncodedAuthenticationParameterSupport

public class AuthenticationBasic
extends Object
implements Authentication, EncodedAuthenticationParameterSupport

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthenticationBasic()

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Map<String,String> authParams) Configure the authentication plugins with the supplied parameters
void	configure(String encodedAuthParamString) Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface.
AuthenticationDataProvider	getAuthData()
String	getAuthMethodName()
void	start() Initialize the authentication provider

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationBasic

public AuthenticationBasic()

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getAuthMethodName

public String getAuthMethodName()

Specified by:

getAuthMethodName in interface Authentication

Returns:

the identifier for this authentication method

getAuthData

public AuthenticationDataProvider getAuthData()
                                       throws PulsarClientException

Specified by:

getAuthData in interface Authentication

Returns:

The authentication data identifying this client that will be sent to the broker

Throws:

PulsarClientException.GettingAuthenticationDataException - if there was error getting the authentication data to use

PulsarClientException - any other error

configure

public void configure(Map<String,String> authParams)

Description copied from interface: Authentication

Configure the authentication plugins with the supplied parameters

Specified by:

configure in interface Authentication

configure

public void configure(String encodedAuthParamString)

Description copied from interface: EncodedAuthenticationParameterSupport

Plugins which use ":" and/or "," in a configuration parameter value need to implement this interface. This interface will be integrated into Authentication interface and be required for all plugins on version 2.0.

Specified by:

configure in interface EncodedAuthenticationParameterSupport

start

public void start()
           throws PulsarClientException

Description copied from interface: Authentication

Initialize the authentication provider

Specified by:

start in interface Authentication

Throws:

PulsarClientException