org.cristalise.kernel.lookup.Lookup Maven / Gradle / Ivy
/**
* This file is part of the CRISTAL-iSE kernel.
* Copyright (c) 2001-2015 The CRISTAL Consortium. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation; either version 3 of the License, or (at
* your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; with out even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*
* http://www.fsf.org/licensing/licenses/lgpl.html
*/
package org.cristalise.kernel.lookup;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.cristalise.kernel.common.ObjectNotFoundException;
import org.cristalise.kernel.process.auth.Authenticator;
import org.cristalise.kernel.property.Property;
import org.cristalise.kernel.property.PropertyDescriptionList;
/**
*
*/
public interface Lookup {
/**
*
*/
public class PagedResult {
public int maxRows;
public List rows;
public PagedResult() {
maxRows = 0;
rows = new ArrayList<>();
}
public PagedResult(int size, List result) {
maxRows = size;
rows = result;
}
}
/**
* 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();
/**
* 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)
*/
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's IOR
* @throws ObjectNotFoundException When the Path doesn't exist, or doesn't have an IOR associated with it
*/
public String getIOR(Path path) throws ObjectNotFoundException;
/**
* 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 getChildren(Path path);
/**
* List the next-level-deep children of a Path
*
* @param path The parent Path
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return A List of child Paths
*/
public PagedResult getChildren(Path path, int offset, int limit);
/**
* 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 search(Path start, String name);
/**
* Search for Items in the specified path with the given property list
*
* @param start Search root
* @param props list of Properties
* @return An Iterator of matching Paths
*/
public Iterator search(Path start, Property... props);
/**
* Search for Items in the specified path with the given property list
*
* @param start Search root
* @param props list of Properties
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return PagedResult of matching Paths
*/
public PagedResult search(Path start, List props, int offset, int limit);
/**
* 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 search(Path start, PropertyDescriptionList 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.
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return An PagedResult of matching Paths
*/
public PagedResult search(Path start, PropertyDescriptionList props, int offset, int limit);
/**
* 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 searchAliases(ItemPath itemPath);
/**
* Find all DomainPaths that are aliases for a particular Item or Agent
*
* @param itemPath The ItemPath
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return An PagedResult of DomainPaths that are aliases for that Item
*/
public PagedResult searchAliases(ItemPath itemPath, int offset, int limit);
/**
* Find the AgentPath for the named Agent
*
* @param agentName then name of the Agent
* @return the AgentPath representing the Agent
*/
public AgentPath getAgentPath(String agentName) throws ObjectNotFoundException;
/**
* Find the RolePath for the named Role
*
* @param roleName the name of the Role
* @return the RolePath representing the Role
*/
public RolePath getRolePath(String roleName) throws ObjectNotFoundException;
/**
* Returns all of the Agents in this centre who hold this role (including sub-roles)
*
* @param rolePath the path representing the given Role
* @return the list of Agents
*/
public AgentPath[] getAgents(RolePath rolePath) throws ObjectNotFoundException;
/**
* Returns all of the Agents who hold this role (including sub-roles)
*
* @param rolePath the path representing the given Role
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return the PagedResult of Agents
*/
public PagedResult getAgents(RolePath rolePath, int offset, int limit) throws ObjectNotFoundException;
/**
* Get all roles held by the given Agent
*
* @param agentPath the path representing the given Agent
* @return the list of Roles
*/
public RolePath[] getRoles(AgentPath agentPath);
/**
* Get all roles held by the given Agent
*
* @param agentPath the path representing the given Agent
* @param offset the number of records to be skipped from the result
* @param limit the max number of records to be returned
* @return the PagedResult of Roles
*/
public PagedResult getRoles(AgentPath agentPath, int offset, int limit);
/**
* Checks if an agent qualifies as holding the stated Role, including any sub-role logic.
*
* @param agentPath the path representing the given Agent
* @param role the path representing the given Role
* @return true or false
*/
public boolean hasRole(AgentPath agentPath, RolePath role);
/**
* Return the name of the Agent referenced by an AgentPath
* @param agentPath the path representing the given Agent
* @return the name string
*/
public String getAgentName(AgentPath agentPath) throws ObjectNotFoundException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy