public class DeploymentClient extends NodeManagerClient
debug
Constructor and Description |
---|
DeploymentClient(ConnectionContext cc)
Constructor.
|
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.
|
createConnectionContext, createConnectionContext, createConnectionContext, getRootWebResource, getUrl, handleError, logDebug, path, setConnectTimeout, setReadTimeout
public DeploymentClient(ConnectionContext cc) throws NodeManagerAPIException
cc
- The ConnectionContext, encapsulating all connectivity details to the Node ManagerNodeManagerAPIException
- If the DeploymentClient cannot be createdpublic void setDebug(boolean debug)
NodeManagerClient
setDebug
in class NodeManagerClient
debug
- True if debugging is enabled to stdout, false otherwise.public void uploadConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, com.vordel.archive.fed.DeploymentArchive archive) throws NodeManagerAPIException
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).NodeManagerAPIException
- If the Group does not exist.public void uploadConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, com.vordel.archive.fed.DeploymentArchive archive) throws NodeManagerAPIException
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).NodeManagerAPIException
- If upload was unsuccessful.public java.lang.String uploadFileConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, java.lang.String filename) throws NodeManagerAPIException
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.NodeManagerAPIException
- If the specified Group does not exist.public java.lang.String uploadFileConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, java.lang.String filename) throws NodeManagerAPIException
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.NodeManagerAPIException
- If the configuration fails to be uploaded.public java.lang.String uploadPolicyFileConfigurationForDeploymentByName(java.lang.String groupName, java.lang.String policyFilename) throws NodeManagerAPIException
groupName
- The name of the group that the file is destined for.policyFilename
- The name of the policy archive file.NodeManagerAPIException
- If the specified Group does not exist.public java.lang.String uploadPolicyFileConfigurationForDeployment(java.lang.String groupID, java.lang.String policyFilename) throws NodeManagerAPIException
groupID
- The id of the group that the file is destined for, (e.g. group-2
).policyFilename
- The name of the policy archive file.NodeManagerAPIException
- If the policy file cannot be uploaded.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 NodeManagerAPIException
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 ArchiveNodeManagerAPIException
- If the specified Group does not exist.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 NodeManagerAPIException
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 ArchiveNodeManagerAPIException
- If the environment file cannot be successfully uploaded.public java.util.Map<java.lang.String,java.util.Map<java.lang.String,ServiceDeploymentArchiveDetails>> getDomainDeployments()
instance-1
) and
a value containing deployment information.public DeploymentResult deploy(java.lang.String serviceId, java.lang.String archiveId) throws NodeManagerAPIException
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.NodeManagerAPIException
- If the archive cannot be deployed.public com.vordel.archive.fed.DeploymentArchive getDeploymentArchive(java.lang.String groupID, java.lang.String archiveID) throws NodeManagerAPIException
groupID
- The group from where to find the archivearchiveID
- The id of the Deployment ArchiveNodeManagerAPIException
- If the specified archive or group is not presentpublic java.lang.String getGroupConfFile(java.lang.String groupID, java.lang.String filename) throws NodeManagerAPIException
groupID
- The Group which owns the filefilename
- The name of the configuration fileNodeManagerAPIException
- If the file cannot be locatedpublic com.vordel.archive.fed.DeploymentArchive getDeploymentArchiveForService(java.lang.String serviceID) throws NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).NodeManagerAPIException
- If the archive cannot be foundpublic com.vordel.archive.fed.PolicyArchive getPolicyArchiveForService(java.lang.String serviceID) throws NodeManagerAPIException
serviceID
- The API Server internal topology id, e.g. instance-1NodeManagerAPIException
- If the Policy Archive cannot be foundpublic com.vordel.archive.fed.EnvironmentArchive getEnvironmentArchiveForService(java.lang.String serviceID) throws NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).NodeManagerAPIException
- If the Environment Archive cannot be foundpublic java.util.List<com.vordel.archive.fed.DeploymentArchive> getDeploymentArchivesForGroup(java.lang.String groupID) throws NodeManagerAPIException
groupID
- The group id, (e.g. group-2
).NodeManagerAPIException
- If a list of deployment archives for the specified Group cannot be identified.public EnvironmentalizedEntities getEnvSettingsForService(java.lang.String serviceID) throws NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).NodeManagerAPIException
- If the environment settings cannot be identified for the specified Service.public void updateGroupPassphrase(java.lang.String groupID, java.lang.String oldPassphrase, java.lang.String newPassphrase) throws NodeManagerAPIException
groupID
- The group id, (e.g. group-2
).oldPassphrase
- The old passphrase.newPassphrase
- The new passphrase.NodeManagerAPIException
- If the passphrase could not be updated.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 NodeManagerAPIException
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.NodeManagerAPIException
- If the archive's details can't be updated.public void updateNodeManagerPassphrase(java.lang.String serviceID, java.lang.String oldPassphrase, java.lang.String newPassphrase) throws NodeManagerAPIException
serviceID
- The internal topology id of the Node Manager, (e.g. nodemanager-1
).oldPassphrase
- The old passphrase.newPassphrase
- The new passphrase.NodeManagerAPIException
- If the NodeManager's passphrase cannot be updated.
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel