com.vordel.api.deployment.client

Class DeploymentClient

java.lang.Object

com.vordel.api.nm.NodeManagerClient

com.vordel.api.deployment.client.DeploymentClient

public class DeploymentClient
extends com.vordel.api.nm.NodeManagerClient

Deployment and Configuration REST API Java client helper class. It invokes the Node Manager Deployment and Configuration REST APIs. The Deployment API is exposed by the Node Manager to manage Deployment Archives for groups of API Servers. The Configuration REST API is exposed by the API Server. Deployments of new Deployment Archives is done using the Deployment API in conjunction with the Configuration API. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Field Summary

Fields inherited from class com.vordel.api.nm.NodeManagerClient

debug

Constructor Summary

Constructors

Constructor and Description
DeploymentClient(com.vordel.api.nm.ConnectionContext cc) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentResult	deploy(java.lang.String serviceId, java.lang.String archiveId) Calls the API Servers's Configuration API to load a new Deployment Archive.
com.vordel.archive.fed.DeploymentArchive	getDeploymentArchive(java.lang.String groupID, java.lang.String archiveID) Get a Deployment Archive.
com.vordel.archive.fed.DeploymentArchive	getDeploymentArchiveForService(java.lang.String serviceID) Get a Deployment Archive for a particular API Server.
java.util.List<com.vordel.archive.fed.DeploymentArchive>	getDeploymentArchivesForGroup(java.lang.String groupID) Get the Deployment Archives for a particular group.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,ServiceDeploymentArchiveDetails>>	getDomainDeployments() Get a list of deployments for all API Servers in the domain.
com.vordel.archive.fed.EnvironmentArchive	getEnvironmentArchiveForService(java.lang.String serviceID) Get a Environment Archive for a particular API Server.
EnvironmentalizedEntities	getEnvSettingsForService(java.lang.String serviceID) Get enviornmentalized settings for a particular API Server.
java.lang.String	getGroupConfFile(java.lang.String groupID, java.lang.String filename) Get a Group configuration file.
com.vordel.archive.fed.PolicyArchive	getPolicyArchiveForService(java.lang.String serviceID) Get a Policy Archive for a particular API Server.
void	setDebug(boolean debug) Turns debug on/off.
void	updateDeploymentArchiveProperties(java.lang.String groupID, java.lang.String archiveID, java.util.Map<java.lang.String,java.lang.String> policyProperties, java.util.Map<java.lang.String,java.lang.String> environmentProperties) Update Deployment Archive manifest properties.
void	updateGroupPassphrase(java.lang.String groupID, java.lang.String oldPassphrase, java.lang.String newPassphrase) Update the configuration passphrase of a group of API Servers.
void	updateNodeManagerPassphrase(java.lang.String serviceID, java.lang.String oldPassphrase, java.lang.String newPassphrase) Update the passphrase for a Node Manager's configuration.
void	uploadConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, com.vordel.archive.fed.DeploymentArchive archive) Copy the Deployment Archive to all hosts running the selected API Servers in the group.
void	uploadConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, com.vordel.archive.fed.DeploymentArchive archive) Copy the Deployment Archive to all hosts running the selected API Servers in the group.
java.lang.String	uploadEnvironmentFileConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, java.lang.String environmentFilename, java.lang.String relatedPolicyArchiveID) Copy an Environment Archive to the Node Manager, as Step 2 in a deployment of separate Policy and Environment archives.
java.lang.String	uploadEnvironmentFileConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, java.lang.String environmentFilename, java.lang.String relatedPolicyArchiveID) Copy an Environment Archive to the Node Manager, as Step 2 in a deployment of separate Policy and Environment archives.
java.lang.String	uploadFileConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, java.lang.String filename) Copy the Deployment Archive to all hosts running the selected API Servers in the group.
java.lang.String	uploadFileConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, java.lang.String filename) Copy the Deployment Archive to all hosts running the selected API Servers in the group.
java.lang.String	uploadPolicyFileConfigurationForDeployment(java.lang.String groupID, java.lang.String policyFilename) Copy a Policy Archive to the Node Manager's disk as Step 1 in a deployment of separate Policy and Environment archives.
java.lang.String	uploadPolicyFileConfigurationForDeploymentByName(java.lang.String groupName, java.lang.String policyFilename) Copy a Policy Archive to the Node Manager's disk as Step 1 in a deployment of separate Policy and Environment archives.

