Package step.functions.packages.client
Interface FunctionPackageClient
-
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
RemoteFunctionPackageClientImpl
public interface FunctionPackageClient extends Closeable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteKeywordPackage(String packlageId)
Delete an existing Keyword packageFunctionPackage
lookupPackageByResourceName(String resourceName)
Retrieve aFunctionPackage
object based on the resourceName associated with it.FunctionPackage
newKeywordPackage(File packageLibraryFile, File packageFile, Map<String,String> packageAttributes)
Creates a new Keyword packageFunctionPackage
updateKeywordPackageById(FunctionPackage previousPackage, File packageLibraryFile, File packageFile, Map<String,String> packageAttributes)
Update an existing Keyword package identified by its ObjectIdFunctionPackage
updateResourceBasedKeywordPackage(File packageLibraryFile, File packageFile, Map<String,String> packageAttributes)
Update an existing Keyword package with a new version of the resource(s), the package is implicitly managed via resource name Warning: if multiple resources are created with the same name, or if multiple keyword packages reference the same resource, only the first match will be updated.
-
-
-
Method Detail
-
newKeywordPackage
FunctionPackage newKeywordPackage(File packageLibraryFile, File packageFile, Map<String,String> packageAttributes) throws IOException
Creates a new Keyword package- Parameters:
packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- the attributes of the Keyword (ex: version, app, etc)- Returns:
- the newly created
FunctionPackage
- Throws:
IOException
- in case of any error
-
updateKeywordPackageById
FunctionPackage updateKeywordPackageById(FunctionPackage previousPackage, File packageLibraryFile, File packageFile, Map<String,String> packageAttributes) throws IOException
Update an existing Keyword package identified by its ObjectId- Parameters:
previousPackage
- the older version of theFunctionPackage
obtained at creation time (i.e returned by newKeywordPackage)packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- (optional) the attributes the keyword package can be identified with, by default the resource name will be used- Returns:
- the updated
FunctionPackage
- Throws:
IOException
- in case of any error
-
deleteKeywordPackage
void deleteKeywordPackage(String packlageId)
Delete an existing Keyword package- Parameters:
packlageId
- the ID of the package
-
updateResourceBasedKeywordPackage
FunctionPackage updateResourceBasedKeywordPackage(File packageLibraryFile, File packageFile, Map<String,String> packageAttributes) throws IOException
Update an existing Keyword package with a new version of the resource(s), the package is implicitly managed via resource name Warning: if multiple resources are created with the same name, or if multiple keyword packages reference the same resource, only the first match will be updated.- Parameters:
packageLibraryFile
- a ZippackageFile
- the Jar/DLL file containing the Keyword definitions. The file will be uploaded to the ControllerpackageAttributes
- (optional) the attributes the keyword package can be identified with, by default the resource name will be used- Returns:
- the updated
FunctionPackage
- Throws:
IOException
- in case of any error
-
lookupPackageByResourceName
FunctionPackage lookupPackageByResourceName(String resourceName) throws IOException
Retrieve aFunctionPackage
object based on the resourceName associated with it. Warning: if multiple resources are created with the same name, or if multiple keyword packages reference the same resource, only the first match will be updated.- Parameters:
resourceName
- the name of the Resource that the searchedFunctionPackage
relies on- Returns:
- the corresponding
FunctionPackage
, if any match occurred - Throws:
IOException
- in case of any error
-
-