org.apache.james.mailetcontainer.impl.matchers

Interface CompositeMatcher

All Superinterfaces:

org.apache.mailet.Matcher

All Known Implementing Classes:

And, GenericCompositeMatcher, Not, Or, Xor

public interface CompositeMatcher
extends org.apache.mailet.Matcher

A CompositeMatcher contains child matchers that are invoked in turn and their recipient results are composed from the composite operation. See And, Or, Xor and Not. One or more children may be supplied to a composite via declaration inside a processor in the james-config.xml file. When the composite is the outter-most declaration it must be named, as in the example below. The composite matcher may be referenced by name and used in a subsequent mailet. Any matcher may be included as a child of a composite matcher, including another composite matcher or the Not matcher. As a consequence, the class names: And, Or, Not and Xor are permanently reserved.

   <matcher name="a-composite" match="Or">
      <matcher match="And">
          <matcher match="Not">
              <matcher match="HostIs=65.55.116.84"/>
          </matcher>
          <matcher match="HasHeaderWithRegex=X-Verify-SMTP,Host(.*)sending to us was not listening"/>
      </matcher>
      <matchwe match="HasHeaderWithRegex=X-DNS-Paranoid,(.*)"/>
   </matcher>
   
   <mailet match="a-composite" class="ToProcessor">
       <processor>spam</processor>
   </mailet>
 *
 

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.mailet.Matcher matcher) Add a child matcher to this composite matcher.
Iterator	iterator()

Methods inherited from interface org.apache.mailet.Matcher

destroy, getMatcherConfig, getMatcherInfo, init, match

Method Detail

iterator

Iterator iterator()

Returns:

Iterator if child Matchers

add

void add(org.apache.mailet.Matcher matcher)

Add a child matcher to this composite matcher. This is called by SpoolManager.setupMatcher()

Parameters:

matcher - Matcher is the child that this composite treats.