com.vordel.api.topology.model

Class Service

java.lang.Object

com.vordel.api.topology.model.Service

All Implemented Interfaces:

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

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

This class represents a service (API Server or Node Manager) in the domain topology. Each service has a unique id within the topology assigned by the Node Manager when it is created, e.g. instance-1 for an API Server, and nodemanager-1 for a Node Manager.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled Enabled falg.
protected java.lang.String	hostID The id of the host that the service runs on.
protected java.lang.String	id The unique id of the service.
protected int	managementPort The port that this services receives management requests on.
protected java.lang.String	name The name of the service.
protected java.lang.String	scheme The scheme of the service for management request, "http" or "https".
protected java.util.Map<java.lang.String,java.lang.String>	tags Name-value pair tags.
protected Topology.ServiceType	type The service type.

Constructor Summary

Constructors

Constructor and Description
Service() Default constructor.
Service(java.lang.String name, java.lang.String scheme, int managementPort, java.util.HashMap<java.lang.String,java.lang.String> tags, boolean enabled) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTag(java.lang.String key, java.lang.String value) Add a tag.
java.lang.Object	clone()
int	compareTo(Service s)
boolean	equals(java.lang.Object other)
boolean	getEnabled() Get the enabled flag.
java.lang.String	getHostID() Get the id of the host that the service runs on.
java.lang.String	getId() Get the service id.
int	getManagementPort() Get the management port for the service
java.lang.String	getName() Get the service name
java.lang.String	getScheme() Get the service scheme.
java.util.Map<java.lang.String,java.lang.String>	getTags() Get the service's tags
Topology.ServiceType	getType() Get the type of the service.
int	hashCode()
<T extends com.vordel.api.topology.model.TopologyElement> boolean	same(T e)
boolean	sameService(Service s) Compares fields of service and returns true on difference
void	setEnabled(boolean enabled) Set the enabled flag.
void	setHostID(java.lang.String hostID) Set the id of the host that the service runs on.
void	setId(java.lang.String id) Set the service id.
void	setManagementPort(int managementPort) Set the management port.
void	setName(java.lang.String name) Set the service name
void	setScheme(java.lang.String scheme) Set the service scheme.
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) Set the service tags.
void	setType(Topology.ServiceType type) Set the type of a service.
boolean	valid() Check validity of service.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected java.lang.String id

The unique id of the service.

name

protected java.lang.String name

The name of the service.

scheme

protected java.lang.String scheme

The scheme of the service for management request, "http" or "https".

hostID

protected java.lang.String hostID

The id of the host that the service runs on.

managementPort

protected int managementPort

The port that this services receives management requests on.

tags

protected java.util.Map<java.lang.String,java.lang.String> tags

Name-value pair tags.

type

protected Topology.ServiceType type

The service type.

enabled

protected boolean enabled

Enabled falg.

Constructor Detail

Service

public Service()

Default constructor.

Service

public Service(java.lang.String name,
       java.lang.String scheme,
       int managementPort,
       java.util.HashMap<java.lang.String,java.lang.String> tags,
       boolean enabled)

Constructor.

Parameters:

name - The name of the service

scheme - The scheme of the service for management requests i.e. http or https.

managementPort - The management port

tags - Tags

enabled - Enabled flag

Method Detail

getId

public java.lang.String getId()

Get the service id.

Specified by:

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

Returns:

The id

setId

public void setId(java.lang.String id)

Set the service id.

Parameters:

id - The id

getName

public java.lang.String getName()

Get the service name

Specified by:

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

Returns:

The name

setName

public void setName(java.lang.String name)

Set the service name

Parameters:

name - The name

getScheme

public java.lang.String getScheme()

Get the service scheme.

Returns:

The scheme

setScheme

public void setScheme(java.lang.String scheme)

Set the service scheme.

Parameters:

scheme - The scheme

getHostID

public java.lang.String getHostID()

Get the id of the host that the service runs on.

Returns:

The host id, e.g. host-1

setHostID

public void setHostID(java.lang.String hostID)

Set the id of the host that the service runs on.

Parameters:

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

getManagementPort

public int getManagementPort()

Get the management port for the service

Returns:

The port

setManagementPort

public void setManagementPort(int managementPort)

Set the management port.

Parameters:

managementPort - The port

getTags

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

Get the service's tags

Returns:

Map of tags

setTags

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

Set the service tags.

Parameters:

tags - Map of tags

addTag

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

Add a tag.

Parameters:

key - Tag name

value - Tag value

getType

public Topology.ServiceType getType()

Get the type of the service.

Returns:

The type, i.e. gateway or nodemanager

setType

public void setType(Topology.ServiceType type)

Set the type of a service.

Parameters:

type - The type, i.e. gateway or nodemanager

getEnabled

public boolean getEnabled()

Get the enabled flag.

Returns:

True if enabled

setEnabled

public void setEnabled(boolean enabled)

Set the enabled flag.

Parameters:

enabled - True if enabled

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()

Check validity of service.

Returns:

True if valid

compareTo

public int compareTo(Service s)

Specified by:

compareTo in interface java.lang.Comparable<Service>

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

sameService

public boolean sameService(Service s)

Compares fields of service and returns true on difference