com.vordel.api.topology.model

Class Group

java.lang.Object

com.vordel.api.topology.model.Group

All Implemented Interfaces:

com.vordel.api.topology.model.TopologyElement, java.lang.Cloneable, java.lang.Comparable<Group>

public class Group
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<Group>, com.vordel.api.topology.model.TopologyElement

This class represents a group in the domain topology. A group contains a list of Service objects which represents API Servers or Node Manager. A group can only contain services of a single type i.e. API Server (gateway) or Node Manager (nodemanager). Each group has a unique id within the topology assigned by the Node Manager when it is created, e.g. group-1.

Constructor Summary

Constructors

Constructor and Description
Group() Default constructor.
Group(java.lang.String name) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addService(Service service) Add a service to the group.
void	addTag(java.lang.String key, java.lang.String value) Add a tag for the group.
java.lang.Object	clone()
int	compareTo(Group o)
void	deleteLockForUser(java.lang.String userID)
boolean	equals(java.lang.Object other)
java.util.Set<java.lang.String>	getHostIds() Get a list of host ids on which this group runs.
java.lang.String	getId() Get the id of the group, for example group-2.
com.vordel.api.topology.model.Lock	getLock() Get the Lock of this Group.
java.lang.String	getName() Get the group name.
Service	getService(java.lang.String id) Get a service from the group.
Service	getServiceByName(java.lang.String name) Get a service from the group.
java.util.Collection<Service>	getServices() Get all the services in the group.
java.util.Collection<Service>	getServicesByType(Topology.ServiceType serviceType) Get a list services of a certain type from the group.
java.util.Collection<Service>	getServicesOfOtherType(Topology.ServiceType serviceType) Get a list services not of a certain type from the group.
java.util.Collection<Service>	getServicesOnHost(java.lang.String hostID) Get list of services running on a certain host from the group.
java.util.Collection<Service>	getServicesOnHost(java.lang.String hostID, Topology.ServiceType serviceType) Get list of services of a certain type running on a certain host from the group.
java.util.Map<java.lang.String,java.lang.String>	getTags() Get the tags for the group.
int	hashCode()
void	removeService(java.lang.String id) Delete a service from the group.
<T extends com.vordel.api.topology.model.TopologyElement> boolean	same(T e)
void	setId(java.lang.String id) Set the group id
void	setLock(com.vordel.api.topology.model.Lock lock) Set a Lock on this Group
void	setName(java.lang.String name) Set the name of the group.
void	setServices(java.util.Collection<Service> services) Set the list of services in the gorup.
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) Set the tags for the group
boolean	valid()
boolean	valid(boolean validateServices) Is this a valid group.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Group

public Group()

Default constructor.

Group

public Group(java.lang.String name)

Constructor.

Parameters:

name - The name of the group.

Method Detail

getId

public java.lang.String getId()

Get the id of the group, for example group-2.

Specified by:

getId in interface com.vordel.api.topology.model.TopologyElement

Returns:

The group id

setId

public void setId(java.lang.String id)

Set the group id

Parameters:

id - The group id

getName

public java.lang.String getName()

Get the group name.

Specified by:

getName in interface com.vordel.api.topology.model.TopologyElement

Returns:

The name of the group

setName

public void setName(java.lang.String name)

Set the name of the group.

Parameters:

name - The group name

setLock

public void setLock(com.vordel.api.topology.model.Lock lock)

Set a Lock on this Group

getLock

public com.vordel.api.topology.model.Lock getLock()

Get the Lock of this Group.

Returns:

A lock or null if the Group isn't locked.

getServices

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

Get all the services in the group.

Returns:

The list of services in the group.

setServices

public void setServices(java.util.Collection<Service> services)

Set the list of services in the gorup.

Parameters:

services - The list of services

getTags

public java.util.Map<java.lang.String,java.lang.String> getTags()

Get the tags for the group.

Returns:

The map of tags

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

Set the tags for the group

Parameters:

tags - Map of tags

addTag

public void addTag(java.lang.String key,
          java.lang.String value)

Add a tag for the group.

Parameters:

key - Tag key

value - Tag value

addService

public void addService(Service service)

Add a service to the group.

Parameters:

service - The service to add

getServiceByName

public Service getServiceByName(java.lang.String name)

Get a service from the group.

Parameters:

name - The name of the service

Returns:

The service

getService

public Service getService(java.lang.String id)

Get a service from the group.

Parameters:

id - The id of the service

Returns:

The service

removeService

public void removeService(java.lang.String id)

Delete a service from the group.

Parameters:

id - The service id

getServicesByType

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

Get a list services of a certain type from the group. Note that a group can only contain services of one type.

Parameters:

serviceType - Set to gateway or nodemanager

Returns:

The list of services

getServicesOfOtherType

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

Get a list services not of a certain type from the group. Note that a group can only contain services of one type.

Parameters:

serviceType - Set to gateway or nodemanager

Returns:

The list of services

getServicesOnHost

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

Get list of services of a certain type running on a certain host from the group.

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 list of services running on a certain host from the group.

Parameters:

hostID - The host id

Returns:

A list of services

getHostIds

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

Get a list of host ids on which this group runs.

Returns:

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

valid

public boolean valid()

valid

public boolean valid(boolean validateServices)

Is this a valid group.

Parameters:

validateServices - True if sevrices should be validated

Returns:

True if valid

compareTo

public int compareTo(Group o)

Specified by:

compareTo in interface java.lang.Comparable<Group>

deleteLockForUser

public void deleteLockForUser(java.lang.String userID)

same

public <T extends com.vordel.api.topology.model.TopologyElement> boolean same(T e)

Specified by:

same in interface com.vordel.api.topology.model.TopologyElement