1 /*****************************************************************
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 ****************************************************************/
19
20 package org.apache.james.services;
21
22 import java.util.Iterator;
23
24 /***
25 * Interface for Phoenix blocks to access a store of Users. A UserStore
26 * contains one or more UserRepositories. Multiple UserRepositories may or may
27 * not have overlapping membership.
28 *
29 * @version 1.0.0, 24/04/1999
30 */
31 public interface UsersStore
32 {
33 /***
34 * The component role used by components implementing this service
35 */
36 String ROLE = "org.apache.james.services.UsersStore";
37
38 /***
39 * Get the repository, if any, whose name corresponds to
40 * the argument parameter
41 *
42 * @param name the name of the desired repository
43 *
44 * @return the UsersRepository corresponding to the name parameter
45 */
46 UsersRepository getRepository( String name );
47
48 /***
49 * Yield an <code>Iterator</code> over the set of repository
50 * names managed internally by this store.
51 *
52 * @return an Iterator over the set of repository names
53 * for this store
54 */
55 Iterator getRepositoryNames();
56 }