org.apache.pulsar.functions.auth

Interface FunctionAuthProvider

All Known Subinterfaces:

KubernetesFunctionAuthProvider

All Known Implementing Classes:

ClearTextFunctionTokenAuthProvider, KubernetesSecretsTokenAuthProvider

public interface FunctionAuthProvider

This is a generic interface that functions can use to cache and distribute appropriate authentication data that is needed to configure the runtime of functions to support appropriate authentication of function instances

Method Summary

Modifier and Type	Method and 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(org.apache.pulsar.common.functions.AuthenticationConfig authConfig, Optional<FunctionAuthData> functionAuthData) Set authentication configs for function instance based on the data in FunctionAuthenticationSpec
static FunctionAuthProvider	getAuthProvider(String className)
Optional<FunctionAuthData>	updateAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, Optional<FunctionAuthData> existingFunctionAuthData, AuthenticationDataSource authenticationDataSource)

Method Detail

configureAuthenticationConfig

void configureAuthenticationConfig(org.apache.pulsar.common.functions.AuthenticationConfig authConfig,
                                   Optional<FunctionAuthData> functionAuthData)

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

Parameters:

authConfig - authentication configs passed to the function instance

functionAuthData - function authentication data that is provider specific

cacheAuthData

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

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

Parameters:

funcDetails - the function details

authenticationDataSource - auth data

Returns:

Throws:

Exception

updateAuthData

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

Throws:

Exception

cleanUpAuthData

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

Clean up operation for auth when function is terminated

Parameters:

funcDetails - the function details

functionAuthData - function auth data

Throws:

Exception

getAuthProvider

static FunctionAuthProvider getAuthProvider(String className)