kaos.domain.management
Interface DomainDirectoryService

All Known Subinterfaces:

DirectoryService

All Known Implementing Classes:

CorbaAgentDirectoryServiceProxy, CougaarAgentDirectoryServiceProxy, DirectoryServiceProxy, GridAgentDirectoryServiceProxy, GridDirectoryServicePolicyCert, KAoSAgentDirectoryServiceProxy, KAoSDirectoryService, TCPAgentDirectoryServiceProxy, TunnelClient

public interface DomainDirectoryService

Defines the operations that can be invoked on a public domain directory service.

Version:

1.0 $Revision: 1.13 $

Author:

KAoS Team

Method Summary

java.util.List<AgentDescription>	getAllAgentsInDirectory() Get a Vector of descriptions of all agents in the directory.
java.util.List<AgentDescription>	getAllAgentsInDomain(java.lang.String domainName) Get a Vector of descriptions of all of the agents in a domain.
java.util.List<DomainDescription>	getAllDomainsInDirectory() Get a Vector of descriptions of all of the domains in a directory.
java.util.List<DomainDescription>	getAllGuardsInDirectory() Get a Vector of descriptions of all guards in the directory.
DomainDescription	getDomainDescription(java.lang.String domainName) Get the description of a domain
java.util.List<DomainDescription>	getDomainDescriptionsForGuard(java.lang.String guardGUID) Obtain a List containing DomainDescriptions of all domains the guard, whose GUID is specified, registered in.
java.util.Map	getDomainStructure(java.lang.String domainName) Obtain a Map containing the structure of a domain.
java.util.List<java.lang.String>	getRootDomains() Obtain a Vector of the names of the root domains (domains with no parent)
java.util.List<java.lang.String>	getSubdomains(java.lang.String domainName) Obtain a Vector of the names of subdomains of a particular domain (returns immediate children only)
boolean	isEntityInDomain(java.lang.String domainName, java.lang.String id) Search for the domain entity with the specified id.
void	removeExecEnv(java.lang.String execEnvID) Remove ExecutionEnvironment with the specified ID from the domain structure.

Method Detail

isEntityInDomain

boolean isEntityInDomain(java.lang.String domainName,
                         java.lang.String id)
                         throws DirectoryFailure

Search for the domain entity with the specified id.

Parameters:

domainName - The name of the domain to query

id - The id of an entity to be searched in this domain's directory.

Returns:

true if the entity whose id is specified is found; otherwise return false.

Throws:

java.lang.NullPointerException - if the id is null.

DirectoryFailure

getAllAgentsInDirectory

java.util.List<AgentDescription> getAllAgentsInDirectory()
                                                         throws DirectoryFailure

Get a Vector of descriptions of all agents in the directory.

Returns:

Vector of AgentDescriptions of all agents in the directory.

Throws:

DirectoryFailure

getAllAgentsInDomain

java.util.List<AgentDescription> getAllAgentsInDomain(java.lang.String domainName)
                                                      throws DirectoryFailure

Get a Vector of descriptions of all of the agents in a domain.

Parameters:

domainName - Name of the domain to query

Returns:

Vector of AgentDescriptions of all agents in the specified domain.

Throws:

DirectoryFailure

getAllDomainsInDirectory

java.util.List<DomainDescription> getAllDomainsInDirectory()
                                                           throws DirectoryFailure

Get a Vector of descriptions of all of the domains in a directory.

Returns:

Vector of AgentDescriptions of all agents in the specified domain.

Throws:

DirectoryFailure

getAllGuardsInDirectory

java.util.List<DomainDescription> getAllGuardsInDirectory()
                                                          throws DirectoryFailure

Get a Vector of descriptions of all guards in the directory.

Returns:

Vector of AgentDescriptions of all guards in the directory.

Throws:

DirectoryFailure

getDomainDescriptionsForGuard

java.util.List<DomainDescription> getDomainDescriptionsForGuard(java.lang.String guardGUID)
                                                                throws DirectoryFailure

Obtain a List containing DomainDescriptions of all domains the guard, whose GUID is specified, registered in.

Parameters:

guardGUID - GUID of the guard registered in all domains, whose descriptions are requested

Returns:

List of DomainDescriptions

Throws:

DirectoryFailure

getDomainStructure

java.util.Map getDomainStructure(java.lang.String domainName)
                                 throws DirectoryFailure

Obtain a Map containing the structure of a domain.

Parameters:

domainName - name of the domain to map

Returns:

Map of hosts -> execution environments -> containers -> agents

Throws:

DirectoryFailure

removeExecEnv

void removeExecEnv(java.lang.String execEnvID)
                   throws DirectoryFailure

Remove ExecutionEnvironment with the specified ID from the domain structure.

Throws:

DirectoryFailure

getRootDomains

java.util.List<java.lang.String> getRootDomains()
                                                throws DirectoryFailure

Obtain a Vector of the names of the root domains (domains with no parent)

Returns:

Vector of Strings of the names of root domains

Throws:

DirectoryFailure

getSubdomains

java.util.List<java.lang.String> getSubdomains(java.lang.String domainName)
                                               throws DirectoryFailure

Obtain a Vector of the names of subdomains of a particular domain (returns immediate children only)

Returns:

Vector of Strings of the names of domains

Throws:

DirectoryFailure

getDomainDescription

DomainDescription getDomainDescription(java.lang.String domainName)
                                       throws DirectoryFailure

Get the description of a domain

Parameters:

domainName - the name of the domain

Throws:

DirectoryFailure