Node Director
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
sfi.director.application.autodoc.ServiceDependency Class Reference

Service dependency abstraction. More...

Public Member Functions

 ServiceDependency (String spec)
String name ()
 Accessor for attribute name.
String name (String name)
 Mutator for attribute name.
String type ()
 Accessor for attribute type.
String type (String type)
 Mutator for attribute type.
String id ()
 return a unique id for this service/object, composed of the object type and name
String toString ()
Vector depends ()
 Accessor for attribute depends.
void depends (ServiceDependency dep)
 Add dependency.
void depends (Vector deps)
 Add dependencies.
Vector requires ()
 Accessor for attribute requires.
void requires (ServiceDependency dep)
 Add required dependency.
void requires (Vector deps)
 Add required dependencies.
Vector resides ()
 Accessor for attribute resides.
void resides (ServiceDependency dep)
 Add resides object.
Vector backRelated ()
 Accessor for attribute backRelated.
void backRelated (ServiceDependency dep)
 Mutator for attribute backRelated.
ServiceDepContainer serviceContainer ()
 Accessor for attribute serviceContainer.
ServiceDepContainer serviceContainer (ServiceDepContainer serviceContainer)
 Mutator for attribute serviceContainer.

Static Public Member Functions

static String spec2id (String spec)

Static Public Attributes

static final String TYPE_HOST = "host"
static final String TYPE_HOSTCLASS = "hostclass"
static final String TYPE_USER = "user"
static final String TYPE_USERCLASS = "personclass"
static final String TYPE_SERVICE = ""
static final String TYPE_REDUNDANT_NODE = "node"
static final String[] knownIds

Protected Member Functions

 ServiceDependency ()

Protected Attributes

String name = ""
 Name of this service/object.
String type = ""
 Type of this object: see TYPE_*.
Vector depends = new Vector()
 List of ServiceDependency objects this service depends on.
Vector requires = new Vector()
 List of ServiceDependency objects this service requires.
Vector resides = new Vector()
 List of ServiceDependency objects this service resides on.
Vector backRelated = new Vector()
 List of ServiceDependency that are "upwards" related to this object either via a dependends, requires or resides relation.
ServiceDepContainer serviceContainer = null
 the root service container

Detailed Description

Service dependency abstraction.

Constructor & Destructor Documentation

sfi.director.application.autodoc.ServiceDependency.ServiceDependency ( String  spec)

References sfi.director.application.autodoc.ServiceDependency.knownIds, sfi.director.application.autodoc.ServiceDependency.name(), sfi.director.application.autodoc.ServiceDependency.type(), sfi.director.application.autodoc.ServiceDependency.TYPE_REDUNDANT_NODE, and sfi.director.application.autodoc.ServiceDependency.TYPE_SERVICE.

sfi.director.application.autodoc.ServiceDependency.ServiceDependency ( )
protected

Referenced by sfi.director.application.autodoc.ServiceDependency.spec2id().

Member Function Documentation

Vector sfi.director.application.autodoc.ServiceDependency.backRelated ( )

Accessor for attribute backRelated.

List of ServiceDependency that are "upwards" related to this object either via a dependends, requires or resides relation.

Referenced by sfi.director.application.autodoc.ServiceDependency.backRelated().

void sfi.director.application.autodoc.ServiceDependency.backRelated ( ServiceDependency  dep)

Mutator for attribute backRelated.

List of ServiceDependency that are "upwards" related to this object either via a dependends, requires or resides relation.

References sfi.director.application.autodoc.ServiceDependency.backRelated().

Vector sfi.director.application.autodoc.ServiceDependency.depends ( )

Accessor for attribute depends.

List of ServiceDependency objects this service depends on.

Referenced by sfi.director.application.autodoc.ServiceDependency.depends().

void sfi.director.application.autodoc.ServiceDependency.depends ( ServiceDependency  dep)

Add dependency.

List of ServiceDependency objects this service depends on.

References sfi.director.application.autodoc.ServiceDependency.backRelated, and sfi.director.application.autodoc.ServiceDependency.depends().

void sfi.director.application.autodoc.ServiceDependency.depends ( Vector  deps)

Add dependencies.

List of ServiceDependency objects this service depends on.

References sfi.director.application.autodoc.ServiceDependency.depends().

String sfi.director.application.autodoc.ServiceDependency.id ( )

return a unique id for this service/object, composed of the object type and name

References sfi.director.application.autodoc.ServiceDependency.name(), and sfi.director.application.autodoc.ServiceDependency.type().

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.finish(), sfi.director.application.autodoc.ServiceDepContainer.registerService(), sfi.director.application.autodoc.ServiceDepContainer.serialize(), and sfi.director.application.autodoc.ServiceDepContainer.serviceBySpec().

String sfi.director.application.autodoc.ServiceDependency.name ( )

Accessor for attribute name.

Name of this service/object.

Referenced by sfi.director.application.autodoc.ServiceDependency.id(), sfi.director.application.autodoc.ServiceDependency.name(), and sfi.director.application.autodoc.ServiceDependency.ServiceDependency().

String sfi.director.application.autodoc.ServiceDependency.name ( String  name)

Mutator for attribute name.

Name of this service/object.

References sfi.director.application.autodoc.ServiceDependency.name().

Vector sfi.director.application.autodoc.ServiceDependency.requires ( )

Accessor for attribute requires.

List of ServiceDependency objects this service requires.

Referenced by sfi.director.application.autodoc.ServiceDependency.requires().

void sfi.director.application.autodoc.ServiceDependency.requires ( ServiceDependency  dep)

Add required dependency.

List of ServiceDependency objects this service requires.

References sfi.director.application.autodoc.ServiceDependency.backRelated, and sfi.director.application.autodoc.ServiceDependency.requires().

void sfi.director.application.autodoc.ServiceDependency.requires ( Vector  deps)

Add required dependencies.

List of ServiceDependency objects this service depends on.

References sfi.director.application.autodoc.ServiceDependency.requires().

Vector sfi.director.application.autodoc.ServiceDependency.resides ( )

Accessor for attribute resides.

List of ServiceDependency objects this service resides on.

Referenced by sfi.director.application.autodoc.ServiceDependency.resides().

void sfi.director.application.autodoc.ServiceDependency.resides ( ServiceDependency  dep)

Add resides object.

List of ServiceDependency objects this service resides on.

References sfi.director.application.autodoc.ServiceDependency.backRelated, and sfi.director.application.autodoc.ServiceDependency.resides().

ServiceDepContainer sfi.director.application.autodoc.ServiceDependency.serviceContainer ( )

Accessor for attribute serviceContainer.

the root service container

Referenced by sfi.director.application.autodoc.ServiceDependency.serviceContainer().

ServiceDepContainer sfi.director.application.autodoc.ServiceDependency.serviceContainer ( ServiceDepContainer  serviceContainer)

Mutator for attribute serviceContainer.

the root service container

References sfi.director.application.autodoc.ServiceDependency.serviceContainer().

static String sfi.director.application.autodoc.ServiceDependency.spec2id ( String  spec)
static

References sfi.director.application.autodoc.ServiceDependency.ServiceDependency().

Referenced by sfi.director.application.autodoc.ServiceDepContainer.getBySpec().

String sfi.director.application.autodoc.ServiceDependency.toString ( )
String sfi.director.application.autodoc.ServiceDependency.type ( )

Accessor for attribute type.

Type of this object: see TYPE_*.

Referenced by sfi.director.application.autodoc.ServiceDependency.id(), sfi.director.application.autodoc.ServiceDependency.ServiceDependency(), and sfi.director.application.autodoc.ServiceDependency.type().

String sfi.director.application.autodoc.ServiceDependency.type ( String  type)

Mutator for attribute type.

Type of this object: see TYPE_*.

References sfi.director.application.autodoc.ServiceDependency.type().

Member Data Documentation

Vector sfi.director.application.autodoc.ServiceDependency.backRelated = new Vector()
protected

List of ServiceDependency that are "upwards" related to this object either via a dependends, requires or resides relation.

Referenced by sfi.director.application.autodoc.ServiceDependency.depends(), sfi.director.application.autodoc.ServiceDepContainer.finish(), sfi.director.application.autodoc.ServiceDependency.requires(), and sfi.director.application.autodoc.ServiceDependency.resides().

Vector sfi.director.application.autodoc.ServiceDependency.depends = new Vector()
protected

List of ServiceDependency objects this service depends on.

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.finish(), sfi.director.application.autodoc.ServiceDepContainer.serialize(), and sfi.director.application.autodoc.ServiceDepContainer.serviceBySpec().

final String [] sfi.director.application.autodoc.ServiceDependency.knownIds
static
Initial value:
{ TYPE_HOST, TYPE_HOSTCLASS, TYPE_USER, TYPE_USERCLASS,
TYPE_SERVICE, TYPE_REDUNDANT_NODE }

Referenced by sfi.director.application.autodoc.ServiceDependency.ServiceDependency().

String sfi.director.application.autodoc.ServiceDependency.name = ""
protected

Name of this service/object.

Referenced by sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.deserialize(), sfi.director.application.autodoc.ServiceDepContainer.serialize(), and sfi.director.application.autodoc.ServiceDepContainer.serviceBySpec().

Vector sfi.director.application.autodoc.ServiceDependency.requires = new Vector()
protected

List of ServiceDependency objects this service requires.

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.finish(), and sfi.director.application.autodoc.ServiceDepContainer.serialize().

Vector sfi.director.application.autodoc.ServiceDependency.resides = new Vector()
protected

List of ServiceDependency objects this service resides on.

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.finish(), and sfi.director.application.autodoc.ServiceDepContainer.serialize().

ServiceDepContainer sfi.director.application.autodoc.ServiceDependency.serviceContainer = null
protected

the root service container

Referenced by sfi.director.application.autodoc.ServiceDepContainer.registerService().

String sfi.director.application.autodoc.ServiceDependency.type = ""
protected

Type of this object: see TYPE_*.

Referenced by sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.deserialize(), sfi.director.application.autodoc.ServiceDepContainer.serialize(), and sfi.director.application.autodoc.ServiceDepContainer.serviceBySpec().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_HOST = "host"
static

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.localId(), and sfi.director.application.autodoc.ClassOfObjects.memberType().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_HOSTCLASS = "hostclass"
static

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), and sfi.director.application.autodoc.DependencyGraph.localId().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_REDUNDANT_NODE = "node"
static

Referenced by sfi.director.application.autodoc.DependencyGraph.compute(), sfi.director.application.autodoc.ServiceDepContainer.serviceBySpec(), and sfi.director.application.autodoc.ServiceDependency.ServiceDependency().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_SERVICE = ""
static

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.compute(), and sfi.director.application.autodoc.ServiceDependency.ServiceDependency().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_USER = "user"
static

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), sfi.director.application.autodoc.DependencyGraph.localId(), and sfi.director.application.autodoc.ClassOfObjects.memberType().

final String sfi.director.application.autodoc.ServiceDependency.TYPE_USERCLASS = "personclass"
static

Referenced by sfi.director.application.autodoc.ServiceDepContainer.addDependencies(), and sfi.director.application.autodoc.DependencyGraph.localId().

The documentation for this class was generated from the following file:
Generated on Sat Feb 4 2023 01:19:58 for Node Director by   doxygen 1.8.1.2