KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exoplatform > services > wsrp > consumer > UserRegistry


1 package org.exoplatform.services.wsrp.consumer;
2
3 import java.util.Iterator JavaDoc;
4
5 /**
6  * Defines a registry which can be used to manage users.
7  *
8  * @author Stephan Laertz
9  * @author Benjamin Mestrallet
10  */
11 public interface UserRegistry {
12
13   /**
14    * Add a user to the registry
15    *
16    * @param user The user to add
17    * @return The user added or null
18    */
19   public User addUser(User user);
20
21   /**
22    * Get the user with the given id
23    *
24    * @param userID The ID of the user
25    * @return The user object with the given user id
26    */
27   public User getUser(String JavaDoc userID);
28
29   /**
30    * Remove a user from the list of known user
31    *
32    * @param userID The ID of the user
33    * @return The user which has been removed or null
34    */
35   public User removeUser(String JavaDoc userID);
36
37   /**
38    * Remove all users from the registry
39    */
40   public void removeAllUsers();
41
42   /**
43    * Get an iterator with all known users
44    *
45    * @return All known user objects in an iterator
46    */
47   public Iterator JavaDoc getAllUsers();
48 }
49
Popular Tags