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.Collection;
25
26
27 /**
28 * Interface which should be implemented of classes which map recipients
29 *
30 */
31 public interface VirtualUserTable {
32
33 /**
34 * The component role used by components implementing this service
35 */
36 public static final String ROLE = "org.apache.james.api.vut.VirtualUserTable";
37
38 /**
39 * The prefix which is used for error mappings
40 */
41 public static final String ERROR_PREFIX = "error:";
42
43 /**
44 * The prefix which is used for regex mappings
45 */
46 public static final String REGEX_PREFIX = "regex:";
47
48 /**
49 * The prefix which is used for alias domain mappings
50 */
51 public static final String ALIASDOMAIN_PREFIX = "domain:";
52
53 /**
54 * Return the mapped MailAddress for the given address. Return null if no
55 * matched mapping was found
56 *
57 * @param user the MailAddress
58 * @return the mapped mailAddress
59 * @throws ErrorMappingException get thrown if an error mapping was found
60 */
61 public Collection getMappings(String user, String domain) throws ErrorMappingException;
62 }