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
|
/**
* 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.security.NoSuchAlgorithmException;
import com.c2kernel.common.ObjectAlreadyExistsException;
import com.c2kernel.common.ObjectCannotBeUpdated;
import com.c2kernel.common.ObjectNotFoundException;
/**
* The LookupManager interface contains all of the directory modifying methods
* of the Lookup. This allows read-only Lookup implementations. Server processes
* will attempt to cast their Lookups into LookupManagers, and fail to start up
* if this is not possible.
*
*/
public interface LookupManager extends Lookup {
/**
* Called when a server starts up. The Lookup implementation should ensure
* that the initial structure of its directory is valid, and create it on
* first boot.
*
* @throws ObjectNotFoundException When initialization data is not found
*/
public void initializeDirectory() throws ObjectNotFoundException;
// Path management
/**
* Register a new a Path in the directory.
*
* @param newPath The path to add
* @throws ObjectCannotBeUpdated When there is an error writing to the
* directory
* @throws ObjectAlreadyExistsException When the Path has already been registered
*/
public void add(Path newPath) throws ObjectCannotBeUpdated, ObjectAlreadyExistsException;
/**
* Remove a Path from the directory.
*
* @param path The path to remove
* @throws ObjectCannotBeUpdated When an error occurs writing to the directory
*/
public void delete(Path path) throws ObjectCannotBeUpdated;
// Role and agent management
/**
* Creates a new Role. Called by the server predefined step 'CreateNewRole'
*
* @param role The new role path
* @return
* @throws ObjectAlreadyExistsException
* @throws ObjectCannotBeUpdated
*/
public RolePath createRole(RolePath role) throws ObjectAlreadyExistsException, ObjectCannotBeUpdated;
/**
* Adds the given Agent to the given Role, if they both exist.
*
* @param agent
* @param rolePath
* @throws ObjectCannotBeUpdated
* @throws ObjectNotFoundException
*/
public void addRole(AgentPath agent, RolePath rolePath) throws ObjectCannotBeUpdated, ObjectNotFoundException;
/**
* Remove the given Agent from the given Role. Does not delete the Role.
*
* @param agent
* @param role
* @throws ObjectCannotBeUpdated
* @throws ObjectNotFoundException
*/
public void removeRole(AgentPath agent, RolePath role) throws ObjectCannotBeUpdated, ObjectNotFoundException;
/**
* Set an Agent's password
*
* @param agent The Agent
* @param newPassword The Agent's new password
* @throws ObjectNotFoundException
* @throws ObjectCannotBeUpdated
* @throws NoSuchAlgorithmException
*/
public void setAgentPassword(AgentPath agent, String newPassword) throws ObjectNotFoundException, ObjectCannotBeUpdated, NoSuchAlgorithmException;
/**
* Set the flag specifying whether Activities holding this Role should push
* Jobs its Agents.
*
* @param role The role to modify
* @param hasJobList boolean flag
*
* @throws ObjectNotFoundException When the Role doesn't exist
* @throws ObjectCannotBeUpdated
*/
public void setHasJobList(RolePath role, boolean hasJobList) throws ObjectNotFoundException, ObjectCannotBeUpdated;
}
|
