com.vordel.api.topology.client

Class TopologyClient

java.lang.Object

com.vordel.api.nm.NodeManagerClient

com.vordel.api.topology.client.TopologyClient

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

Topology REST API Java client helper class. It invokes the Node Manager Topology REST API. The Topology API is exposed by the Node Manager in order to manage the domain topology, i.e. groups of API Servers. Refer to REST API documentation for more information on the Topology API.

Field Summary

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

debug

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	createCSR(java.lang.String groupID, int servicesPort, java.lang.String signAlg, java.lang.String keyPassphrase, Service service)
java.lang.String[]	createCSRByName(java.lang.String hostName, java.lang.String groupName, int servicesPort, java.lang.String signAlg, java.lang.String keyPassphrase, Service service)
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, java.lang.String[] certificates, java.lang.String passphrase, java.lang.String keyPassphrase)
Service	createService(java.lang.String groupID, int servicesPort, Service service, java.lang.String signAlg, java.lang.String domainPassphrase) 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, java.lang.String[] certificates, java.lang.String passphrase, java.lang.String keyPassphrase)
Service	createServiceByName(java.lang.String hostName, java.lang.String groupName, int servicesPort, Service service, java.lang.String signAlg, java.lang.String domainPassphrase) 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, java.lang.String[] certificates, java.lang.String passphrase, java.lang.String keyPassphrase) 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.
void	forceUnlockGroup(java.lang.String groupID)
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.
java.lang.String	getNextTopologyId(Topology.EntityType type)
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.
com.vordel.api.topology.model.TopologyVersion	getTopologyVersion() Get the Topology version
boolean	isServerAvailable() Checks to see if Admin Node Manager is available or not.
void	lockGroup(java.lang.String groupID)
Topology	mergeTopology(Topology hostTopology)
java.lang.String[]	signCSR(java.lang.String csr, java.lang.String signCertAlg, java.lang.String domainPassphrase)
void	unlockGroup(java.lang.String groupID, java.lang.String username)
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.
Topology	updateTopology(Topology topology, boolean detectConflict, boolean commit, boolean propagateTopology) Allow topology updates to an Admin NM without the Admin NM propagating the toplogy change to other NMs in the domain.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologyClient

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

Throws:

com.vordel.api.nm.NodeManagerAPIException

Method Detail

isServerAvailable

public boolean isServerAvailable()
                          throws com.vordel.api.nm.NodeManagerAPIException

Checks to see if Admin Node Manager is available or not.

Returns:

True if Admin Node Manager is available.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getTopology

public Topology getTopology()
                     throws com.vordel.api.nm.NodeManagerAPIException

Get the full domain topology.

Returns:

The Topology

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateTopology

public Topology updateTopology(Topology topology,
                      boolean detectConflict,
                      boolean commit)
                        throws com.vordel.api.nm.NodeManagerAPIException

Aimed at internal use only. This method will overwrite the current topology with a new topology. The equivalent server-side method is invoked internally by one Node Manager on all others when a topology update needs to be propagated to all Node Managers. The Node Manager that is pushing the topology change out to all other Node Managers will firstly invoke this method with commit=false and detectConflict=true. A commit is now pending (subject to a timeout) in all Node Managers. If all Node Managers return successfully, the same controlling Node Manager will call this method again with commit=true and detectConflict=true. The Node Managers that receive this call will then commit the topology changes. While a commit is pending, a Node Manager cannot process any other updates. In a client application this method could be used to push a topology out to all Node Managers.

Parameters:

topology - The new topology

detectConflict - 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.

Returns:

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateTopology

public Topology updateTopology(Topology topology,
                      boolean detectConflict,
                      boolean commit,
                      boolean propagateTopology)
                        throws com.vordel.api.nm.NodeManagerAPIException

Allow topology updates to an Admin NM without the Admin NM propagating the toplogy change to other NMs in the domain.

Throws:

com.vordel.api.nm.NodeManagerAPIException

createHost

public Host createHost(Host host)
                throws com.vordel.api.nm.NodeManagerAPIException

Create a host in the topology.

Parameters:

host - The host to create

Returns:

The created host

Throws:

com.vordel.api.nm.NodeManagerAPIException

getHosts

public java.util.Collection<Host> getHosts()
                                    throws com.vordel.api.nm.NodeManagerAPIException

Get all hosts in the topology.

Returns:

A list of all hosts in the topology

Throws:

