Java Doc for LinearProcessor.java in » Web-Mail » james-2.3.1 » org » apache » james » transport » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Mail » james 2.3.1 » org.apache.james.transport

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.james.transport .LinearProcessor

LinearProcessor
public class LinearProcessor extends AbstractLogEnabled implements Initializable,Disposable(Code)
	Implements a processor for mails, directing the mail down the chain of matchers/mailets. SAMPLE CONFIGURATION <processor name="try" onerror="return,log"> <mailet match="RecipientIsLocal" class="LocalDelivery"> </mailet> <mailet match="All" class="RemoteDelivery"> <delayTime>21600000</delayTime> <maxRetries>5</maxRetries> </mailet> </processor> Note that the 'onerror' attribute is not yet supported. As of James v2.2.0a5, 'onerror' functionality is implemented, but it is implemented on the <mailet> tag. The specification is: <mailet match="..." class="..." [onMatchException="{noMatch\|matchAll\|error\|<aProcessorName>}"] [onMailetException="{ignore\|error\|<aProcessorName>}"]> noMatch: no addresses are considered to match matchAll: all addresses are considered to match error: as before, send the message to the ERROR processor Otherwise, a processor name can be specified, and the message will be sent there. CVS $Id: LinearProcessor.java 494012 2007-01-08 10:23:58Z norman $ version: 2.2.0

Method Summary
public synchronized void	add(Matcher matcher, Mailet mailet) Adds a new `Matcher` / `Mailet` pair to the processor.
public synchronized void	closeProcessorLists()
public void	dispose() The dispose operation is called at the end of a components lifecycle.
public void	initialize()
public void	service(Mail mail) Processes a single mail message through the chain of matchers and mailets. Calls to this method before setSpool has been called with a non-null argument will result in an `IllegalStateException`. If the matcher/mailet lists have not been closed by a call to the closeProcessorLists method then a call to this method will result in an `IllegalStateException`. The end of the matcher/mailet chain must be a matcher that matches all mails and a mailet that sets every mail to GHOST status.
public void	setSpool(SpoolRepository spool) Set the spool to be used by this LinearProcessor.

Method Detail

add

public synchronized void add(Matcher matcher, Mailet mailet)(Code)

Adds a new Matcher / Mailet pair to the processor. Checks to ensure that the matcher and mailet passed in are not null. Synchronized to ensure that the matchers and mailets are kept in sync.

It is an essential part of the contract of the LinearProcessor that a particular matcher/mailet combination be used to terminate the processor chain. This is done by calling the closeProcessorList method.

Once the closeProcessorList has been called any subsequent call to the add method will result in an IllegalStateException.

This method is synchronized to protect against corruption of matcher/mailets lists

Parameters:
  matcher - the new matcher being added
Parameters:
  mailet - the new mailet being added
throws:
  IllegalArgumentException - when the matcher or mailet passed in is null
throws:
  IllegalStateException - when this method is called after the processor lists have been closed

closeProcessorLists

public synchronized void closeProcessorLists()(Code)

Closes the processor matcher/mailet list.

This method is synchronized to protect against corruption of matcher/mailets lists

throws:
IllegalStateException - when this method is called after the processor lists have been closed

dispose

public void dispose()(Code)

The dispose operation is called at the end of a components lifecycle. Instances of this class use this method to release and destroy any resources that they own.

This implementation disposes of all the mailet instances added to the processor

throws:
Exception - if an error is encountered during shutdown

initialize
public void initialize()(Code)
	See Also: org.apache.avalon.framework.activity.Initializable.initialize

service

public void service(Mail mail) throws MessagingException(Code)

Processes a single mail message through the chain of matchers and mailets.

Calls to this method before setSpool has been called with a non-null argument will result in an IllegalStateException.

If the matcher/mailet lists have not been closed by a call to the closeProcessorLists method then a call to this method will result in an IllegalStateException. The end of the matcher/mailet chain must be a matcher that matches all mails and a mailet that sets every mail to GHOST status. This is necessary to ensure that mails are removed from the spool in an orderly fashion. The closeProcessorLists method ensures this.

Parameters:
mail - the new mail to be processed
throws:
IllegalStateException - when this method is called before the processor lists have been closedor the spool has been initialized

setSpool
public void setSpool(SpoolRepository spool)(Code)
	Set the spool to be used by this LinearProcessor. Parameters: spool - the spool to be used by this processor throws: IllegalArgumentException - when the spool passed in is null

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.