1 /*
2 * Copyright (C) The Apache Software Foundation. All rights reserved.
3 *
4 * This software is published under the terms of the Apache Software License
5 * version 1.1, a copy of which has been included with this distribution in
6 * the LICENSE file.
7 */
8 package org.apache.mailet;
9
10 /***
11 * A matcher configuration object used by a mailet container used to pass information
12 * to a matcher during initialization.
13 * <p>
14 * The configuration information contains an initialization parameter,
15 * which is set as a condition String, and a MailetContext object,
16 * which gives the mailet information about the mailet container.
17 *
18 * @version 1.0.0, 24/04/1999
19 * @author Serge Knystautas <sergek@lokitech.com>
20 */
21 public interface MatcherConfig {
22
23 /***
24 * The simple condition defined for this matcher, e.g., for
25 * SenderIs=admin@localhost, this would return admin@localhost.
26 *
27 * @return a String containing the value of the initialization parameter
28 */
29 String getCondition();
30
31 /***
32 * Returns a reference to the MailetContext in which the matcher is executing
33 *
34 * @return a MailetContext object, used by the matcher to interact with its
35 * mailet container
36 */
37 MailetContext getMailetContext();
38
39 /***
40 * Returns the name of this matcher instance. The name may be provided via server
41 * administration, assigned in the application deployment descriptor, or for
42 * an unregistered (and thus unnamed) matcher instance it will be the matcher's
43 * class name.
44 *
45 * @return the name of the matcher instance
46 */
47 String getMatcherName();
48 }
This page was automatically generated by Maven