org.cristalise.kernel.lookup

Interface Lookup

All Known Subinterfaces:

LookupManager

public interface Lookup

Author:

abranson

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Shutdown the lookup
boolean	exists(Path path) Checks if a particular Path exists in the directory
String	getAgentName(AgentPath agentPath) Return the username of the Agent referenced by an AgentPath
AgentPath	getAgentPath(String agentName)
AgentPath[]	getAgents(RolePath rolePath) Returns all of the Agents in this centre who hold this role (including sub-roles)
Iterator<Path>	getChildren(Path path) List the next-level-deep children of a Path
String	getIOR(Path path) Resolve a path to a CORBA Object Item or Agent
ItemPath	getItemPath(String sysKey) Fetch the correct subclass class of ItemPath for a particular Item, derived from its lookup entry.
RolePath	getRolePath(String roleName) Find the RolePath for the named Role
RolePath[]	getRoles(AgentPath agentPath) Get all roles held by the given Agent
boolean	hasRole(AgentPath agentPath, RolePath role) Checks if an agent qualifies as holding the stated Role, including any sub-role logic.
void	open(Authenticator user) Connect to the directory using the credentials supplied in the Authenticator.
ItemPath	resolvePath(DomainPath domainPath) Find the ItemPath for which a DomainPath is an alias.
Iterator<Path>	search(Path start, Property... props) Search for Items in the specified path with the given property name and value
Iterator<Path>	search(Path start, PropertyDescriptionList props) Search for Items of a particular type, based on its PropertyDescription outcome
Iterator<Path>	search(Path start, String name) Find a path with a particular name (last component)
Iterator<Path>	searchAliases(ItemPath itemPath) Find all DomainPaths that are aliases for a particular Item or Agent

Method Detail

open

void open(Authenticator user)

Connect to the directory using the credentials supplied in the Authenticator.

Parameters:

user - The connected Authenticator. The Lookup implementation may use the AuthObject in this to communicate with the database.

close

void close()

Shutdown the lookup

getItemPath

ItemPath getItemPath(String sysKey)
                     throws InvalidItemPathException,
                            ObjectNotFoundException

Fetch the correct subclass class of ItemPath for a particular Item, derived from its lookup entry. This is used by the CORBA Server to make sure the correct Item subclass is used.

Parameters:

sysKey - The system key of the Item

Returns:

an ItemPath or AgentPath

Throws:

InvalidItemPathException - When the system key is invalid/out-of-range

ObjectNotFoundException - When the Item does not exist in the directory.

resolvePath

ItemPath resolvePath(DomainPath domainPath)
                     throws InvalidItemPathException,
                            ObjectNotFoundException

Find the ItemPath for which a DomainPath is an alias.

Parameters:

domainPath - The path to resolve

Returns:

The ItemPath it points to (should be an AgentPath if the path references an Agent)

Throws:

InvalidItemPathException

ObjectNotFoundException

getIOR

String getIOR(Path path)
              throws ObjectNotFoundException

Resolve a path to a CORBA Object Item or Agent

Parameters:

path - The path to be resolved

Returns:

The CORBA Object's IOR

Throws:

ObjectNotFoundException - When the Path doesn't exist, or doesn't have an IOR associated with it

exists

boolean exists(Path path)

Checks if a particular Path exists in the directory

Parameters:

path - The path to check

Returns:

boolean true if the path exists, false if it doesn't

getChildren

Iterator<Path> getChildren(Path path)

List the next-level-deep children of a Path

Parameters:

path - The parent Path

Returns:

An Iterator of child Paths

search

Iterator<Path> search(Path start,
                    String name)

Find a path with a particular name (last component)

Parameters:

start - Search root

name - The name to search for

Returns:

An Iterator of matching Paths. Should be an empty Iterator if there are no matches.

search

Iterator<Path> search(Path start,
                    Property... props)

Search for Items in the specified path with the given property name and value

Parameters:

start - Search root

propname - Property name

propvalue - The property value to search for

Returns:

An Iterator of matching Paths

search

Iterator<Path> search(Path start,
                    PropertyDescriptionList props)

Search for Items of a particular type, based on its PropertyDescription outcome

Parameters:

start - Search root

props - Properties unmarshalled from an ItemDescription's property description outcome.

Returns:

An Iterator of matching Paths

searchAliases

Iterator<Path> searchAliases(ItemPath itemPath)

Find all DomainPaths that are aliases for a particular Item or Agent

Parameters:

itemPath - The ItemPath

Returns:

An Iterator of DomainPaths that are aliases for that Item

getAgentPath

AgentPath getAgentPath(String agentName)
                       throws ObjectNotFoundException

Parameters:

agentName -

Returns:

Throws:

ObjectNotFoundException

getRolePath

RolePath getRolePath(String roleName)
                     throws ObjectNotFoundException

Find the RolePath for the named Role

Parameters:

roleName -

Returns:

Throws:

ObjectNotFoundException

getAgents

AgentPath[] getAgents(RolePath rolePath)
                      throws ObjectNotFoundException

Returns all of the Agents in this centre who hold this role (including sub-roles)

Parameters:

rolePath -

Returns:

Throws:

ObjectNotFoundException

getRoles

RolePath[] getRoles(AgentPath agentPath)

Get all roles held by the given Agent

Parameters:

agentPath -

Returns:

hasRole

boolean hasRole(AgentPath agentPath,
              RolePath role)

Checks if an agent qualifies as holding the stated Role, including any sub-role logic.

Parameters:

agentPath -

role -

Returns:

getAgentName

String getAgentName(AgentPath agentPath)
                    throws ObjectNotFoundException

Return the username of the Agent referenced by an AgentPath

Parameters:

agentPath -

Returns:

Throws:

ObjectNotFoundException