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 package org.apache.mailet;
21
22 /***
23 * A matcher configuration object used by a mailet container used to pass information
24 * to a matcher during initialization.
25 * <p>
26 * The configuration information contains an initialization parameter,
27 * which is set as a condition String, and a MailetContext object,
28 * which gives the mailet information about the mailet container.
29 *
30 * @version 1.0.0, 24/04/1999
31 */
32 public interface MatcherConfig {
33
34 /***
35 * The simple condition defined for this matcher, e.g., for
36 * SenderIs=admin@localhost, this would return admin@localhost.
37 *
38 * @return a String containing the value of the initialization parameter
39 */
40 String getCondition();
41
42 /***
43 * Returns a reference to the MailetContext in which the matcher is executing
44 *
45 * @return a MailetContext object, used by the matcher to interact with its
46 * mailet container
47 */
48 MailetContext getMailetContext();
49
50 /***
51 * Returns the name of this matcher instance. The name may be provided via server
52 * administration, assigned in the application deployment descriptor, or for
53 * an unregistered (and thus unnamed) matcher instance it will be the matcher's
54 * class name.
55 *
56 * @return the name of the matcher instance
57 */
58 String getMatcherName();
59 }