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)	Deprecated. use isSuperUser(AuthenticationParameters)
boolean	allowFunctionOps(org.apache.pulsar.common.naming.NamespaceName namespaceName, AuthenticationParameters authParams)
void	changeFunctionInstanceStatus(String tenant, String namespace, String componentName, String instanceId, boolean start, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)	Deprecated.
void	changeFunctionInstanceStatus(String tenant, String namespace, String componentName, String instanceId, boolean start, URI uri, AuthenticationParameters authParams)
void	changeFunctionStatusAllInstances(String tenant, String namespace, String componentName, boolean start, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)	Deprecated.
void	changeFunctionStatusAllInstances(String tenant, String namespace, String componentName, boolean start, AuthenticationParameters authParams)
protected void	componentInstanceStatusRequestValidate(String tenant, String namespace, String componentName, int instanceId, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)	Deprecated.
protected void	componentInstanceStatusRequestValidate(String tenant, String namespace, String componentName, int instanceId, AuthenticationParameters authParams)
protected void	componentStatusRequestValidate(String tenant, String namespace, String componentName, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)	Deprecated.
protected void	componentStatusRequestValidate(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
static String	createPackagePath(String tenant, String namespace, String functionName, String fileName)
void	deregisterFunction(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
javax.ws.rs.core.StreamingOutput	downloadFunction(String tenant, String namespace, String componentName, AuthenticationParameters authParams, boolean transformFunction)
javax.ws.rs.core.StreamingOutput	downloadFunction(String path, AuthenticationParameters authParams)
protected org.apache.pulsar.functions.utils.ValidatableFunctionPackage	getBuiltinFunctionPackage(String archive)
org.apache.pulsar.common.functions.FunctionConfig	getFunctionInfo(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl	getFunctionsInstanceStats(String tenant, String namespace, String componentName, String instanceId, URI uri, AuthenticationParameters authParams)
org.apache.pulsar.common.functions.FunctionState	getFunctionState(String tenant, String namespace, String functionName, String key, AuthenticationParameters authParams)
org.apache.pulsar.common.policies.data.FunctionStatsImpl	getFunctionStats(String tenant, String namespace, String componentName, URI uri, AuthenticationParameters authParams)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getListOfConnectors()
protected File	getPackageFile(org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType, String functionPkgUrl)
protected File	getPackageFile(org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType, String functionPkgUrl, String existingPackagePath, InputStream uploadedInputStream)
boolean	isAuthorizedRole(String tenant, String namespace, String clientRole, AuthenticationDataSource authenticationData)	Deprecated. use isAuthorizedRole(String, String, AuthenticationParameters) instead.
boolean	isAuthorizedRole(String tenant, String namespace, AuthenticationParameters authParams)
boolean	isSuperUser(String clientRole, AuthenticationDataSource authenticationData)	Deprecated. use isSuperUser(AuthenticationParameters)
boolean	isSuperUser(AuthenticationParameters authParams)
List<String>	listFunctions(String tenant, String namespace, AuthenticationParameters authParams)
void	putFunctionState(String tenant, String namespace, String functionName, String key, org.apache.pulsar.common.functions.FunctionState state, AuthenticationParameters authParams)
void	reloadConnectors(AuthenticationParameters authParams)
void	restartFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, AuthenticationParameters authParams)
void	restartFunctionInstances(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
void	startFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, AuthenticationParameters authParams)
void	startFunctionInstances(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
void	stopFunctionInstance(String tenant, String namespace, String componentName, String instanceId, URI uri, AuthenticationParameters authParams)
void	stopFunctionInstances(String tenant, String namespace, String componentName, AuthenticationParameters authParams)
void	throwRestExceptionIfUnauthorizedForNamespace(String tenant, String namespace, String componentName, String action, AuthenticationParameters authParams)
String	triggerFunction(String tenant, String namespace, String functionName, String input, InputStream uploadedInputStream, String topic, AuthenticationParameters authParams)
void	uploadFunction(InputStream uploadedInputStream, String path, AuthenticationParameters authParams)
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

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,
 AuthenticationParameters authParams)

Specified by:

deregisterFunction in interface Component<PulsarWorkerService>

getFunctionInfo

public org.apache.pulsar.common.functions.FunctionConfig getFunctionInfo(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams)

Specified by:

getFunctionInfo in interface Component<PulsarWorkerService>

stopFunctionInstance

public void stopFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 AuthenticationParameters authParams)

Specified by:

stopFunctionInstance in interface Component<PulsarWorkerService>

startFunctionInstance

public void startFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 AuthenticationParameters authParams)

Specified by:

startFunctionInstance in interface Component<PulsarWorkerService>

changeFunctionInstanceStatus

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

