程序包 org.apache.pulsar.functions.auth

接口 FunctionAuthProvider

所有已知子接口:

KubernetesFunctionAuthProvider

所有已知实现类:

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

方法概要

修饰符和类型	方法	说明
java.util.Optional<FunctionAuthData>	cacheAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, org.apache.pulsar.broker.authentication.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, java.util.Optional<FunctionAuthData> functionAuthData)	Clean up operation for auth when function is terminated
void	configureAuthenticationConfig(org.apache.pulsar.functions.instance.AuthenticationConfig authConfig, java.util.Optional<FunctionAuthData> functionAuthData)	Set authentication configs for function instance based on the data in FunctionAuthenticationSpec
static FunctionAuthProvider	getAuthProvider(java.lang.String className)
java.util.Optional<FunctionAuthData>	updateAuthData(org.apache.pulsar.functions.proto.Function.FunctionDetails funcDetails, java.util.Optional<FunctionAuthData> existingFunctionAuthData, org.apache.pulsar.broker.authentication.AuthenticationDataSource authenticationDataSource)

方法详细资料

configureAuthenticationConfig

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

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

参数:

authConfig - authentication configs passed to the function instance

functionAuthData - function authentication data that is provider specific

cacheAuthData

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

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

参数:

funcDetails - the function details

authenticationDataSource - auth data

返回:

抛出:

java.lang.Exception

updateAuthData

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

抛出:

java.lang.Exception

cleanUpAuthData

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

Clean up operation for auth when function is terminated

参数:

funcDetails - the function details

functionAuthData - function auth data

抛出:

java.lang.Exception

getAuthProvider

static FunctionAuthProvider getAuthProvider(java.lang.String className)