org.apache.pulsar.broker.authentication

Class AuthenticationProviderBasic

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationProviderBasic

All Implemented Interfaces:

Closeable, AutoCloseable, AuthenticationProvider

public class AuthenticationProviderBasic
extends Object
implements AuthenticationProvider

Constructor Summary

Constructors

Constructor and Description
AuthenticationProviderBasic()

Method Summary

Modifier and Type	Method and Description
String	authenticate(AuthenticationDataSource authData) Validate the authentication for the given credentials with the specified authentication data.
void	close()
String	getAuthMethodName()
void	initialize(ServiceConfiguration config) Perform initialization for the authentication provider.

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

authenticateAsync, authenticateHttpRequest, authenticateHttpRequestAsync, newAuthState, newHttpAuthState

Constructor Detail

AuthenticationProviderBasic

public AuthenticationProviderBasic()

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

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

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