Java Doc for AbstractQuotaMatcher.java in  » Net » james-2.3.1 » org » apache » james » transport » matchers » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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 » Net » james 2.3.1 » org.apache.james.transport.matchers 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.mailet.GenericMatcher
      org.apache.james.transport.matchers.AbstractQuotaMatcher

All known Subclasses:   org.apache.james.transport.matchers.AbstractStorageQuota,
AbstractQuotaMatcher
abstract public class AbstractQuotaMatcher extends GenericMatcher (Code)

Abstract matcher checking whether a recipient has exceeded a maximum allowed quota.

"Quota" at this level is an abstraction whose specific interpretation will be done by subclasses.

Although extending GenericMatcher, its logic is recipient oriented.


version:
   CVS $Revision: 494012 $ $Date: 2007-01-08 11:23:58 +0100 (Mo, 08 Jan 2007) $
since:
   2.2.0




Method Summary
abstract protected  longgetQuota(MailAddress address, Mail mail)
     Gets the quota to check against.
abstract protected  longgetUsed(MailAddress address, Mail mail)
     Gets the used amount to check against the quota.
protected  booleanisOverQuota(MailAddress address, Mail mail)
     Does the quota check.
protected  booleanisRecipientChecked(MailAddress recipient)
     Checks the recipient.
protected  booleanisSenderChecked(MailAddress sender)
     Checks the sender.
final public  Collectionmatch(Mail mail)
     Standard matcher entrypoint.
protected  longparseQuota(String amount)
     Utility method that parses an amount string.



Method Detail
getQuota
abstract protected long getQuota(MailAddress address, Mail mail) throws MessagingException(Code)
Gets the quota to check against.
Parameters:
  address - the address holding the quota if applicable
Parameters:
  mail - the mail involved if needed



getUsed
abstract protected long getUsed(MailAddress address, Mail mail) throws MessagingException(Code)
Gets the used amount to check against the quota.
Parameters:
  address - the address involved
Parameters:
  mail - the mail involved if needed



isOverQuota
protected boolean isOverQuota(MailAddress address, Mail mail)(Code)
Does the quota check. Checks if AbstractQuotaMatcher.getQuota < AbstractQuotaMatcher.getUsed for a recipient. Catches any throwable returning false, and so should any override do.
Parameters:
  address - the recipient addresss to check
Parameters:
  mail - the mail involved in the check true if over quota



isRecipientChecked
protected boolean isRecipientChecked(MailAddress recipient) throws MessagingException(Code)
Checks the recipient. The default behaviour is to check that the recipient is not the local postmaster. If a subclass overrides this method it should "and" super.isRecipientChecked to its check.
Parameters:
  recipient - the recipient to check



isSenderChecked
protected boolean isSenderChecked(MailAddress sender) throws MessagingException(Code)
Checks the sender. The default behaviour is to check that the sender is not null nor the local postmaster. If a subclass overrides this method it should "and" super.isSenderChecked to its check.
Parameters:
  sender - the sender to check



match
final public Collection match(Mail mail) throws MessagingException(Code)
Standard matcher entrypoint. First of all, checks the sender using AbstractQuotaMatcher.isSenderChecked . Then, for each recipient checks it using AbstractQuotaMatcher.isRecipientChecked and AbstractQuotaMatcher.isOverQuota .
throws:
  MessagingException - if either isSenderChecked or isRecipientChecked throw an exception



parseQuota
protected long parseQuota(String amount) throws MessagingException(Code)
Utility method that parses an amount string. You can use 'k' and 'm' as optional postfixes to the amount (both upper and lowercase). In other words, "1m" is the same as writing "1024k", which is the same as "1048576".
Parameters:
  amount - the amount string to parse



Methods inherited from org.apache.mailet.GenericMatcher
public void destroy()(Code)(Java Doc)
public String getCondition()(Code)(Java Doc)
public MailetContext getMailetContext()(Code)(Java Doc)
public MatcherConfig getMatcherConfig()(Code)(Java Doc)
public String getMatcherInfo()(Code)(Java Doc)
public String getMatcherName()(Code)(Java Doc)
public void init(MatcherConfig newConfig) throws MessagingException(Code)(Java Doc)
public void init() throws MessagingException(Code)(Java Doc)
public void log(String message)(Code)(Java Doc)
public void log(String message, Throwable t)(Code)(Java Doc)
abstract public Collection match(Mail mail) throws MessagingException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.