Methods inherited from class com.vordel.api.nm.NodeManagerClient

accept, createConnectionContext, createConnectionContext, createConnectionContext, getRootWebResource, getUrl, handleError, logDebug, path, setConnectTimeout, setReadTimeout, type

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentClient

public DeploymentClient(com.vordel.api.nm.ConnectionContext cc)
                 throws com.vordel.api.nm.NodeManagerAPIException

Constructor.

Parameters:

url - The Node Manager URL, e.g. https://localhost:8090/api.

username - The username

password - The password

debug - Debug trace on/off

Throws:

com.vordel.api.nm.NodeManagerAPIException

Method Detail

setDebug

public void setDebug(boolean debug)

Description copied from class: com.vordel.api.nm.NodeManagerClient

Turns debug on/off. Debug written to standard out.

Overrides:

setDebug in class com.vordel.api.nm.NodeManagerClient

uploadConfigurationForDeploymentByName

public void uploadConfigurationForDeploymentByName(java.lang.String groupName,
                                          java.util.List<java.lang.String> serviceIDs,
                                          com.vordel.archive.fed.DeploymentArchive archive)
                                            throws com.vordel.api.nm.NodeManagerAPIException

Copy the Deployment Archive to all hosts running the selected API Servers in the group. The Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed.

Parameters:

groupName - The name of the group that the DeploymentArchive is destined for.

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

archive - The Deployment Archive (.fed file).

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadConfigurationForDeployment

public void uploadConfigurationForDeployment(java.lang.String groupID,
                                    java.util.List<java.lang.String> serviceIDs,
                                    com.vordel.archive.fed.DeploymentArchive archive)
                                      throws com.vordel.api.nm.NodeManagerAPIException

Copy the Deployment Archive to all hosts running the selected API Servers in the group. The Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed.

Parameters:

groupID - The id of the group that the DeploymentArchive is destined for, (e.g. group-2).

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

archive - The deployment archive (.fed file).

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadFileConfigurationForDeploymentByName

public java.lang.String uploadFileConfigurationForDeploymentByName(java.lang.String groupName,
                                                          java.util.List<java.lang.String> serviceIDs,
                                                          java.lang.String filename)
                                                            throws com.vordel.api.nm.NodeManagerAPIException

Copy the Deployment Archive to all hosts running the selected API Servers in the group. The Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed.

Parameters:

groupName - The name of the group that the file is destined for.

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

filename - The name of the deployment archive.

Returns:

The id of the Deployment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadFileConfigurationForDeployment

public java.lang.String uploadFileConfigurationForDeployment(java.lang.String groupID,
                                                    java.util.List<java.lang.String> serviceIDs,
                                                    java.lang.String filename)
                                                      throws com.vordel.api.nm.NodeManagerAPIException

Copy the Deployment Archive to all hosts running the selected API Servers in the group. The Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed.

Parameters:

groupID - The id of the group that the file is destined for, (e.g. group-2).

filename - The name of the Deployment Archive file.

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

Returns:

The id of the Deployment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadPolicyFileConfigurationForDeploymentByName

public java.lang.String uploadPolicyFileConfigurationForDeploymentByName(java.lang.String groupName,
                                                                java.lang.String policyFilename)
                                                                  throws com.vordel.api.nm.NodeManagerAPIException

Copy a Policy Archive to the Node Manager's disk as Step 1 in a deployment of separate Policy and Environment archives. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Parameters:

groupName - The name of the group that the file is destined for.

policyFilename - The name of the policy archive file.

Returns:

The id of the Policy Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadPolicyFileConfigurationForDeployment

public java.lang.String uploadPolicyFileConfigurationForDeployment(java.lang.String groupID,
                                                          java.lang.String policyFilename)
                                                            throws com.vordel.api.nm.NodeManagerAPIException

