1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/**
* 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 org.cristalise.kernel.lookup;
import java.util.Iterator;
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;
/**
* @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;
}
|
