Package org.apache.pulsar.functions.worker.rest.api

Class ComponentImpl

java.lang.Object

org.apache.pulsar.functions.worker.rest.api.ComponentImpl

All Implemented Interfaces:

Component<PulsarWorkerService>

Direct Known Subclasses:

FunctionsImpl, SinksImpl, SourcesImpl

public abstract class ComponentImpl
extends Object
implements Component<PulsarWorkerService>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ComponentImpl.GetStatus<X,T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType	componentType
protected final Supplier<PulsarWorkerService>	workerServiceSupplier

Constructor Summary

Constructors

Constructor	Description
ComponentImpl(Supplier<PulsarWorkerService> workerServiceSupplier, org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)

Method Summary

Modifier and Type	Method	Description
boolean	allowFunctionOps(org.apache.pulsar.common.naming.NamespaceName namespaceName, String role, AuthenticationDataSource authenticationData)
void	changeFunctionInstanceStatus(String tenant, String namespace, String componentName, String instanceId, boolean start, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	changeFunctionStatusAllInstances(String tenant, String namespace, String componentName, boolean start, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
protected void	componentInstanceStatusRequestValidate(String tenant, String namespace, String componentName, int instanceId, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
protected void	componentStatusRequestValidate(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
static String	createPackagePath(String tenant, String namespace, String functionName, String fileName)
void	deregisterFunction(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
javax.ws.rs.core.StreamingOutput	downloadFunction(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps, boolean transformFunction)
javax.ws.rs.core.StreamingOutput	downloadFunction(String path, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
protected File	downloadPackageFile(String packageName)
protected ClassLoader	getBuiltinFunctionClassLoader(String archive)
protected ClassLoader	getClassLoaderFromPackage(String className, File packageFile, String narExtractionDirectory)
org.apache.pulsar.common.functions.FunctionConfig	getFunctionInfo(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl	getFunctionsInstanceStats(String tenant, String namespace, String componentName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
org.apache.pulsar.common.functions.FunctionState	getFunctionState(String tenant, String namespace, String functionName, String key, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
org.apache.pulsar.common.policies.data.FunctionStatsImpl	getFunctionStats(String tenant, String namespace, String componentName, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getListOfConnectors()
protected File	getPackageFile(String functionPkgUrl)
protected File	getPackageFile(String functionPkgUrl, String existingPackagePath, InputStream uploadedInputStream)
boolean	isAuthorizedRole(String tenant, String namespace, String clientRole, AuthenticationDataSource authenticationData)
boolean	isSuperUser(String clientRole, AuthenticationDataSource authenticationData)
List<String>	listFunctions(String tenant, String namespace, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	putFunctionState(String tenant, String namespace, String functionName, String key, org.apache.pulsar.common.functions.FunctionState state, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	reloadConnectors(String clientRole, AuthenticationDataSource authenticationData)
void	restartFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	restartFunctionInstances(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	startFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	startFunctionInstances(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	stopFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	stopFunctionInstances(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
String	triggerFunction(String tenant, String namespace, String functionName, String input, InputStream uploadedInputStream, String topic, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
void	uploadFunction(InputStream uploadedInputStream, String path, String clientRole, AuthenticationDataSource authenticationData)
protected void	validateGetFunctionInstanceRequestParams(String tenant, String namespace, String componentName, org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType, String instanceId)
protected void	validateGetFunctionRequestParams(String tenant, String namespace, String subject, org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)
PulsarWorkerService	worker()

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.functions.worker.service.api.Component

deregisterFunction, downloadFunction, downloadFunction, downloadFunction

Field Details

workerServiceSupplier

protected final Supplier<PulsarWorkerService> workerServiceSupplier

componentType

protected final org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType

Constructor Details

ComponentImpl

public ComponentImpl(Supplier<PulsarWorkerService> workerServiceSupplier,
 org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)

Method Details

worker

public PulsarWorkerService worker()

Specified by:

worker in interface Component<PulsarWorkerService>

deregisterFunction

public void deregisterFunction(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

deregisterFunction in interface Component<PulsarWorkerService>

getFunctionInfo

public org.apache.pulsar.common.functions.FunctionConfig getFunctionInfo(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

getFunctionInfo in interface Component<PulsarWorkerService>

stopFunctionInstance

public void stopFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

stopFunctionInstance in interface Component<PulsarWorkerService>

startFunctionInstance

public void startFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

startFunctionInstance in interface Component<PulsarWorkerService>

changeFunctionInstanceStatus

public void changeFunctionInstanceStatus(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 boolean start,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

restartFunctionInstance

public void restartFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

restartFunctionInstance in interface Component<PulsarWorkerService>

stopFunctionInstances

public void stopFunctionInstances(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

stopFunctionInstances in interface Component<PulsarWorkerService>

startFunctionInstances

public void startFunctionInstances(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

startFunctionInstances in interface Component<PulsarWorkerService>

changeFunctionStatusAllInstances

public void changeFunctionStatusAllInstances(String tenant,
 String namespace,
 String componentName,
 boolean start,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

restartFunctionInstances

public void restartFunctionInstances(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

restartFunctionInstances in interface Component<PulsarWorkerService>

getFunctionStats

public org.apache.pulsar.common.policies.data.FunctionStatsImpl getFunctionStats(String tenant,
 String namespace,
 String componentName,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

getFunctionStats in interface Component<PulsarWorkerService>

getFunctionsInstanceStats

public org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl getFunctionsInstanceStats(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

getFunctionsInstanceStats in interface Component<PulsarWorkerService>

listFunctions

public List<String> listFunctions(String tenant,
 String namespace,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

listFunctions in interface Component<PulsarWorkerService>

getListOfConnectors

public List<org.apache.pulsar.common.io.ConnectorDefinition> getListOfConnectors()

Specified by:

getListOfConnectors in interface Component<PulsarWorkerService>

reloadConnectors

public void reloadConnectors(String clientRole,
 AuthenticationDataSource authenticationData)

Specified by:

reloadConnectors in interface Component<PulsarWorkerService>

triggerFunction

public String triggerFunction(String tenant,
 String namespace,
 String functionName,
 String input,
 InputStream uploadedInputStream,
 String topic,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

triggerFunction in interface Component<PulsarWorkerService>

getFunctionState

public org.apache.pulsar.common.functions.FunctionState getFunctionState(String tenant,
 String namespace,
 String functionName,
 String key,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

getFunctionState in interface Component<PulsarWorkerService>

putFunctionState

public void putFunctionState(String tenant,
 String namespace,
 String functionName,
 String key,
 org.apache.pulsar.common.functions.FunctionState state,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

putFunctionState in interface Component<PulsarWorkerService>

uploadFunction

public void uploadFunction(InputStream uploadedInputStream,
 String path,
 String clientRole,
 AuthenticationDataSource authenticationData)

Specified by:

uploadFunction in interface Component<PulsarWorkerService>

downloadFunction

public javax.ws.rs.core.StreamingOutput downloadFunction(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps,
 boolean transformFunction)

Specified by:

downloadFunction in interface Component<PulsarWorkerService>

downloadFunction

public javax.ws.rs.core.StreamingOutput downloadFunction(String path,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

Specified by:

downloadFunction in interface Component<PulsarWorkerService>

validateGetFunctionInstanceRequestParams

protected void validateGetFunctionInstanceRequestParams(String tenant,
 String namespace,
 String componentName,
 org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType,
 String instanceId)
                                                 throws IllegalArgumentException

Throws:

IllegalArgumentException

validateGetFunctionRequestParams

protected void validateGetFunctionRequestParams(String tenant,
 String namespace,
 String subject,
 org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType)
                                         throws IllegalArgumentException

Throws:

IllegalArgumentException

createPackagePath

public static String createPackagePath(String tenant,
 String namespace,
 String functionName,
 String fileName)

isAuthorizedRole

public boolean isAuthorizedRole(String tenant,
 String namespace,
 String clientRole,
 AuthenticationDataSource authenticationData)
                         throws PulsarAdminException

Throws:

PulsarAdminException

componentStatusRequestValidate

protected void componentStatusRequestValidate(String tenant,
 String namespace,
 String componentName,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

componentInstanceStatusRequestValidate

protected void componentInstanceStatusRequestValidate(String tenant,
 String namespace,
 String componentName,
 int instanceId,
 String clientRole,
 AuthenticationDataSource clientAuthenticationDataHttps)

isSuperUser

public boolean isSuperUser(String clientRole,
 AuthenticationDataSource authenticationData)

allowFunctionOps

public boolean allowFunctionOps(org.apache.pulsar.common.naming.NamespaceName namespaceName,
 String role,
 AuthenticationDataSource authenticationData)

getClassLoaderFromPackage

protected ClassLoader getClassLoaderFromPackage(String className,
 File packageFile,
 String narExtractionDirectory)

getPackageFile

protected File getPackageFile(String functionPkgUrl,
 String existingPackagePath,
 InputStream uploadedInputStream)
                       throws IOException,
PulsarAdminException

Throws:

IOException

PulsarAdminException

downloadPackageFile

protected File downloadPackageFile(String packageName)
                            throws IOException,
PulsarAdminException

Throws:

IOException

PulsarAdminException

getPackageFile

protected File getPackageFile(String functionPkgUrl)
                       throws IOException,
PulsarAdminException

Throws:

IOException

PulsarAdminException

getBuiltinFunctionClassLoader

protected ClassLoader getBuiltinFunctionClassLoader(String archive)