KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > lenya > ac > IPRangeManager


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17
18 /* $Id: IPRangeManager.java 42616 2004-03-03 12:56:33Z gregor $ */
19
20 package org.apache.lenya.ac;
21
22 /**
23  * An IP range manager.
24  */
25 public interface IPRangeManager extends ItemManager {
26     
27     /**
28      * Get all IP ranges.
29      *
30      * @return an array of IP ranges.
31      */
32     IPRange[] getIPRanges();
33     
34     /**
35      * Add the given IP range
36      *
37      * @param range IP range that is to be added
38      * @throws AccessControlException when the IP range is already contained.
39      */
40     void add(IPRange range) throws AccessControlException;
41     
42     /**
43      * Remove the given IP range
44      *
45      * @param range IP range that is to be removed
46      * @throws AccessControlException when the IP range is not contained.
47      */
48     void remove(IPRange range) throws AccessControlException;
49     
50     /**
51      * Get the IPRange with the given id.
52      *
53      * @param rangeId user id of requested IP range
54      * @return the requested IP range or null if there is
55      * no IP range with the given id
56      */
57     IPRange getIPRange(String JavaDoc rangeId);
58     
59 }
Popular Tags