com.vordel.api.nm.NodeManagerAPIException

getHostByName

public Host getHostByName(java.lang.String hostName)
                   throws com.vordel.api.nm.NodeManagerAPIException

Get a host from the topology.

Parameters:

hostName - The topology hostname

Returns:

The host

Throws:

com.vordel.api.nm.NodeManagerAPIException

getHost

public Host getHost(java.lang.String hostID)
             throws com.vordel.api.nm.NodeManagerAPIException

Get a host from the topology.

Parameters:

hostID - The host id, for example host-1

Returns:

The host

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateHost

public Host updateHost(Host host)
                throws com.vordel.api.nm.NodeManagerAPIException

Update a host in the topology.

Parameters:

host - The host with updated details

Returns:

The updated host

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteHostByName

public void deleteHostByName(java.lang.String hostName)
                      throws com.vordel.api.nm.NodeManagerAPIException

Delete a host from the topology.

Parameters:

hostName - The topology name of the host to delete.

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteHost

public void deleteHost(java.lang.String hostID)
                throws com.vordel.api.nm.NodeManagerAPIException

Delete a host from the topology.

Parameters:

hostID - The id of the host to delete, for example host-1.

Throws:

com.vordel.api.nm.NodeManagerAPIException

createGroup

public Group createGroup(Group group)
                  throws com.vordel.api.nm.NodeManagerAPIException

Create an empty group in the topology. Services cannot be added via this method.

Parameters:

group - The group

Returns:

The newly created group.

Throws:

com.vordel.api.nm.NodeManagerAPIException

createGroupByName

public Group createGroupByName(java.lang.String groupName)
                        throws com.vordel.api.nm.NodeManagerAPIException

Create an empty group in the topology. Services cannot be added via this method.

Parameters:

groupName - The name of the group to create.

Returns:

Throws:

com.vordel.api.nm.NodeManagerAPIException

getGroups

public java.util.Collection<Group> getGroups()
                                      throws com.vordel.api.nm.NodeManagerAPIException

Get all groups in the topology.

Returns:

A list of groups.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getGroupByName

public Group getGroupByName(java.lang.String groupName)
                     throws com.vordel.api.nm.NodeManagerAPIException

Get a group from the topology.

Parameters:

groupName - The group name

Returns:

The group

Throws:

com.vordel.api.nm.NodeManagerAPIException

getGroup

public Group getGroup(java.lang.String groupID)
               throws com.vordel.api.nm.NodeManagerAPIException

Get a group from the topology.

Parameters:

groupID - The group id, for example group-2

Returns:

The group

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateGroup

public Group updateGroup(Group group)
                  throws com.vordel.api.nm.NodeManagerAPIException

Update a group's name or tags. A group's services cannot be updated via this method.

Parameters:

group - The updated group.

Returns:

The updated gorup.

Throws:

com.vordel.api.nm.NodeManagerAPIException

lockGroup

public void lockGroup(java.lang.String groupID)
               throws com.vordel.api.nm.NodeManagerAPIException

Throws:

com.vordel.api.nm.NodeManagerAPIException

unlockGroup

public void unlockGroup(java.lang.String groupID,
               java.lang.String username)
                 throws com.vordel.api.nm.NodeManagerAPIException

Throws:

com.vordel.api.nm.NodeManagerAPIException

forceUnlockGroup

public void forceUnlockGroup(java.lang.String groupID)
                      throws com.vordel.api.nm.NodeManagerAPIException

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteGroupByName

public void deleteGroupByName(java.lang.String groupName,
                     boolean deleteDiskGroup)
                       throws com.vordel.api.nm.NodeManagerAPIException

Delete a group from the topology.

Parameters:

groupName - The name of the group to delete

deleteDiskGroup - If true the group related files are removed off disk on all hosts that run API Servers in this group.

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteGroup

public void deleteGroup(java.lang.String groupID,
               boolean deleteDiskGroup)
                 throws com.vordel.api.nm.NodeManagerAPIException

Delete a group from the topology.

Parameters:

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.

Throws:

com.vordel.api.nm.NodeManagerAPIException

createServiceByName

public Service createServiceByName(java.lang.String hostName,
                          java.lang.String groupName,
                          int servicesPort,
                          Service service,
                          java.lang.String signAlg,
                          java.lang.String domainPassphrase)
                            throws com.vordel.api.nm.NodeManagerAPIException

Create a new service, meaning API Server (or Node Manager) in the the domain topology. If a group of groupName does not exist, it is created.

Parameters:

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 Server

service - The details of the new API Server that will be held in the domain topology

Returns:

The newly created service

Throws:

com.vordel.api.nm.NodeManagerAPIException

createServiceByName

public Service createServiceByName(java.lang.String hostName,
                          java.lang.String groupName,
                          int servicesPort,
                          Service service,
                          java.lang.String[] certificates,
                          java.lang.String passphrase,
                          java.lang.String keyPassphrase)
                            throws com.vordel.api.nm.NodeManagerAPIException

Parameters:

hostName -

groupName -

servicesPort -

service -

certificates -

passphrase - The entity store passphrase. Passed here if is set to (prompt) so that certs.xml is properly encrypted.

keyPassphrase - The passphrase used to encrypt temporary key files

Returns:

Throws:

com.vordel.api.nm.NodeManagerAPIException

createServiceWithGroup

public Service createServiceWithGroup(java.lang.String hostName,
                             Group group,
                             int servicesPort,
                             Service service,
                             java.lang.String[] certificates,
                             java.lang.String passphrase,
                             java.lang.String keyPassphrase)
                               throws com.vordel.api.nm.NodeManagerAPIException

Create a new service, meaning API Server (or Node Manager) in the the domain topology within a given group.

Parameters:

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 Server

servicesPort - The business services port of the new API Server

service - The details of the new API Server that will be held in the domain topology

Returns:

The newly created service

Throws:

com.vordel.api.nm.NodeManagerAPIException

createService

public Service createService(java.lang.String groupID,
                    int servicesPort,
                    Service service,
                    java.lang.String signAlg,
                    java.lang.String domainPassphrase)
                      throws com.vordel.api.nm.NodeManagerAPIException

Create a new service, meaning API Server (or Node Manager) in the the domain topology.

Parameters:

groupID - The id of the group that the new API Server should run in.

servicesPort - The business services port of the new API Server

service - The details of the new API Server that will be held in the domain topology

Returns:

The newly created service

Throws:

com.vordel.api.nm.NodeManagerAPIException

createService

public Service createService(java.lang.String groupID,
                    int servicesPort,
                    Service service,
                    java.lang.String[] certificates,
                    java.lang.String passphrase,
                    java.lang.String keyPassphrase)
                      throws com.vordel.api.nm.NodeManagerAPIException

Parameters:

groupID -

servicesPort -

service -

certificates -

passphrase - The entity store passphrase. Passed here if is set to (prompt) so that certs.xml is properly encrypted.

Returns:

Throws:

com.vordel.api.nm.NodeManagerAPIException

getServicesByName

public java.util.Collection<Service> getServicesByName(java.lang.String groupName)
                                                throws com.vordel.api.nm.NodeManagerAPIException

Get all services in a group from the topology.

Parameters:

groupName - The name of the group

Returns:

A list of services in the group.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getServices

public java.util.Collection<Service> getServices(java.lang.String groupID)
                                          throws com.vordel.api.nm.NodeManagerAPIException

Get all services in a group from the topology.

Parameters:

groupID - The id of the group, for example group-2

Returns:

A list of services in the group.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getServiceByName

public Service getServiceByName(java.lang.String groupName,
                       java.lang.String serviceName)
                         throws com.vordel.api.nm.NodeManagerAPIException

Get a service from the topology.

Parameters:

groupName - The name of the group the service resides in.

serviceName - The name of the service, i.e. API Server/Node Manager.

Returns:

The service

Throws:

com.vordel.api.nm.NodeManagerAPIException

getService

public Service getService(java.lang.String groupID,
                 java.lang.String serviceID)
                   throws com.vordel.api.nm.NodeManagerAPIException

Get a service from the topology.

Parameters:

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

Returns:

The service

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateServiceByName

public Service updateServiceByName(java.lang.String groupName,
                          Service service)
                            throws com.vordel.api.nm.NodeManagerAPIException

Update a service's name, tags, management port, or scheme in the topology.

Parameters:

groupName - The name of the group that the service resides in

service - The name of the service to update

Returns:

The updated service

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateService

public Service updateService(java.lang.String groupID,
                    Service service)
                      throws com.vordel.api.nm.NodeManagerAPIException

Update a service's name, tags, management port, or scheme in the topology.

Parameters:

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

Returns:

The updated service

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteServiceByName

public void deleteServiceByName(java.lang.String groupName,
                       java.lang.String serviceName,
                       boolean deleteDiskInstance)
                         throws com.vordel.api.nm.NodeManagerAPIException

Delete a service (API Server or Node Manager) from the topology.

Parameters:

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.

Throws:

com.vordel.api.nm.NodeManagerAPIException

deleteService

public void deleteService(java.lang.String groupID,
                 java.lang.String serviceID,
                 boolean deleteDiskInstance)
                   throws com.vordel.api.nm.NodeManagerAPIException

Delete a service (API Server or Node Manager) from the topology.

Parameters:

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.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getHostID

public java.lang.String getHostID(java.lang.String hostName)

Get the topology id of a host.

Parameters:

hostName - The name of the host

Returns:

The host id, e.g. host-1

getGroupID

public java.lang.String getGroupID(java.lang.String groupName)

Get the topology id of a group.

Parameters:

groupName - The name of the group

Returns:

The host id, e.g. group-1

getServiceID

public java.lang.String getServiceID(java.lang.String groupName,
                            java.lang.String serviceName)

Get the topology id of a service, i.e. API Server or Node Manager.

Parameters:

groupName - The group name

serviceName - The service name

Returns:

The service id, e.g. instance-1, or nodemanager-1

getServiceStatusByName

public boolean getServiceStatusByName(java.lang.String groupName,
                             java.lang.String serviceName)
                               throws com.vordel.api.nm.NodeManagerAPIException

Get the status of a service (API Server/Node Manager).

Parameters:

groupName - The name of the group that the service runs within

serviceName - The name of the service

Returns:

True of service is running

Throws:

com.vordel.api.nm.NodeManagerAPIException

getServiceStatus

public boolean getServiceStatus(java.lang.String groupID,
                       java.lang.String serviceID)
                         throws com.vordel.api.nm.NodeManagerAPIException

Get the status of a service (API Server/Node Manager).

Parameters:

groupID - The id of the group that the service runs within

serviceID - The id of the service

Returns:

True of service is running

Throws:

com.vordel.api.nm.NodeManagerAPIException

createCSRByName

public java.lang.String[] createCSRByName(java.lang.String hostName,
                                 java.lang.String groupName,
                                 int servicesPort,
                                 java.lang.String signAlg,
                                 java.lang.String keyPassphrase,
                                 Service service)
                                   throws com.vordel.api.nm.NodeManagerAPIException

Parameters:

hostName -

groupName -

servicesPort -

signAlg -

service -

Returns:

An array where first entry is the CSR, second entry is the topology id of the new API Gateway

Throws:

com.vordel.api.nm.NodeManagerAPIException

createCSR

public java.lang.String[] createCSR(java.lang.String groupID,
                           int servicesPort,
                           java.lang.String signAlg,
                           java.lang.String keyPassphrase,
                           Service service)
                             throws com.vordel.api.nm.NodeManagerAPIException

Parameters:

groupID -

servicesPort -

signAlg -

service -

Returns:

An array where first entry is the CSR, second entry is the topology id of the new API Gateway

Throws:

com.vordel.api.nm.NodeManagerAPIException

signCSR

public java.lang.String[] signCSR(java.lang.String csr,
                         java.lang.String signCertAlg,
                         java.lang.String domainPassphrase)
                           throws com.vordel.api.nm.NodeManagerAPIException

Parameters:

csr -

signCertAlg -

Returns:

An array of certificates, the first certificate is the API Gateway certificate, the next the one that signed it. Normally 2 certificates is the full chain.

Throws:

com.vordel.api.nm.NodeManagerAPIException

getNextTopologyId

public java.lang.String getNextTopologyId(Topology.EntityType type)
                                   throws com.vordel.api.nm.NodeManagerAPIException

Throws:

com.vordel.api.nm.NodeManagerAPIException

getTopologyVersion

public com.vordel.api.topology.model.TopologyVersion getTopologyVersion()
                                                                 throws com.vordel.api.nm.NodeManagerAPIException

Get the Topology version

Returns:

An ApiResponse containing the topology version as the result on a successful operation with a HTTP status of 200 OK, otherwise an ApiResponse containing an ApiError.

Throws:

com.vordel.api.nm.NodeManagerAPIException

mergeTopology

public Topology mergeTopology(Topology hostTopology)
                       throws com.vordel.api.nm.NodeManagerAPIException

Throws:

com.vordel.api.nm.NodeManagerAPIException