public class DeploymentClient
extends com.vordel.api.nm.NodeManagerClient
Constructor and Description |
---|
DeploymentClient(java.lang.String url,
java.lang.String username,
java.lang.String password,
boolean debug)
Constructor.
|
DeploymentClient(java.lang.String url,
java.lang.String username,
java.lang.String password,
java.lang.String trustStoreFilename,
java.lang.String trustStorePassword,
boolean debug)
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.
|
DeploymentArchive |
getDeploymentArchive(java.lang.String groupID,
java.lang.String archiveID)
Get a Deployment Archive.
|
DeploymentArchive |
getDeploymentArchiveForService(java.lang.String serviceID)
Get a Deployment Archive for a particular API Server.
|
java.util.List<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.
|
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.
|
PolicyArchive |
getPolicyArchiveForService(java.lang.String serviceID)
Get a Policy Archive for a particular API Server.
|
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,
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,
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.
|
public DeploymentClient(java.lang.String url, java.lang.String username, java.lang.String password, java.lang.String trustStoreFilename, java.lang.String trustStorePassword, boolean debug) throws com.vordel.api.nm.NodeManagerAPIException
url
- The Node Manager URL, e.g. https://localhost:8090/api.username
- The usernamepassword
- The passwordtrustStoreFilename
- SSL trust storetrustStorePassword
- SSL trust store passworddebug
- Debug trace on/offcom.vordel.api.nm.NodeManagerAPIException
public DeploymentClient(java.lang.String url, java.lang.String username, java.lang.String password, boolean debug) throws com.vordel.api.nm.NodeManagerAPIException
url
- The Node Manager URL, e.g. https://localhost:8090/api.username
- The usernamepassword
- The passworddebug
- Debug trace on/offcom.vordel.api.nm.NodeManagerAPIException
public void uploadConfigurationForDeploymentByName(java.lang.String groupName, java.util.List<java.lang.String> serviceIDs, DeploymentArchive archive) throws com.vordel.api.nm.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).com.vordel.api.nm.NodeManagerAPIException
public void uploadConfigurationForDeployment(java.lang.String groupID, java.util.List<java.lang.String> serviceIDs, DeploymentArchive archive) throws com.vordel.api.nm.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).com.vordel.api.nm.NodeManagerAPIException
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
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.com.vordel.api.nm.NodeManagerAPIException
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
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.com.vordel.api.nm.NodeManagerAPIException
public java.lang.String uploadPolicyFileConfigurationForDeploymentByName(java.lang.String groupName, java.lang.String policyFilename) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group that the file is destined for.policyFilename
- The name of the policy archive file.com.vordel.api.nm.NodeManagerAPIException
public java.lang.String uploadPolicyFileConfigurationForDeployment(java.lang.String groupID, java.lang.String policyFilename) throws com.vordel.api.nm.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.com.vordel.api.nm.NodeManagerAPIException
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
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 Archivecom.vordel.api.nm.NodeManagerAPIException
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
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 Archivecom.vordel.api.nm.NodeManagerAPIException
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 com.vordel.api.nm.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.com.vordel.api.nm.NodeManagerAPIException
public DeploymentArchive getDeploymentArchive(java.lang.String groupID, java.lang.String archiveID) throws com.vordel.api.nm.NodeManagerAPIException
archiveID
- The id of the Deployment Archivecom.vordel.api.nm.NodeManagerAPIException
public java.lang.String getGroupConfFile(java.lang.String groupID, java.lang.String filename) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- filename
- com.vordel.api.nm.NodeManagerAPIException
public DeploymentArchive getDeploymentArchiveForService(java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).com.vordel.api.nm.NodeManagerAPIException
public PolicyArchive getPolicyArchiveForService(java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
serviceID
- The API Server internal topology id, e.g. instance-1com.vordel.api.nm.NodeManagerAPIException
public EnvironmentArchive getEnvironmentArchiveForService(java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).com.vordel.api.nm.NodeManagerAPIException
public java.util.List<DeploymentArchive> getDeploymentArchivesForGroup(java.lang.String groupID) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The group id, (e.g. group-2
).com.vordel.api.nm.NodeManagerAPIException
public EnvironmentalizedEntities getEnvSettingsForService(java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
serviceID
- The API Server internal topology id, (e.g. instance-1
).com.vordel.api.nm.NodeManagerAPIException
public void updateGroupPassphrase(java.lang.String groupID, java.lang.String oldPassphrase, java.lang.String newPassphrase) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The group id, (e.g. group-2
).oldPassphrase
- The old passphrase.newPassphrase
- The new passphrase.com.vordel.api.nm.NodeManagerAPIException
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
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.com.vordel.api.nm.NodeManagerAPIException
public void updateNodeManagerPassphrase(java.lang.String serviceID, java.lang.String oldPassphrase, java.lang.String newPassphrase) throws com.vordel.api.nm.NodeManagerAPIException
serviceID
- The internal topology id of the Node Manager, (e.g. nodemanager-1
).oldPassphrase
- The old passphrase.newPassphrase
- The new passphrase.com.vordel.api.nm.NodeManagerAPIException
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel