Package step.functions.packages

Class FunctionPackageManager

java.lang.Object

step.functions.packages.FunctionPackageManager

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class FunctionPackageManager
extends java.lang.Object
implements java.io.Closeable

This class is responsible for the handling of FunctionPackage It is responsible for the import of FunctionPackage. The import of a FunctionPackage means:

• the persistence of the FunctionPackage itself
• the definition of the Function contained in the package
• the registration of change watcher of the package file of the FunctionPackage

Constructor Summary

Constructors

Constructor	Description
FunctionPackageManager(FunctionPackageAccessor functionPackageAccessor, FunctionManager functionRepository, ResourceManager resourceManager, FileResolver fileResolver, ch.exense.commons.app.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
FunctionPackage	addOrUpdateFunctionPackage(FunctionPackage newFunctionPackage, ObjectEnricher objectEnricher)	Adds or updates a FunctionPackage This triggers the import or re-import of the Functions contained in the package
FunctionPackage	addOrUpdateResourceBasedFunctionPackage(FunctionPackage newFunctionPackage, ObjectEnricher objectEnricher)	Adds or updates a resource-based FunctionPackage This variation allows for the implicit identification and overwrite of a keyword package based on the name of the associated resource
void	close()
protected void	deleteResource(java.lang.String path)
FunctionPackage	getFunctionPackage(java.lang.String id)
protected java.lang.String	getLibraryResourceId(FunctionPackage fpackage)
FunctionPackage	getPackageByResourceName(java.lang.String resourceName)	Load Keyword package based on the first match on the resource name
java.util.List<Function>	getPackageFunctions(java.lang.String functionPackageId)
java.util.List<Function>	getPackagePreview(FunctionPackage functionPackage)	Get the list of Function contained in the provided package
protected java.lang.String	getResourceId(FunctionPackage fpackage)
protected java.lang.String	getResourceSplitValue(java.lang.String resourceLocation)
void	registerAttributeResolver(java.lang.String key, java.util.function.Function<java.lang.String,java.lang.String> value)
void	registerFunctionPackageHandler(FunctionPackageHandler packageHandler)	Registers a FunctionPackageHandler
FunctionPackage	reloadFunctionPackage(java.lang.String functionPackageId, ObjectEnricher objectEnricher)	Reloads a FunctionPackage.
void	removeFunctionPackage(java.lang.String id)
void	start()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionPackageManager

public FunctionPackageManager(FunctionPackageAccessor functionPackageAccessor,
                              FunctionManager functionRepository,
                              ResourceManager resourceManager,
                              FileResolver fileResolver,
                              ch.exense.commons.app.Configuration configuration)

Method Detail

start

public void start()

registerFunctionPackageHandler

public void registerFunctionPackageHandler(FunctionPackageHandler packageHandler)

Registers a FunctionPackageHandler

Parameters:

packageHandler - the instance of the FunctionPackageHandler

reloadFunctionPackage

public FunctionPackage reloadFunctionPackage(java.lang.String functionPackageId,
                                             ObjectEnricher objectEnricher)
                                      throws java.lang.Exception

Reloads a FunctionPackage. This triggers a re-import of the Functions contained in the package

Parameters:

functionPackageId - the ID of the FunctionPackage to be reloaded

Returns:

the updated FunctionPackage

Throws:

java.lang.Exception - if any error occurs during reloading

addOrUpdateFunctionPackage

public FunctionPackage addOrUpdateFunctionPackage(FunctionPackage newFunctionPackage,
                                                  ObjectEnricher objectEnricher)
                                           throws java.lang.Exception

Adds or updates a FunctionPackage This triggers the import or re-import of the Functions contained in the package

Parameters:

newFunctionPackage - the FunctionPackage to be loaded

Returns:

the updated FunctionPackage

Throws:

java.lang.Exception - if any error occurs during loading

addOrUpdateResourceBasedFunctionPackage

public FunctionPackage addOrUpdateResourceBasedFunctionPackage(FunctionPackage newFunctionPackage,
                                                               ObjectEnricher objectEnricher)
                                                        throws java.lang.Exception

Adds or updates a resource-based FunctionPackage This variation allows for the implicit identification and overwrite of a keyword package based on the name of the associated resource

Parameters:

newFunctionPackage - the FunctionPackage to be loaded

Returns:

the updated FunctionPackage

Throws:

java.lang.Exception - if any error occurs during loading

registerAttributeResolver

public void registerAttributeResolver(java.lang.String key,
                                      java.util.function.Function<java.lang.String,java.lang.String> value)

getLibraryResourceId

protected java.lang.String getLibraryResourceId(FunctionPackage fpackage)

getResourceId

protected java.lang.String getResourceId(FunctionPackage fpackage)

getResourceSplitValue

protected java.lang.String getResourceSplitValue(java.lang.String resourceLocation)

getPackagePreview

public java.util.List<Function> getPackagePreview(FunctionPackage functionPackage)
                                           throws java.lang.Exception

Get the list of Function contained in the provided package

Parameters:

functionPackage - the FunctionPackage containing functions

Returns:

the list of Function found in the FunctionPackage

Throws:

java.lang.Exception - if any error occurs during loading

getPackageByResourceName

public FunctionPackage getPackageByResourceName(java.lang.String resourceName)
                                         throws java.lang.Exception

Load Keyword package based on the first match on the resource name

Parameters:

resourceName - the resource name to search with

Returns:

the first matching Keyword package

Throws:

java.lang.Exception - if any error occurs during loading

getFunctionPackage

public FunctionPackage getFunctionPackage(java.lang.String id)

removeFunctionPackage

public void removeFunctionPackage(java.lang.String id)

deleteResource

protected void deleteResource(java.lang.String path)

getPackageFunctions

public java.util.List<Function> getPackageFunctions(java.lang.String functionPackageId)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException