01: /****************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one *
03: * or more contributor license agreements. See the NOTICE file *
04: * distributed with this work for additional information *
05: * regarding copyright ownership. The ASF licenses this file *
06: * to you under the Apache License, Version 2.0 (the *
07: * "License"); you may not use this file except in compliance *
08: * with the License. You may obtain a copy of the License at *
09: * *
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: ****************************************************************/package org.apache.james.services;
19:
20: import java.util.Iterator;
21:
22: /**
23: * Interface for Phoenix blocks to access a store of Users. A UserStore
24: * contains one or more UserRepositories. Multiple UserRepositories may or may
25: * not have overlapping membership.
26: *
27: * @version 1.0.0, 24/04/1999
28: */
29: public interface UsersStore {
30: /**
31: * The component role used by components implementing this service
32: */
33: String ROLE = "org.apache.james.services.UsersStore";
34:
35: /**
36: * Get the repository, if any, whose name corresponds to
37: * the argument parameter
38: *
39: * @param name the name of the desired repository
40: *
41: * @return the UsersRepository corresponding to the name parameter
42: */
43: UsersRepository getRepository(String name);
44:
45: /**
46: * Yield an <code>Iterator</code> over the set of repository
47: * names managed internally by this store.
48: *
49: * @return an Iterator over the set of repository names
50: * for this store
51: */
52: Iterator getRepositoryNames();
53: }
|