Package org.apache.pulsar.client.impl.auth

Class AuthenticationSasl

java.lang.Object

org.apache.pulsar.client.impl.auth.AuthenticationSasl

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, org.apache.pulsar.client.api.Authentication, org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

public class AuthenticationSasl
extends java.lang.Object
implements org.apache.pulsar.client.api.Authentication, org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

Authentication provider for SASL based authentication. SASL need config files through JVM parameter: a jaas.conf, which is set by `-Djava.security.auth.login.config=/dir/jaas.conf` for Kerberos a krb5.conf, which is set by `-Djava.security.krb5.conf=/dir/krb5.conf`

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationSasl()

Method Summary

Modifier and Type	Method	Description
void	authenticationStage(java.lang.String requestUrl, org.apache.pulsar.client.api.AuthenticationDataProvider authData, java.util.Map<java.lang.String,java.lang.String> previousResHeaders, java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> authFuture)
void	close()
void	configure(java.lang.String encodedAuthParamString)
void	configure(java.util.Map<java.lang.String,java.lang.String> authParams)	Deprecated.
org.apache.pulsar.client.api.AuthenticationDataProvider	getAuthData(java.lang.String serverHostname)
java.lang.String	getAuthMethodName()
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	newRequestHeader(java.lang.String hostName, org.apache.pulsar.client.api.AuthenticationDataProvider authData, java.util.Map<java.lang.String,java.lang.String> previousRespHeaders)
void	start()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Authentication

getAuthData

Constructor Detail

AuthenticationSasl

public AuthenticationSasl()

Method Detail

getAuthMethodName

public java.lang.String getAuthMethodName()

Specified by:

getAuthMethodName in interface org.apache.pulsar.client.api.Authentication

getAuthData

public org.apache.pulsar.client.api.AuthenticationDataProvider getAuthData(java.lang.String serverHostname)
                                                                    throws org.apache.pulsar.client.api.PulsarClientException

Specified by:

getAuthData in interface org.apache.pulsar.client.api.Authentication

Throws:

org.apache.pulsar.client.api.PulsarClientException

configure

public void configure(java.lang.String encodedAuthParamString)

Specified by:

configure in interface org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

configure

@Deprecated
public void configure(java.util.Map<java.lang.String,java.lang.String> authParams)

Deprecated.

Specified by:

configure in interface org.apache.pulsar.client.api.Authentication

start

public void start()
           throws org.apache.pulsar.client.api.PulsarClientException

Specified by:

start in interface org.apache.pulsar.client.api.Authentication

Throws:

org.apache.pulsar.client.api.PulsarClientException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

newRequestHeader

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> newRequestHeader(java.lang.String hostName,
                                                                                                    org.apache.pulsar.client.api.AuthenticationDataProvider authData,
                                                                                                    java.util.Map<java.lang.String,java.lang.String> previousRespHeaders)
                                                                                             throws java.lang.Exception

Specified by:

newRequestHeader in interface org.apache.pulsar.client.api.Authentication

Throws:

java.lang.Exception

authenticationStage

public void authenticationStage(java.lang.String requestUrl,
                                org.apache.pulsar.client.api.AuthenticationDataProvider authData,
                                java.util.Map<java.lang.String,java.lang.String> previousResHeaders,
                                java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,java.lang.String>> authFuture)

Specified by:

authenticationStage in interface org.apache.pulsar.client.api.Authentication