Deprecated.

changeFunctionInstanceStatus

public void changeFunctionInstanceStatus(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 boolean start,
 URI uri,
 AuthenticationParameters authParams)

restartFunctionInstance

public void restartFunctionInstance(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 AuthenticationParameters authParams)

Specified by:

restartFunctionInstance in interface Component<PulsarWorkerService>

stopFunctionInstances

public void stopFunctionInstances(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams)

Specified by:

stopFunctionInstances in interface Component<PulsarWorkerService>

startFunctionInstances

public void startFunctionInstances(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams)

Specified by:

startFunctionInstances in interface Component<PulsarWorkerService>

changeFunctionStatusAllInstances

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

Deprecated.

changeFunctionStatusAllInstances

public void changeFunctionStatusAllInstances(String tenant,
 String namespace,
 String componentName,
 boolean start,
 AuthenticationParameters authParams)

restartFunctionInstances

public void restartFunctionInstances(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams)

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,
 AuthenticationParameters authParams)

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,
 AuthenticationParameters authParams)

Specified by:

getFunctionsInstanceStats in interface Component<PulsarWorkerService>

listFunctions

public List<String> listFunctions(String tenant,
 String namespace,
 AuthenticationParameters authParams)

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(AuthenticationParameters authParams)

Specified by:

reloadConnectors in interface Component<PulsarWorkerService>

triggerFunction

public String triggerFunction(String tenant,
 String namespace,
 String functionName,
 String input,
 InputStream uploadedInputStream,
 String topic,
 AuthenticationParameters authParams)

Specified by:

triggerFunction in interface Component<PulsarWorkerService>

getFunctionState

public org.apache.pulsar.common.functions.FunctionState getFunctionState(String tenant,
 String namespace,
 String functionName,
 String key,
 AuthenticationParameters authParams)

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,
 AuthenticationParameters authParams)

Specified by:

putFunctionState in interface Component<PulsarWorkerService>

uploadFunction

public void uploadFunction(InputStream uploadedInputStream,
 String path,
 AuthenticationParameters authParams)

Specified by:

uploadFunction in interface Component<PulsarWorkerService>

downloadFunction

public javax.ws.rs.core.StreamingOutput downloadFunction(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams,
 boolean transformFunction)

Specified by:

downloadFunction in interface Component<PulsarWorkerService>

downloadFunction

public javax.ws.rs.core.StreamingOutput downloadFunction(String path,
 AuthenticationParameters authParams)

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

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

Deprecated.

use isAuthorizedRole(String, String, AuthenticationParameters) instead.

Throws:

PulsarAdminException

isAuthorizedRole

public boolean isAuthorizedRole(String tenant,
 String namespace,
 AuthenticationParameters authParams)
                         throws PulsarAdminException

Throws:

PulsarAdminException

throwRestExceptionIfUnauthorizedForNamespace

public void throwRestExceptionIfUnauthorizedForNamespace(String tenant,
 String namespace,
 String componentName,
 String action,
 AuthenticationParameters authParams)

componentStatusRequestValidate

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

Deprecated.

componentStatusRequestValidate

protected void componentStatusRequestValidate(String tenant,
 String namespace,
 String componentName,
 AuthenticationParameters authParams)

componentInstanceStatusRequestValidate

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

Deprecated.

componentInstanceStatusRequestValidate

protected void componentInstanceStatusRequestValidate(String tenant,
 String namespace,
 String componentName,
 int instanceId,
 AuthenticationParameters authParams)

isSuperUser

public boolean isSuperUser(AuthenticationParameters authParams)

isSuperUser

@Deprecated
public boolean isSuperUser(String clientRole,
 AuthenticationDataSource authenticationData)

Deprecated.

use isSuperUser(AuthenticationParameters)

allowFunctionOps

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

Deprecated.

use isSuperUser(AuthenticationParameters)

allowFunctionOps

public boolean allowFunctionOps(org.apache.pulsar.common.naming.NamespaceName namespaceName,
 AuthenticationParameters authParams)

getPackageFile

protected File getPackageFile(org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType,
 String functionPkgUrl,
 String existingPackagePath,
 InputStream uploadedInputStream)
                       throws IOException,
PulsarAdminException

Throws:

IOException

PulsarAdminException

getPackageFile

protected File getPackageFile(org.apache.pulsar.functions.proto.Function.FunctionDetails.ComponentType componentType,
 String functionPkgUrl)
                       throws IOException,
PulsarAdminException

Throws:

IOException

PulsarAdminException

getBuiltinFunctionPackage

protected org.apache.pulsar.functions.utils.ValidatableFunctionPackage getBuiltinFunctionPackage(String archive)