Package org.apache.pulsar.functions.auth

Class ClearTextFunctionTokenAuthProvider

java.lang.Object

org.apache.pulsar.functions.auth.ClearTextFunctionTokenAuthProvider

All Implemented Interfaces:

FunctionAuthProvider

public class ClearTextFunctionTokenAuthProvider
extends Object
implements FunctionAuthProvider

Constructor Summary

Constructors

Constructor	Description
ClearTextFunctionTokenAuthProvider()

Method Summary

Modifier and Type	Method	Description
Optional<FunctionAuthData>	cacheAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, AuthenticationDataSource authenticationDataSource)	Cache auth data in as part of function metadata for function that runtime may need to configure authentication.
void	cleanUpAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, Optional<FunctionAuthData> functionAuthData)	Clean up operation for auth when function is terminated.
void	configureAuthenticationConfig(AuthenticationConfig authConfig, Optional<FunctionAuthData> functionAuthData)	Set authentication configs for function instance based on the data in FunctionAuthenticationSpec.
Optional<FunctionAuthData>	updateAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, Optional<FunctionAuthData> existingFunctionAuthData, AuthenticationDataSource authenticationDataSource)

Methods inherited from class java.lang.Object

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

Constructor Details

ClearTextFunctionTokenAuthProvider

public ClearTextFunctionTokenAuthProvider()

Method Details

configureAuthenticationConfig

public void configureAuthenticationConfig(AuthenticationConfig authConfig,
 Optional<FunctionAuthData> functionAuthData)

Description copied from interface: FunctionAuthProvider

Set authentication configs for function instance based on the data in FunctionAuthenticationSpec.

Specified by:

configureAuthenticationConfig in interface FunctionAuthProvider

Parameters:

authConfig - authentication configs passed to the function instance

functionAuthData - function authentication data that is provider specific

cacheAuthData

public Optional<FunctionAuthData> cacheAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails,
 AuthenticationDataSource authenticationDataSource)
                                         throws Exception

Description copied from interface: FunctionAuthProvider

Cache auth data in as part of function metadata for function that runtime may need to configure authentication.

Specified by:

cacheAuthData in interface FunctionAuthProvider

Parameters:

funcDetails - the function details

authenticationDataSource - auth data

Returns:

Throws:

Exception

updateAuthData

public Optional<FunctionAuthData> updateAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails,
 Optional<FunctionAuthData> existingFunctionAuthData,
 AuthenticationDataSource authenticationDataSource)
                                          throws Exception

Specified by:

updateAuthData in interface FunctionAuthProvider

Throws:

Exception

cleanUpAuthData

public void cleanUpAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails,
 Optional<FunctionAuthData> functionAuthData)
                     throws Exception

Description copied from interface: FunctionAuthProvider

Clean up operation for auth when function is terminated.

Specified by:

cleanUpAuthData in interface FunctionAuthProvider

Parameters:

funcDetails - the function details

functionAuthData - function auth data

Throws:

Exception