org.apache.pulsar.client.api

Interface AuthenticationDataProvider

All Superinterfaces:

Serializable

public interface AuthenticationDataProvider
extends Serializable

Interface for accessing data which are used in variety of authentication schemes on client side.

Method Summary

Modifier and Type	Method and Description
default AuthData	authenticate(AuthData data) For mutual authentication, This method use passed in `data` to evaluate and challenge, then returns null if authentication has completed; returns authenticated data back to server side, if authentication has not completed.
default String	getCommandData()
default String	getHttpAuthType()
default Set<Map.Entry<String,String>>	getHttpHeaders()
default Certificate[]	getTlsCertificates()
default PrivateKey	getTlsPrivateKey()
default boolean	hasDataForHttp() Check if data for HTTP are available.
default boolean	hasDataForTls() Check if data for TLS are available.
default boolean	hasDataFromCommand() Check if data from Pulsar protocol are available.

Method Detail

hasDataForTls

default boolean hasDataForTls()

Check if data for TLS are available.

Returns:

true if this authentication data contain data for TLS

getTlsCertificates

default Certificate[] getTlsCertificates()

Returns:

a client certificate chain, or null if the data are not available

getTlsPrivateKey

default PrivateKey getTlsPrivateKey()

Returns:

a private key for the client certificate, or null if the data are not available

hasDataForHttp

default boolean hasDataForHttp()

Check if data for HTTP are available.

Returns:

true if this authentication data contain data for HTTP

getHttpAuthType

default String getHttpAuthType()

Returns:

a authentication scheme, or null if the request will not be authenticated.

getHttpHeaders

default Set<Map.Entry<String,String>> getHttpHeaders()
                                              throws Exception

Returns:

an enumeration of all the header names

Throws:

Exception

hasDataFromCommand

default boolean hasDataFromCommand()

Check if data from Pulsar protocol are available.

Returns:

true if this authentication data contain data from Pulsar protocol

getCommandData

default String getCommandData()

Returns:

authentication data which will be stored in a command

authenticate

default AuthData authenticate(AuthData data)
                       throws AuthenticationException

For mutual authentication, This method use passed in `data` to evaluate and challenge, then returns null if authentication has completed; returns authenticated data back to server side, if authentication has not completed.

Mainly used for mutual authentication like sasl.

Throws:

AuthenticationException