public class TopologyClient
extends com.vordel.api.nm.NodeManagerClient
Constructor and Description |
---|
TopologyClient(java.lang.String url,
java.lang.String username,
java.lang.String password,
boolean debug)
Constructor.
|
TopologyClient(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 |
---|---|
Group |
createGroup(Group group)
Create an empty group in the topology.
|
Group |
createGroupByName(java.lang.String groupName)
Create an empty group in the topology.
|
Host |
createHost(Host host)
Create a host in the topology.
|
Service |
createService(java.lang.String groupID,
int servicesPort,
Service service)
Create a new service, meaning API Server (or Node Manager) in the the domain topology.
|
Service |
createServiceByName(java.lang.String hostName,
java.lang.String groupName,
int servicesPort,
Service service)
Create a new service, meaning API Server (or Node Manager) in the the domain topology.
|
Service |
createServiceWithGroup(java.lang.String hostName,
Group group,
int servicesPort,
Service service)
Create a new service, meaning API Server (or Node Manager) in the the domain topology
within a given group.
|
void |
deleteGroup(java.lang.String groupID,
boolean deleteDiskGroup)
Delete a group from the topology.
|
void |
deleteGroupByName(java.lang.String groupName,
boolean deleteDiskGroup)
Delete a group from the topology.
|
void |
deleteHost(java.lang.String hostID)
Delete a host from the topology.
|
void |
deleteHostByName(java.lang.String hostName)
Delete a host from the topology.
|
void |
deleteService(java.lang.String groupID,
java.lang.String serviceID,
boolean deleteDiskInstance)
Delete a service (API Server or Node Manager) from the topology.
|
void |
deleteServiceByName(java.lang.String groupName,
java.lang.String serviceName,
boolean deleteDiskInstance)
Delete a service (API Server or Node Manager) from the topology.
|
com.vordel.security.cert.PersonalInfo |
getDomainCertificateInfo(java.lang.String passphrase)
The the domain certificate, i.e.
|
Group |
getGroup(java.lang.String groupID)
Get a group from the topology.
|
Group |
getGroupByName(java.lang.String groupName)
Get a group from the topology.
|
java.lang.String |
getGroupID(java.lang.String groupName)
Get the topology id of a group.
|
java.util.Collection<Group> |
getGroups()
Get all groups in the topology.
|
Host |
getHost(java.lang.String hostID)
Get a host from the topology.
|
Host |
getHostByName(java.lang.String hostName)
Get a host from the topology.
|
java.lang.String |
getHostID(java.lang.String hostName)
Get the topology id of a host.
|
java.util.Collection<Host> |
getHosts()
Get all hosts in the topology.
|
Service |
getService(java.lang.String groupID,
java.lang.String serviceID)
Get a service from the topology.
|
Service |
getServiceByName(java.lang.String groupName,
java.lang.String serviceName)
Get a service from the topology.
|
java.lang.String |
getServiceID(java.lang.String groupName,
java.lang.String serviceName)
Get the topology id of a service, i.e.
|
java.util.Collection<Service> |
getServices(java.lang.String groupID)
Get all services in a group from the topology.
|
java.util.Collection<Service> |
getServicesByName(java.lang.String groupName)
Get all services in a group from the topology.
|
boolean |
getServiceStatus(java.lang.String groupID,
java.lang.String serviceID)
Get the status of a service (API Server/Node Manager).
|
boolean |
getServiceStatusByName(java.lang.String groupName,
java.lang.String serviceName)
Get the status of a service (API Server/Node Manager).
|
Topology |
getTopology()
Get the full domain topology.
|
boolean |
isServerAvailable()
Checks to see if Admin Node Manager is available or not.
|
Group |
updateGroup(Group group)
Update a group's name or tags.
|
Host |
updateHost(Host host)
Update a host in the topology.
|
Service |
updateService(java.lang.String groupID,
Service service)
Update a service's name, tags, management port, or scheme in the topology.
|
Service |
updateServiceByName(java.lang.String groupName,
Service service)
Update a service's name, tags, management port, or scheme in the topology.
|
Topology |
updateTopology(Topology topology,
boolean detectConflict,
boolean commit)
Aimed at internal use only.
|
public TopologyClient(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 TopologyClient(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 boolean isServerAvailable() throws com.vordel.api.nm.NodeManagerAPIException
com.vordel.api.nm.NodeManagerAPIException
public Topology getTopology() throws com.vordel.api.nm.NodeManagerAPIException
com.vordel.api.nm.NodeManagerAPIException
public com.vordel.security.cert.PersonalInfo getDomainCertificateInfo(java.lang.String passphrase) throws com.vordel.api.nm.NodeManagerAPIException
passphrase
- The passphrasecom.vordel.api.nm.NodeManagerAPIException
public Topology updateTopology(Topology topology, boolean detectConflict, boolean commit) throws com.vordel.api.nm.NodeManagerAPIException
topology
- The new topologydetectConflict
- If this flag is true the Node Manager should only accept
in-synch updates, i.e. if the current version is n, the new version must be n+1.commit
- Set to false if this is a pending update. Set to true
if the update should be committed. A commit=false is sent before a commit=true request.com.vordel.api.nm.NodeManagerAPIException
public Host createHost(Host host) throws com.vordel.api.nm.NodeManagerAPIException
host
- The host to createcom.vordel.api.nm.NodeManagerAPIException
public java.util.Collection<Host> getHosts() throws com.vordel.api.nm.NodeManagerAPIException
com.vordel.api.nm.NodeManagerAPIException
public Host getHostByName(java.lang.String hostName) throws com.vordel.api.nm.NodeManagerAPIException
hostName
- The topology hostnamecom.vordel.api.nm.NodeManagerAPIException
public Host getHost(java.lang.String hostID) throws com.vordel.api.nm.NodeManagerAPIException
hostID
- The host id, for example host-1
com.vordel.api.nm.NodeManagerAPIException
public Host updateHost(Host host) throws com.vordel.api.nm.NodeManagerAPIException
host
- The host with updated detailscom.vordel.api.nm.NodeManagerAPIException
public void deleteHostByName(java.lang.String hostName) throws com.vordel.api.nm.NodeManagerAPIException
hostName
- The topology name of the host to delete.com.vordel.api.nm.NodeManagerAPIException
public void deleteHost(java.lang.String hostID) throws com.vordel.api.nm.NodeManagerAPIException
hostID
- The id of the host to delete, for example host-1
.com.vordel.api.nm.NodeManagerAPIException
public Group createGroup(Group group) throws com.vordel.api.nm.NodeManagerAPIException
group
- The groupcom.vordel.api.nm.NodeManagerAPIException
public Group createGroupByName(java.lang.String groupName) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group to create.com.vordel.api.nm.NodeManagerAPIException
public java.util.Collection<Group> getGroups() throws com.vordel.api.nm.NodeManagerAPIException
com.vordel.api.nm.NodeManagerAPIException
public Group getGroupByName(java.lang.String groupName) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The group namecom.vordel.api.nm.NodeManagerAPIException
public Group getGroup(java.lang.String groupID) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The group id, for example group-2
com.vordel.api.nm.NodeManagerAPIException
public Group updateGroup(Group group) throws com.vordel.api.nm.NodeManagerAPIException
group
- The updated group.com.vordel.api.nm.NodeManagerAPIException
public void deleteGroupByName(java.lang.String groupName, boolean deleteDiskGroup) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group to deletedeleteDiskGroup
- If true the group related files are
removed off disk on all hosts that run API Servers in this group.com.vordel.api.nm.NodeManagerAPIException
public void deleteGroup(java.lang.String groupID, boolean deleteDiskGroup) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group to delete, for example group-2
.deleteDiskGroup
- If true the group related files are
removed off disk on all hosts that run API Servers in this group.com.vordel.api.nm.NodeManagerAPIException
public Service createServiceByName(java.lang.String hostName, java.lang.String groupName, int servicesPort, Service service) throws com.vordel.api.nm.NodeManagerAPIException
hostName
- The name of the host that the new API Server should run on.groupName
- The name of the group that the new API Server should run in.servicesPort
- The business services port of the new API Serverservice
- The details of the new API Server that will be held in the domain topologycom.vordel.api.nm.NodeManagerAPIException
public Service createServiceWithGroup(java.lang.String hostName, Group group, int servicesPort, Service service) throws com.vordel.api.nm.NodeManagerAPIException
hostName
- The name of the host that the new API Server should run on.group
- The existing group within which to place the new API ServerservicesPort
- The business services port of the new API Serverservice
- The details of the new API Server that will be held in the domain topologycom.vordel.api.nm.NodeManagerAPIException
public Service createService(java.lang.String groupID, int servicesPort, Service service) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group that the new API Server should run in.servicesPort
- The business services port of the new API Serverservice
- The details of the new API Server that will be held in the domain topologycom.vordel.api.nm.NodeManagerAPIException
public java.util.Collection<Service> getServicesByName(java.lang.String groupName) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the groupcom.vordel.api.nm.NodeManagerAPIException
public java.util.Collection<Service> getServices(java.lang.String groupID) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group, for example group-2
com.vordel.api.nm.NodeManagerAPIException
public Service getServiceByName(java.lang.String groupName, java.lang.String serviceName) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group the service resides in.serviceName
- The name of the service, i.e. API Server/Node Manager.com.vordel.api.nm.NodeManagerAPIException
public Service getService(java.lang.String groupID, java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group the service resides in, e.g. group-2
serviceID
- The name of the service, i.e. API Server/Node Manager, e.g. instance-1
com.vordel.api.nm.NodeManagerAPIException
public Service updateServiceByName(java.lang.String groupName, Service service) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group that the service resides inservice
- The name of the service to updatecom.vordel.api.nm.NodeManagerAPIException
public Service updateService(java.lang.String groupID, Service service) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group that the service resides in, e.g. group-2
service
- The id of the service to update, e.g. instance-1
com.vordel.api.nm.NodeManagerAPIException
public void deleteServiceByName(java.lang.String groupName, java.lang.String serviceName, boolean deleteDiskInstance) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- Name of the group the service to delete resides in.serviceName
- Name of service tio delete.deleteDiskInstance
- If true the disk files relating to the API Server are to be removed.com.vordel.api.nm.NodeManagerAPIException
public void deleteService(java.lang.String groupID, java.lang.String serviceID, boolean deleteDiskInstance) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- Id of the group the service to delete resides in, e.g. group-2
serviceID
- Id of service to delete, e.g. instance-1
deleteDiskInstance
- If true the disk files relating to the API Server are to be removed.com.vordel.api.nm.NodeManagerAPIException
public java.lang.String getHostID(java.lang.String hostName)
hostName
- The name of the hosthost-1
public java.lang.String getGroupID(java.lang.String groupName)
groupName
- The name of the groupgroup-1
public java.lang.String getServiceID(java.lang.String groupName, java.lang.String serviceName)
groupName
- The group nameserviceName
- The service nameinstance-1
, or nodemanager-1
public boolean getServiceStatusByName(java.lang.String groupName, java.lang.String serviceName) throws com.vordel.api.nm.NodeManagerAPIException
groupName
- The name of the group that the service runs withinserviceName
- The name of the servicecom.vordel.api.nm.NodeManagerAPIException
public boolean getServiceStatus(java.lang.String groupID, java.lang.String serviceID) throws com.vordel.api.nm.NodeManagerAPIException
groupID
- The id of the group that the service runs withinserviceID
- The id of the servicecom.vordel.api.nm.NodeManagerAPIException
This documentation and all its contents and graphics, copyright © 1999 - 2011 Vordel