Package org.apache.pulsar.broker.authentication

Class AuthenticationProviderList

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationProviderList

All Implemented Interfaces:

Closeable, AutoCloseable, AuthenticationProvider

public class AuthenticationProviderList
extends Object
implements AuthenticationProvider

An authentication provider wraps a list of auth providers.

Constructor Summary

Constructors

Constructor	Description
AuthenticationProviderList(List<AuthenticationProvider> providers)

Method Summary

Modifier and Type	Method	Description
String	authenticate(AuthenticationDataSource authData)	Validate the authentication for the given credentials with the specified authentication data.
CompletableFuture<String>	authenticateAsync(AuthenticationDataSource authData)	Validate the authentication for the given credentials with the specified authentication data.
boolean	authenticateHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Set response, according to passed in request.
void	close()
String	getAuthMethodName()
List<AuthenticationProvider>	getProviders()
void	initialize(ServiceConfiguration config)	Perform initialization for the authentication provider.
AuthenticationState	newAuthState(org.apache.pulsar.common.api.AuthData authData, SocketAddress remoteAddress, SSLSession sslSession)	Create an authentication data State use passed in AuthenticationDataSource.
AuthenticationState	newHttpAuthState(javax.servlet.http.HttpServletRequest request)	Create an http authentication data State use passed in AuthenticationDataSource.

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.broker.authentication.AuthenticationProvider

authenticateHttpRequestAsync, incrementFailureMetric

Constructor Details

AuthenticationProviderList

public AuthenticationProviderList(List<AuthenticationProvider> providers)

Method Details

getProviders

public List<AuthenticationProvider> getProviders()

initialize

public void initialize(ServiceConfiguration config)
                throws IOException

Description copied from interface: AuthenticationProvider

Perform initialization for the authentication provider.

Specified by:

initialize in interface AuthenticationProvider

Parameters:

config - broker config object

Throws:

IOException - if the initialization fails

getAuthMethodName

public String getAuthMethodName()

Specified by:

getAuthMethodName in interface AuthenticationProvider

Returns:

the authentication method name supported by this provider

authenticateAsync

public CompletableFuture<String> authenticateAsync(AuthenticationDataSource authData)

Description copied from interface: AuthenticationProvider

Validate the authentication for the given credentials with the specified authentication data. This method is useful in one stage authentication, if you're not doing one stage or if you're providing your own state implementation for one stage authentication, it should return a failed future.

Warning: the calling thread is an IO thread. Any implementation that relies on blocking behavior must ensure that the execution is completed using a separate thread pool to ensure IO threads are never blocked.

Specified by:

authenticateAsync in interface AuthenticationProvider

Parameters:

authData - authentication data generated while initiating a connection. There are several types, including, but not strictly limited to, AuthenticationDataHttp, AuthenticationDataHttps, and AuthenticationDataCommand.

Returns:

A completed future with the "role" string for the authenticated connection, if authentication is successful, or a failed future if the authData is not valid.

authenticate

public String authenticate(AuthenticationDataSource authData)
                    throws AuthenticationException

Description copied from interface: AuthenticationProvider

Validate the authentication for the given credentials with the specified authentication data. This method is useful in one stage authn, if you're not doing one stage or if you're providing your own state implementation for one stage authn, it should throw an exception.

Specified by:

authenticate in interface AuthenticationProvider

Parameters:

authData - provider specific authentication data

Returns:

the "role" string for the authenticated connection, if the authentication was successful

Throws:

AuthenticationException - if the credentials are not valid

newAuthState

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

Description copied from interface: AuthenticationProvider

Create an authentication data State use passed in AuthenticationDataSource.

Specified by:

newAuthState in interface AuthenticationProvider

Throws:

AuthenticationException

newHttpAuthState

public AuthenticationState newHttpAuthState(javax.servlet.http.HttpServletRequest request)
                                     throws AuthenticationException

Description copied from interface: AuthenticationProvider

Create an http authentication data State use passed in AuthenticationDataSource.

Specified by:

newHttpAuthState in interface AuthenticationProvider

Throws:

AuthenticationException

authenticateHttpRequest

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

Description copied from interface: AuthenticationProvider

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

Implementations of this method MUST modify the request by adding the AuthenticatedRoleAttributeName and the AuthenticatedDataAttributeName attributes.

Specified by:

authenticateHttpRequest in interface AuthenticationProvider

Returns:

Set response, according to passed in request, and return whether we should do following chain.doFilter.

Throws:

Exception - when authentication failed

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException