com.vordel.api.topology.model

Class Topology

java.lang.Object

com.vordel.api.topology.model.Topology

All Implemented Interfaces:

java.lang.Cloneable

public class Topology
extends java.lang.Object
implements java.lang.Cloneable

This class represents the domain topology. It contains a list of Host objects, and a list of Group objects. A Group contains a list of Service objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Topology.EntityType Topology entity types.
static class	Topology.ServiceType Type of service.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_NODE_MANAGER_TAG

Constructor Summary

Constructors

Constructor and Description
Topology()

Method Summary

Modifier and Type	Method and Description
void	addGroup(Group group) Add a group to the topology.
void	addHost(Host host) Add a host to the topology.
java.lang.Object	clone()
boolean	doesServiceRunOnHost(java.lang.String hostID) Checks to see if any services are running on a host.
Topology	filteredTopology(java.util.List<Topology.ServiceType> serviceTypes) Get a filtered version of the topology that contains only services of a certain type.
java.lang.String	generateID(Topology.EntityType type) Generate a unique id for a topology entity, e.g host, service etc.
Group	getGroup(java.lang.String id) Get a group from the topology.
Group	getGroupByName(java.lang.String name) Get a group from the topology.
Group	getGroupForService(java.lang.String serviceID) Get the group for a service
java.util.List<java.lang.String>	getGroupIds()
java.util.Collection<Group>	getGroups() Get all the groups in the topology.
java.util.Collection<Group>	getGroups(Topology.ServiceType serviceType) Get all the groups in the topology that contain services of a certain type.
java.util.Collection<Group>	getGroupsByIds(java.util.List<java.lang.String> ids) Get all groups in the topology specified in a list of Service IDs
java.util.Collection<Group>	getGroupsForHost(java.lang.String hostID, Topology.ServiceType serviceType) For a host get the groups (of certain service type) that run on it.
Host	getHost(java.lang.String id) Get a host.
Host	getHostByName(java.lang.String name) Get a host.
java.util.List<java.lang.String>	getHostIds()
java.util.Collection<Host>	getHosts() Get all the hosts in the topology.
java.util.Collection<Host>	getHostsByIds(java.util.List<java.lang.String> ids) Get all hosts in the topology specified in a list of Service IDs
java.util.Set<java.lang.String>	getHostsForGroup(java.lang.String groupID) For a group, get the list of host ids on which the group runs.
java.lang.String	getId() Get the domain id.
java.lang.String	getProductVersion() Get the product version.
Service	getService(java.lang.String serviceID) Get a service.
Service	getService(Topology.ServiceType serviceType, java.lang.String tagname, java.lang.String tagvalue) Return first service of certain type with tag and value.
java.util.List<java.lang.String>	getServiceIds()
java.util.List<java.lang.String>	getServiceIds(Topology.ServiceType serviceType)
java.util.Collection<Service>	getServices() Get all services in the topology
java.util.Collection<Service>	getServices(Topology.ServiceType serviceType) Get all services in the topology of a certain type.
java.util.Collection<Service>	getServices(Topology.ServiceType serviceType, java.lang.String tagname, java.lang.String tagvalue) Return all services of certain type with tag and value.
java.util.Collection<Service>	getServicesByIds(java.util.List<java.lang.String> ids) Get all services in the topology specified in a list of Service IDs
java.util.Collection<Service>	getServicesOnHost(java.lang.String hostID) Get a list of all services of that run on a particular host.
java.util.Collection<Service>	getServicesOnHost(java.lang.String hostID, Topology.ServiceType serviceType) Get a list of services of a certain type that run on a particular host.
java.util.Collection<Service>	getServicesOnHostInGroup(java.lang.String hostID, java.lang.String groupID, Topology.ServiceType serviceType) Get a list of services in a group of a certain type that run on a particular host.
static Topology.ServiceType	getServiceType(java.lang.String serviceID)
long	getTimestamp() Get the time at which the topology was last updated.
com.vordel.api.topology.model.TopologyVersion	getTopologyVersion() Return a TopologyVersion object which has the topology version and timestamp
java.util.Map<Topology.EntityType,java.lang.Integer>	getUniqueIdCounters() Get current values for id counters.
int	getVersion() Get the version of the topology.
boolean	hasGroup(java.lang.String groupId) Returns true if a Group with the given ID is in the topology
boolean	isFips()
static boolean	isTaggedAsAdminNodeManager(Service service) Checks if the service is the Admin Node Manager.
java.util.List<Service>	nonLocalTaggedAdminNodeManagers() Get all Admin Node Manager excluding local Admin Node Manager (if it is Admin).
Service	portUsedBy(java.lang.String hostID, int port) On a host get the service that uses a certain port.
void	removeGroup(Group group) Remove a group from the topology.
void	removeHost(Host host) Delete a host from the topology.
void	removeHost(java.lang.String id) Remove a host from the topology.
void	reserveId(Topology.EntityType type, java.lang.String idStr) Called when upgrading topology as want to reuse the same ids in upgraded install.
void	setFips(boolean fips)
void	setGroups(java.util.Collection<Group> groups) Set the groups in the topology.
void	setHosts(java.util.Collection<Host> hosts) Set the hosts.
void	setId(java.lang.String id) Set the domain id.
void	setProductVersion(java.lang.String productVersion) Set the product version
void	setTimestamp(long timestamp) Set the time at which the topology was last updated.
void	setUniqueIdCounters(java.util.Map<Topology.EntityType,java.lang.Integer> uniqueIdCounters) Set current values for id counters.
void	setVersion(int version) Set the version of the topology.
java.util.List<Service>	taggedAdminNodeManagers() Get all the Admin Node Managers.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_NODE_MANAGER_TAG

public static final java.lang.String ADMIN_NODE_MANAGER_TAG

See Also:

Constant Field Values

Constructor Detail

Topology

public Topology()

Method Detail

getId

public java.lang.String getId()

Get the domain id. This is assigned when the Admin Node Manager is created.

Returns:

The domain id.

setId

public void setId(java.lang.String id)

Set the domain id.

Parameters:

id - The id

getVersion

public int getVersion()

Get the version of the topology. This is increased each time the topology is updated via the Topology API in the Node Manager.

Returns:

The version

getTopologyVersion

public com.vordel.api.topology.model.TopologyVersion getTopologyVersion()

Return a TopologyVersion object which has the topology version and timestamp

Returns:

The Topology version details

setVersion

public void setVersion(int version)

Set the version of the topology. This is increased each time the topology is updated via the Topology API in the Node Manager.

Parameters:

version - The version

getTimestamp

public long getTimestamp()

Get the time at which the topology was last updated.

Returns:

The timestamp

setTimestamp

public void setTimestamp(long timestamp)

Set the time at which the topology was last updated.

Parameters:

timestamp - The timestamp

getProductVersion

public java.lang.String getProductVersion()

Get the product version.

Returns:

The product version

setProductVersion

public void setProductVersion(java.lang.String productVersion)

Set the product version

Parameters:

productVersion - The product version

isFips

public boolean isFips()

setFips

public void setFips(boolean fips)

getHosts

public java.util.Collection<Host> getHosts()

Get all the hosts in the topology.

Returns:

List of all hosts

getHostsByIds

public java.util.Collection<Host> getHostsByIds(java.util.List<java.lang.String> ids)

Get all hosts in the topology specified in a list of Service IDs

Parameters:

ids - a List of Service IDs

Returns:

A Set of Host objects

setHosts

public void setHosts(java.util.Collection<Host> hosts)

Set the hosts.

Parameters:

hosts - List of hosts

addHost

public void addHost(Host host)

Add a host to the topology.

Parameters:

host - The host to add

removeHost

public void removeHost(Host host)

Delete a host from the topology.

Parameters:

host - The host to delete

getGroups

public java.util.Collection<Group> getGroups()

Get all the groups in the topology.

Returns:

A list of groups

getGroupsByIds

public java.util.Collection<Group> getGroupsByIds(java.util.List<java.lang.String> ids)

Get all groups in the topology specified in a list of Service IDs

Parameters:

ids - A List of Service IDs

Returns:

A Set of Group objects

setGroups

public void setGroups(java.util.Collection<Group> groups)

Set the groups in the topology.

Parameters:

groups - List of groups

getUniqueIdCounters

public java.util.Map<Topology.EntityType,java.lang.Integer> getUniqueIdCounters()

Get current values for id counters.

Returns:

Map of type to current id value

setUniqueIdCounters

public void setUniqueIdCounters(java.util.Map<Topology.EntityType,java.lang.Integer> uniqueIdCounters)

Set current values for id counters.

Parameters:

uniqueIdCounters - Map of managed entity type to current id value

addGroup

public void addGroup(Group group)

Add a group to the topology.

Parameters:

group - The group to add

removeGroup

public void removeGroup(Group group)

Remove a group from the topology.

Parameters:

group - The group to remove.

getGroup

public Group getGroup(java.lang.String id)

Get a group from the topology.

Parameters:

id - The id of the group.

Returns:

The group

getGroupByName

public Group getGroupByName(java.lang.String name)

Get a group from the topology.

Parameters:

name - The group name

Returns:

The group

getGroupForService

public Group getGroupForService(java.lang.String serviceID)

Get the group for a service

Parameters:

serviceID - The id of the service, e.g. instance-1

Returns:

The group

hasGroup

public boolean hasGroup(java.lang.String groupId)

Returns true if a Group with the given ID is in the topology

Parameters:

groupId - The ID of the Group to query.

Returns:

True if the Group exists, false otherwise.

getHost

public Host getHost(java.lang.String id)

Get a host.

Parameters:

id - The host id, e.g. host-1

Returns:

The host

getHostByName

public Host getHostByName(java.lang.String name)

Get a host.

Parameters:

name - The host name

Returns:

The host

removeHost

public void removeHost(java.lang.String id)

Remove a host from the topology.

Parameters:

id - The id of the host

portUsedBy

public Service portUsedBy(java.lang.String hostID,
                          int port)

On a host get the service that uses a certain port.

Parameters:

hostID - The id of the host

port - The port

Returns:

The service

getGroups

public java.util.Collection<Group> getGroups(Topology.ServiceType serviceType)

Get all the groups in the topology that contain services of a certain type.

Parameters:

serviceType - Set to gateway or nodemanager

Returns:

A list of groups

getServices

public java.util.Collection<Service> getServices(Topology.ServiceType serviceType)

Get all services in the topology of a certain type.

Parameters:

serviceType - Set to gateway or nodemanager

Returns:

List of services

getServices

public java.util.Collection<Service> getServices()

Get all services in the topology

Returns:

List of services

getServicesByIds

public java.util.Collection<Service> getServicesByIds(java.util.List<java.lang.String> ids)

Get all services in the topology specified in a list of Service IDs

Parameters:

ids - A List of service IDs

Returns:

A Set of Service objects

getService

public Service getService(java.lang.String serviceID)

Get a service.

Parameters:

serviceID - The id of the service, e.g. instance-1

Returns:

The service

getService

public Service getService(Topology.ServiceType serviceType,
                          java.lang.String tagname,
                          java.lang.String tagvalue)

Return first service of certain type with tag and value.

Parameters:

serviceType - Set to gateway or nodemanager

tagname - Tag name

tagvalue - Tag value

Returns:

A Service with the specified Tag details.

getServices

public java.util.Collection<Service> getServices(Topology.ServiceType serviceType,
                                                 java.lang.String tagname,
                                                 java.lang.String tagvalue)

Return all services of certain type with tag and value.

Parameters:

serviceType - Set to gateway or nodemanager

tagname - Tag name

tagvalue - Tag value

Returns:

All Services with the specified Tag details.

filteredTopology

public Topology filteredTopology(java.util.List<Topology.ServiceType> serviceTypes)

Get a filtered version of the topology that contains only services of a certain type.

Parameters:

serviceTypes - Set to gateway or nodemanager

Returns:

Filtered topology

getServicesOnHost

public java.util.Collection<Service> getServicesOnHost(java.lang.String hostID,
                                                       Topology.ServiceType serviceType)

Get a list of services of a certain type that run on a particular host.

Parameters:

hostID - The host id

serviceType - Set to gateway or nodemanager

Returns:

A list of services

getServicesOnHost

public java.util.Collection<Service> getServicesOnHost(java.lang.String hostID)

Get a list of all services of that run on a particular host.

Parameters:

hostID - The host id

Returns:

A list of services

getServicesOnHostInGroup

public java.util.Collection<Service> getServicesOnHostInGroup(java.lang.String hostID,
                                                              java.lang.String groupID,
                                                              Topology.ServiceType serviceType)

Get a list of services in a group of a certain type that run on a particular host.

Parameters:

hostID - The host id

groupID - The group id

serviceType - Set to gateway or nodemanager

Returns:

A list of services

doesServiceRunOnHost

public boolean doesServiceRunOnHost(java.lang.String hostID)

Checks to see if any services are running on a host.

Parameters:

hostID - The host

Returns:

True if 1 or more services are running on the host.

getHostsForGroup

public java.util.Set<java.lang.String> getHostsForGroup(java.lang.String groupID)

For a group, get the list of host ids on which the group runs.

Parameters:

groupID - The group id

Returns:

List of host ids

getGroupsForHost

public java.util.Collection<Group> getGroupsForHost(java.lang.String hostID,
                                                    Topology.ServiceType serviceType)

For a host get the groups (of certain service type) that run on it.

Parameters:

hostID - A specific Host.

serviceType - The type of service we are searching for.

Returns:

A Set of Groups for which the Host and ServiceType details match.

isTaggedAsAdminNodeManager

public static boolean isTaggedAsAdminNodeManager(Service service)

Checks if the service is the Admin Node Manager. Do not use this to determine if NM is allowed to do something. Need to use as a client, if you want to call an ANM and need to find out what is an ANM. This includes the server acting as a client.

Parameters:

service - The service to check

Returns:

True if service is the Admin Node Manager

taggedAdminNodeManagers

public java.util.List<Service> taggedAdminNodeManagers()

Get all the Admin Node Managers.

Returns:

List of Services that are the Admin Node Manager

nonLocalTaggedAdminNodeManagers

public java.util.List<Service> nonLocalTaggedAdminNodeManagers()

Get all Admin Node Manager excluding local Admin Node Manager (if it is Admin).

Returns:

A List of all remote Admin Node Managers, as Service detail objects.

generateID

public java.lang.String generateID(Topology.EntityType type)

Generate a unique id for a topology entity, e.g host, service etc.

Parameters:

type - The topology entity type

Returns:

The id

getServiceType

public static Topology.ServiceType getServiceType(java.lang.String serviceID)

reserveId

public void reserveId(Topology.EntityType type,
                      java.lang.String idStr)

Called when upgrading topology as want to reuse the same ids in upgraded install. If the current counter value is > value, then do nothing Otherwise set counter=value+1 to ensure that new instances after upgrade do not try to reuse the upgraded id value.

Parameters:

type - The id type

idStr - The id string e.g. host-1

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHostIds

public java.util.List<java.lang.String> getHostIds()

getServiceIds

public java.util.List<java.lang.String> getServiceIds()

getServiceIds

public java.util.List<java.lang.String> getServiceIds(Topology.ServiceType serviceType)

getGroupIds

public java.util.List<java.lang.String> getGroupIds()