From 0ed2c1124cf1b9e49a2ec1fa0126a8df09f9e758 Mon Sep 17 00:00:00 2001 From: Andrew Branson Date: Tue, 7 Oct 2014 09:18:11 +0200 Subject: Repackage to org.cristalise --- src/main/java/com/c2kernel/lookup/Lookup.java | 174 -------------------------- 1 file changed, 174 deletions(-) delete mode 100644 src/main/java/com/c2kernel/lookup/Lookup.java (limited to 'src/main/java/com/c2kernel/lookup/Lookup.java') diff --git a/src/main/java/com/c2kernel/lookup/Lookup.java b/src/main/java/com/c2kernel/lookup/Lookup.java deleted file mode 100644 index 924057a..0000000 --- a/src/main/java/com/c2kernel/lookup/Lookup.java +++ /dev/null @@ -1,174 +0,0 @@ -/** - * This file is part of the CRISTAL-iSE kernel. - * Copyright (c) 2001-2014 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 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 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 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 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 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 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; - -} -- cgit v1.2.3