Copy a Policy Archive to the Node Manager's disk as Step 1 in a deployment of separate Policy and Environment archives. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Parameters:

groupID - The id of the group that the file is destined for, (e.g. group-2).

policyFilename - The name of the policy archive file.

Returns:

The id of the Policy Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadEnvironmentFileConfigurationForDeploymentByName

public java.lang.String uploadEnvironmentFileConfigurationForDeploymentByName(java.lang.String groupName,
                                                                     java.util.List<java.lang.String> serviceIDs,
                                                                     java.lang.String environmentFilename,
                                                                     java.lang.String relatedPolicyArchiveID)
                                                                       throws com.vordel.api.nm.NodeManagerAPIException

Copy an Environment Archive to the Node Manager, as Step 2 in a deployment of separate Policy and Environment archives. The Node Manager will merge the Environment Archive with the related Policy Archive copied to the Node Manager disk in Step 1, to create a Deployment Archive. The Deployment Archive is then copied to all hosts running selected API Servers in the group. The merged Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Parameters:

groupName - The name of the group that the file is destined for.

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the merged Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

environmentFilename - The name of the Environment Archive file.

relatedPolicyArchiveID - The id of the Policy Archive that must be merged with this Environment Archive

Returns:

The id of the merged Deployment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

uploadEnvironmentFileConfigurationForDeployment

public java.lang.String uploadEnvironmentFileConfigurationForDeployment(java.lang.String groupID,
                                                               java.util.List<java.lang.String> serviceIDs,
                                                               java.lang.String environmentFilename,
                                                               java.lang.String relatedPolicyArchiveID)
                                                                 throws com.vordel.api.nm.NodeManagerAPIException

Copy an Environment Archive to the Node Manager, as Step 2 in a deployment of separate Policy and Environment archives. The Node Manager will merge the Environment Archive with the related Policy Archive copied to the Node Manager disk in Step 1, to create a Deployment Archive. The Deployment Archive is then copied to all hosts running selected API Servers in the group. The merged Deployment Archive must be copied to all hosts running the selected API Servers successfully in order for this method to succeed. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Parameters:

groupID - The id of the group that the file is destined for, (e.g. group-2).

serviceIDs - The ids of the selected API Servers. If 1 or more serviceIDs are specified this method will only copy the merged Deployment Archive to the hosts that those API Servers are running on. If no ids are specified then it is assumed that all API Servers in the group are specified.

environmentFilename - The name of the Environment Archive file.

relatedPolicyArchiveID - The id of the Policy Archive that must be merged with this Environment Archive

Returns:

The id of the merged Deployment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

getDomainDeployments

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,ServiceDeploymentArchiveDetails>> getDomainDeployments()

Get a list of deployments for all API Servers in the domain.

Returns:

A map of maps. The outer map key is the groupID. The outer map value is a map with a key of serviceID (e.g. instance-1) and a value containing deployment information.

deploy

public DeploymentResult deploy(java.lang.String serviceId,
                      java.lang.String archiveId)
                        throws com.vordel.api.nm.NodeManagerAPIException

Calls the API Servers's Configuration API to load a new Deployment Archive. The call goes via the Routing API in the Node Manager. The Node Manager Deployment API must have copied the Deploymenbt ARchive to hosts running the groupo prior to this method being invoked. Refer to REST API documentation for more information on the Deployment and Configuration APIs.

Parameters:

serviceId - The id of the API Server in the topology, (e.g. instance-1).

archiveId - The id of the Deployment Archive that the API Server must load.

Returns:

the deployment result

Throws:

com.vordel.api.nm.NodeManagerAPIException

getDeploymentArchive

public com.vordel.archive.fed.DeploymentArchive getDeploymentArchive(java.lang.String groupID,
                                                            java.lang.String archiveID)
                                                              throws com.vordel.api.nm.NodeManagerAPIException

Get a Deployment Archive. The archive must be currently deployed to a least one API Server in the domain.

Parameters:

archiveID - The id of the Deployment Archive

Returns:

The deployment archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

getGroupConfFile

