Package org.apache.pulsar.functions.runtime

Interface RuntimeFactory

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

KubernetesRuntimeFactory, ProcessRuntimeFactory, ThreadRuntimeFactory

public interface RuntimeFactory
extends java.lang.AutoCloseable

A factory to create Runtimes to invoke functions.

Method Summary

Modifier and Type	Method	Description
void	close()
Runtime	createContainer(org.apache.pulsar.functions.instance.InstanceConfig instanceConfig, java.lang.String codeFile, java.lang.String originalCodeFileName, java.lang.Long expectedHealthCheckInterval)	Create a function container to execute a java instance.
default void	doAdmissionChecks(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails)
default boolean	externallyManaged()
default java.util.Optional<? extends FunctionAuthProvider>	getAuthProvider()
static RuntimeFactory	getFuntionRuntimeFactory(java.lang.String className)
default java.util.Optional<? extends RuntimeCustomizer>	getRuntimeCustomizer()
void	initialize(WorkerConfig workerConfig, org.apache.pulsar.functions.instance.AuthenticationConfig authenticationConfig, org.apache.pulsar.functions.secretsproviderconfigurator.SecretsProviderConfigurator secretsProviderConfigurator, ConnectorsManager connectorsManager, java.util.Optional<FunctionAuthProvider> authProvider, java.util.Optional<RuntimeCustomizer> runtimeCustomizer)

Method Detail

initialize

void initialize(WorkerConfig workerConfig,
                org.apache.pulsar.functions.instance.AuthenticationConfig authenticationConfig,
                org.apache.pulsar.functions.secretsproviderconfigurator.SecretsProviderConfigurator secretsProviderConfigurator,
                ConnectorsManager connectorsManager,
                java.util.Optional<FunctionAuthProvider> authProvider,
                java.util.Optional<RuntimeCustomizer> runtimeCustomizer)
         throws java.lang.Exception

Throws:

java.lang.Exception

createContainer

Runtime createContainer(org.apache.pulsar.functions.instance.InstanceConfig instanceConfig,
                        java.lang.String codeFile,
                        java.lang.String originalCodeFileName,
                        java.lang.Long expectedHealthCheckInterval)
                 throws java.lang.Exception

Create a function container to execute a java instance.

Parameters:

instanceConfig - java instance config

codeFile - code file

expectedHealthCheckInterval - expected health check interval in seconds

Returns:

function container to start/stop instance

Throws:

java.lang.Exception

externallyManaged

default boolean externallyManaged()

doAdmissionChecks

default void doAdmissionChecks(org.apache.pulsar.functions.proto.Function.FunctionDetails functionDetails)

getAuthProvider

default java.util.Optional<? extends FunctionAuthProvider> getAuthProvider()

getRuntimeCustomizer

default java.util.Optional<? extends RuntimeCustomizer> getRuntimeCustomizer()

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

getFuntionRuntimeFactory

static RuntimeFactory getFuntionRuntimeFactory(java.lang.String className)