org.apache.pulsar.client.api

Interface Authentication

All Superinterfaces:

AutoCloseable, Closeable, Serializable

public interface Authentication
extends Closeable, Serializable

Interface of authentication providers.

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,String> authParams) Deprecated. This method will be deleted on version 2.0, instead please use configure(String encodedAuthParamString) which is in EncodedAuthenticationParameterSupport for now and will be integrated into this interface.
AuthenticationDataProvider	getAuthData()
String	getAuthMethodName()
void	start() Initialize the authentication provider

Methods inherited from interface Closeable

close

Method Detail

getAuthMethodName

String getAuthMethodName()

Returns:

the identifier for this authentication method

getAuthData

AuthenticationDataProvider getAuthData()
                                throws PulsarClientException

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

@Deprecated
void configure(Map<String,String> authParams)

Deprecated. This method will be deleted on version 2.0, instead please use configure(String encodedAuthParamString) which is in EncodedAuthenticationParameterSupport for now and will be integrated into this interface.

Configure the authentication plugins with the supplied parameters

Parameters:

authParams -

start

void start()
    throws PulsarClientException

Initialize the authentication provider

Throws:

PulsarClientException