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 package org.apache.mailet.base;
22
23 import javax.mail.MessagingException;
24
25 import org.apache.mailet.Mail;
26 import org.apache.mailet.MailAddress;
27
28 import java.util.Collection;
29 import java.util.Iterator;
30 import java.util.Vector;
31
32 /**
33 * GenericMatcher makes writing recipient based matchers easier. It provides
34 * simple versions of the lifecycle methods init and destroy and of the methods
35 * in the MatcherConfig interface. GenericMatcher also implements the log method,
36 * declared in the MatcherContext interface.
37 *
38 * @version 1.0.0, 24/04/1999
39 */
40 public abstract class GenericRecipientMatcher extends GenericMatcher {
41
42 /**
43 * Matches each recipient one by one through matchRecipient(MailAddress
44 * recipient) method. Handles splitting the recipients Collection
45 * as appropriate.
46 *
47 * @param mail - the message and routing information to determine whether to match
48 * @return Collection the Collection of MailAddress objects that have been matched
49 */
50 public final Collection match(Mail mail) throws MessagingException {
51 Collection matching = new Vector();
52 for (Iterator i = mail.getRecipients().iterator(); i.hasNext(); ) {
53 MailAddress rec = (MailAddress) i.next();
54 if (matchRecipient(rec)) {
55 matching.add(rec);
56 }
57 }
58 return matching;
59 }
60
61 /**
62 * Simple check to match exclusively on the email address (not
63 * message information).
64 *
65 * @param recipient - the address to determine whether to match
66 * @return boolean whether the recipient is a match
67 */
68 public abstract boolean matchRecipient(MailAddress recipient) throws MessagingException;
69 }