01: /****************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one *
03: * or more contributor license agreements. See the NOTICE file *
04: * distributed with this work for additional information *
05: * regarding copyright ownership. The ASF licenses this file *
06: * to you under the Apache License, Version 2.0 (the *
07: * "License"); you may not use this file except in compliance *
08: * with the License. You may obtain a copy of the License at *
09: * *
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: ****************************************************************/package org.apache.mailet;
19:
20: /**
21: * A matcher configuration object used by a mailet container used to pass information
22: * to a matcher during initialization.
23: * <p>
24: * The configuration information contains an initialization parameter,
25: * which is set as a condition String, and a MailetContext object,
26: * which gives the mailet information about the mailet container.
27: *
28: * @version 1.0.0, 24/04/1999
29: */
30: public interface MatcherConfig {
31:
32: /**
33: * The simple condition defined for this matcher, e.g., for
34: * SenderIs=admin@localhost, this would return admin@localhost.
35: *
36: * @return a String containing the value of the initialization parameter
37: */
38: String getCondition();
39:
40: /**
41: * Returns a reference to the MailetContext in which the matcher is executing
42: *
43: * @return a MailetContext object, used by the matcher to interact with its
44: * mailet container
45: */
46: MailetContext getMailetContext();
47:
48: /**
49: * Returns the name of this matcher instance. The name may be provided via server
50: * administration, assigned in the application deployment descriptor, or for
51: * an unregistered (and thus unnamed) matcher instance it will be the matcher's
52: * class name.
53: *
54: * @return the name of the matcher instance
55: */
56: String getMatcherName();
57: }
|