Package org.apache.pulsar.broker.authentication

Class AuthenticationProviderToken

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationProviderToken

All Implemented Interfaces:

Closeable, AutoCloseable, AuthenticationProvider

public class AuthenticationProviderToken
extends Object
implements AuthenticationProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AuthenticationProviderToken.ErrorCode

Constructor Summary

Constructors

Constructor	Description
AuthenticationProviderToken()

Method Summary

Modifier and Type	Method	Description
String	authenticate(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()
static String	getToken(AuthenticationDataSource authData)
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.
static void	resetMetrics()

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, authenticateHttpRequestAsync, incrementFailureMetric

Constructor Details

AuthenticationProviderToken

public AuthenticationProviderToken()

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

resetMetrics

public static void resetMetrics()

initialize

public void initialize(ServiceConfiguration config)
                throws IOException,
IllegalArgumentException

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

IllegalArgumentException

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

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

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

getToken

public static String getToken(AuthenticationDataSource authData)
                       throws AuthenticationException

Throws:

AuthenticationException