public java.lang.String getGroupConfFile(java.lang.String groupID,
                                java.lang.String filename)
                                  throws com.vordel.api.nm.NodeManagerAPIException

Get a Group configuration file.

Parameters:

groupID -

filename -

Returns:

The group configuration file content

Throws:

com.vordel.api.nm.NodeManagerAPIException

getDeploymentArchiveForService

public com.vordel.archive.fed.DeploymentArchive getDeploymentArchiveForService(java.lang.String serviceID)
                                                                        throws com.vordel.api.nm.NodeManagerAPIException

Get a Deployment Archive for a particular API Server.

Parameters:

serviceID - The API Server internal topology id, (e.g. instance-1).

Returns:

The Deployment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

getPolicyArchiveForService

public com.vordel.archive.fed.PolicyArchive getPolicyArchiveForService(java.lang.String serviceID)
                                                                throws com.vordel.api.nm.NodeManagerAPIException

Get a Policy Archive for a particular API Server.

Parameters:

serviceID - The API Server internal topology id, e.g. instance-1

Returns:

The Policy Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

getEnvironmentArchiveForService

public com.vordel.archive.fed.EnvironmentArchive getEnvironmentArchiveForService(java.lang.String serviceID)
                                                                          throws com.vordel.api.nm.NodeManagerAPIException

Get a Environment Archive for a particular API Server.

Parameters:

serviceID - The API Server internal topology id, (e.g. instance-1).

Returns:

The Environment Archive

Throws:

com.vordel.api.nm.NodeManagerAPIException

getDeploymentArchivesForGroup

public java.util.List<com.vordel.archive.fed.DeploymentArchive> getDeploymentArchivesForGroup(java.lang.String groupID)
                                                                                       throws com.vordel.api.nm.NodeManagerAPIException

Get the Deployment Archives for a particular group.

Parameters:

groupID - The group id, (e.g. group-2).

Returns:

list of Deployment Archives

Throws:

com.vordel.api.nm.NodeManagerAPIException

getEnvSettingsForService

public EnvironmentalizedEntities getEnvSettingsForService(java.lang.String serviceID)
                                                   throws com.vordel.api.nm.NodeManagerAPIException

Get enviornmentalized settings for a particular API Server.

Parameters:

serviceID - The API Server internal topology id, (e.g. instance-1).

Returns:

The environmentalized settings

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateGroupPassphrase

public void updateGroupPassphrase(java.lang.String groupID,
                         java.lang.String oldPassphrase,
                         java.lang.String newPassphrase)
                           throws com.vordel.api.nm.NodeManagerAPIException

Update the configuration passphrase of a group of API Servers.

Parameters:

groupID - The group id, (e.g. group-2).

oldPassphrase - The old passphrase.

newPassphrase - The new passphrase.

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateDeploymentArchiveProperties

public void updateDeploymentArchiveProperties(java.lang.String groupID,
                                     java.lang.String archiveID,
                                     java.util.Map<java.lang.String,java.lang.String> policyProperties,
                                     java.util.Map<java.lang.String,java.lang.String> environmentProperties)
                                       throws com.vordel.api.nm.NodeManagerAPIException

Update Deployment Archive manifest properties. This method will ensure that the properties are updated on all hosts that have this Deployment Archive on disk for the group. Note that the existing properties are completely overwritten. Updates to read-only properties e.g. Id, Timestamp, are ignored.

Parameters:

groupID - The group id, (e.g. group-2).

archiveID - The id of the Deployment Archive.

policyProperties - The policy archive properties.

environmentProperties - The environment archive properties.

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateNodeManagerPassphrase

public void updateNodeManagerPassphrase(java.lang.String serviceID,
                               java.lang.String oldPassphrase,
                               java.lang.String newPassphrase)
                                 throws com.vordel.api.nm.NodeManagerAPIException

Update the passphrase for a Node Manager's configuration.

Parameters:

serviceID - The internal topology id of the Node Manager, (e.g. nodemanager-1).

oldPassphrase - The old passphrase.

newPassphrase - The new passphrase.

Throws:

com.vordel.api.nm.NodeManagerAPIException