package com.c2kernel.lookup;

import java.util.Iterator;

import com.c2kernel.common.ObjectNotFoundException;
import com.c2kernel.process.auth.Authenticator;
import com.c2kernel.property.Property;
import com.c2kernel.property.PropertyDescriptionList;

/**
 * @author abranson
 *
 */
public interface Lookup {
	
	/**
	 * Connect to the directory using the credentials supplied in the Authenticator. 
	 * 
	 * @param user The connected Authenticator. The Lookup implementation may use the AuthObject in this to communicate with the database.
	 */
	public void open(Authenticator user);

	/**
	 * Shutdown the lookup
	 */
	public void close();

	// Path resolution
	/**
	 * 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. 
	 * 
	 * @param sysKey The system key of the Item
	 * @return an ItemPath or AgentPath
	 * @throws InvalidItemPathException When the system key is invalid/out-of-range
	 * @throws ObjectNotFoundException When the Item does not exist in the directory.
	 */
	public ItemPath getItemPath(String sysKey) throws InvalidItemPathException, ObjectNotFoundException;
	
	/**
	 * Find the ItemPath for which a DomainPath is an alias.
	 * 
	 * @param domainPath The path to resolve
	 * @return The ItemPath it points to (should be an AgentPath if the path references an Agent)
	 * @throws InvalidItemPathException
	 * @throws ObjectNotFoundException
	 */
	public ItemPath resolvePath(DomainPath domainPath) throws InvalidItemPathException, ObjectNotFoundException;

	/**
	 * Resolve a path to a CORBA Object Item or Agent
	 * 
	 * @param path The path to be resolved
	 * @return The CORBA Object
	 * @throws ObjectNotFoundException When the Path doesn't exist, or doesn't have an IOR associated with it
	 */
	public org.omg.CORBA.Object resolve(Path path) throws ObjectNotFoundException;

	// Path finding and searching
	
	/**
	 * Checks if a particular Path exists in the directory
	 * @param path The path to check
	 * @return boolean true if the path exists, false if it doesn't
	 */
	public boolean exists(Path path);
	
	/**
	 * List the next-level-deep children of a Path
	 * 
	 * @param path The parent Path
	 * @return An Iterator of child Paths
	 */
	public Iterator<Path> getChildren(Path path);

	/**
	 * Find a path with a particular name (last component)
	 * 
	 * @param start Search root
	 * @param name The name to search for
	 * @return An Iterator of matching Paths. Should be an empty Iterator if there are no matches.
	 */
	public Iterator<Path> search(Path start, String name);

	/**
	 * Search for Items in the specified path with the given property name and value
	 * @param start Search root
	 * @param propname Property name
	 * @param propvalue The property value to search for
	 * @return An Iterator of matching Paths
	 */
	public Iterator<Path> search(Path start, Property... props);
	
	/**
	 * Search for Items of a particular type, based on its PropertyDescription outcome
	 * @param start Search root
	 * @param props Properties unmarshalled from an ItemDescription's property description outcome.
	 * @return An Iterator of matching Paths
	 */
	public Iterator<Path> search(Path start, PropertyDescriptionList props);

	/**
	 * Find all DomainPaths that are aliases for a particular Item or Agent
	 * @param itemPath The ItemPath
	 * @return An Iterator of DomainPaths that are aliases for that Item
	 */
	public Iterator<Path> searchAliases(ItemPath itemPath);
	
	// Role and agent management
	
	/**
	 * @param agentName
	 * @return
	 * @throws ObjectNotFoundException
	 */
	public AgentPath getAgentPath(String agentName) throws ObjectNotFoundException;

	/**
	 * @param roleName
	 * @return
	 * @throws ObjectNotFoundException
	 */
	public RolePath getRolePath(String roleName) throws ObjectNotFoundException;
	
	/**
	 * @param rolePath
	 * @return
	 * @throws ObjectNotFoundException
	 */
	public AgentPath[] getAgents(RolePath rolePath) throws ObjectNotFoundException;

	/**
	 * @param agentPath
	 * @return
	 */
	public RolePath[] getRoles(AgentPath agentPath);

	/**
	 * Returns all of the Agents in this centre who hold this role (including sub-roles)
	 * 
	 * @param agentPath
	 * @param role
	 * @return
	 */
	public boolean hasRole(AgentPath agentPath, RolePath role);

	/**
	 * @param agentPath
	 * @return
	 * @throws ObjectNotFoundException
	 */
	public String getAgentName(AgentPath agentPath) throws ObjectNotFoundException;
	
}