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.management;
23
24 import java.util.List;
25
26
27 public interface DomainListManagementService {
28
29 public final static String ROLE = "org.apache.james.management.DomainListManagementService";
30
31 /**
32 * Add domain to the service
33 *
34 * @param domain domain to add
35 * @return true if successfully
36 * @throws DomainListManagementException
37 */
38 public boolean addDomain(String domain) throws DomainListManagementException;
39
40 /**
41 * Remove domain from the service
42 *
43 * @param domain domain to remove
44 * @return true if succesfully
45 * @throws DomainListManagementException
46 */
47 public boolean removeDomain(String domain) throws DomainListManagementException;
48
49 /**
50 * Return List of domains which should be used as localdomains. Return null if no
51 * domains were found
52 *
53 * @return domains
54 */
55 public List getDomains();
56
57 /**
58 * Return true if the domain exists in the service
59 *
60 * @param domain the domain
61 * @return true if the given domain exists in the service
62 */
63 public boolean containsDomain(String domain);
64 }