com.cordys.cap.utility

Interface DeploymentUtility

public interface DeploymentUtility

DeploymentUtility provides APIs to work with CAP framework. This utility by default performs the desired action on all the nodes in the the cluster for the given space.

Author:

rsailaja

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeploymentUtility.Builder This class is used to build the deployment utility.

Method Summary

Modifier and Type	Method and Description
void	deploy(java.util.List<PackageDetails> packages, long timeout) Deploys the given list of caps to all the nodes in the cluster.
PackageStatusDetails	getPackageStatus(java.lang.String packageName) Provides the api to get the status of the package on all the nodes.
boolean	isPackageDeployed(java.lang.String packageName) Checks if the given package is deployed.
void	undeploy(java.util.List<PackageDetails> packages, long timeout) Undeploys the given list of caps to all the nodes in the cluster.
void	updateSecuritySettings(boolean allowUnSigned, boolean allowTampered, boolean allowcertificateNotTrusted, boolean allowInvalidKeyUsage) Modifies the security settings.
PackageInfo	upload(java.lang.String packageName, java.io.InputStream inputStream) Uploads the cap file to the file system to make it available for the deployment.

Method Detail

updateSecuritySettings

void updateSecuritySettings(boolean allowUnSigned,
                            boolean allowTampered,
                            boolean allowcertificateNotTrusted,
                            boolean allowInvalidKeyUsage)

Modifies the security settings.

Parameters:

allowUnSigned - boolean to allow deployment of unsigned caps

allowTampered - boolean to allow deployment of tampered caps

allowcertificateNotTrusted - boolean to allow deployment of caps signed with untrusted certificate

allowInvalidKeyUsage - boolean to allow deployment of caps signed with invalid key

upload

PackageInfo upload(java.lang.String packageName,
                   java.io.InputStream inputStream)

Uploads the cap file to the file system to make it available for the deployment.

Parameters:

packageName - name of the cap to be uploaded

inputStream - input stream of the cap file

Returns:

PackagInfo packageInfo containing the details of the cap uploaded

deploy

void deploy(java.util.List<PackageDetails> packages,
            long timeout)

Deploys the given list of caps to all the nodes in the cluster. The deployment will stop if exception occurs or timeout has occurred.

Parameters:

packages - list of packages to be deployed.

timeout - the maximum time in milliseconds to wait for a cap deployment to finish.

undeploy

void undeploy(java.util.List<PackageDetails> packages,
              long timeout)

Undeploys the given list of caps to all the nodes in the cluster. The undeployment will stop if exception occurs or timeout has occurred.

Parameters:

packages - list of packages to be undeployed.

timeout - the maximum time in milliseconds to wait for a cap undeployment to finish.

isPackageDeployed

boolean isPackageDeployed(java.lang.String packageName)

Checks if the given package is deployed.

Parameters:

packageName - the name of the package to check the status.

Returns:

true if the package is deployed, false otherwise.

getPackageStatus

PackageStatusDetails getPackageStatus(java.lang.String packageName)

Provides the api to get the status of the package on all the nodes.

Parameters:

packageName - the name of the package to check the status.

Returns:

PackageStatusDetails object which gives the details of the package at a node level.