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
21
22 package org.apache.james.api.vut;
23
24 import java.util.Iterator;
25
26 /**
27 * Interface for Phoenix blocks to access a store of VirtualUserTable. A VirtualUserTableStore
28 * contains one or more VirtualUserTables. Multiple VirtualUserTables may or may
29 * not have overlapping membership.
30 *
31 * @version 1.0.0, 24/04/1999
32 */
33 public interface VirtualUserTableStore
34 {
35 /**
36 * The component role used by components implementing this service
37 */
38 String ROLE = "org.apache.james.api.vut.VirtualUserTableStore";
39
40 /**
41 * Get the table, if any, whose name corresponds to
42 * the argument parameter
43 *
44 * @param name the name of the desired repository
45 *
46 * @return the VirtualUserTable corresponding to the name parameter
47 */
48 VirtualUserTable getTable( String name );
49
50 /**
51 * Yield an <code>Iterator</code> over the set of repository
52 * names managed internally by this store.
53 *
54 * @return an Iterator over the set of repository names
55 * for this store
56 */
57 Iterator getTableNames();
58 }