org.apache.pulsar.broker.authentication

Class AuthenticationProviderSasl

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationProviderSasl

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.pulsar.broker.authentication.AuthenticationProvider

public class AuthenticationProviderSasl
extends Object
implements org.apache.pulsar.broker.authentication.AuthenticationProvider

Constructor Summary

Constructors

Constructor and Description
AuthenticationProviderSasl()

Method Summary

Modifier and Type	Method and Description
String	authenticate(org.apache.pulsar.broker.authentication.AuthenticationDataSource authData)
boolean	authenticateHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Passed in request, set response, according to request.
String	authRoleFromHttpRequest(javax.servlet.http.HttpServletRequest httpRequest) Returns null if authentication has not completed.
void	close()
String	getAuthMethodName()
void	initialize(ServiceConfiguration config)
org.apache.pulsar.broker.authentication.AuthenticationState	newAuthState(org.apache.pulsar.common.api.AuthData authData, SocketAddress remoteAddress, SSLSession sslSession)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationProviderSasl

public AuthenticationProviderSasl()

Method Detail

initialize

public void initialize(ServiceConfiguration config)
                throws IOException

Specified by:

initialize in interface org.apache.pulsar.broker.authentication.AuthenticationProvider

Throws:

IOException

authenticate

public String authenticate(org.apache.pulsar.broker.authentication.AuthenticationDataSource authData)
                    throws AuthenticationException

Specified by:

authenticate in interface org.apache.pulsar.broker.authentication.AuthenticationProvider

Throws:

AuthenticationException

getAuthMethodName

public String getAuthMethodName()

Specified by:

getAuthMethodName in interface org.apache.pulsar.broker.authentication.AuthenticationProvider

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

newAuthState

public org.apache.pulsar.broker.authentication.AuthenticationState newAuthState(org.apache.pulsar.common.api.AuthData authData,
                                                                                SocketAddress remoteAddress,
                                                                                SSLSession sslSession)
                                                                         throws AuthenticationException

Specified by:

newAuthState in interface org.apache.pulsar.broker.authentication.AuthenticationProvider

Throws:

AuthenticationException

authRoleFromHttpRequest

public String authRoleFromHttpRequest(javax.servlet.http.HttpServletRequest httpRequest)
                               throws AuthenticationException

Returns null if authentication has not completed. Return auth role if authentication has completed, and httpRequest's role token contains the authRole

Throws:

AuthenticationException

authenticateHttpRequest

public boolean authenticateHttpRequest(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
                                throws Exception

Passed in request, set response, according to request. and return whether we should do following chain.doFilter or not.

Specified by:

authenticateHttpRequest in interface org.apache.pulsar.broker.authentication.AuthenticationProvider

Throws:

Exception