You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by er...@apache.org on 2010/11/06 16:45:00 UTC

svn commit: r1032098 - in /james/server/trunk/src/site/xdoc: dev.xml index.xml release-notes.xml

Author: eric
Date: Sat Nov  6 15:44:59 2010
New Revision: 1032098

URL: http://svn.apache.org/viewvc?rev=1032098&view=rev
Log:
Miscellaneous format and naming typos/enhancements.

Modified:
    james/server/trunk/src/site/xdoc/dev.xml
    james/server/trunk/src/site/xdoc/index.xml
    james/server/trunk/src/site/xdoc/release-notes.xml

Modified: james/server/trunk/src/site/xdoc/dev.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/dev.xml?rev=1032098&r1=1032097&r2=1032098&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/dev.xml (original)
+++ james/server/trunk/src/site/xdoc/dev.xml Sat Nov  6 15:44:59 2010
@@ -26,12 +26,12 @@
 
 <body>
 
-  <section name="Architecture">
+  <section name="Functional Architecture">
   
     <p>James is a multi-protocol message processing and storage engine. James
       currently consists of:
       <ul>
-        <li>Four mail prototcol servers (SMTP, POP3, IMAP4 and LMTP).</li>
+        <li>Four mail protocol servers: SMTP, POP3, IMAP4 and LMTP.</li>
         <li>A remote administration server.</li>
   <!--      <li>an NNTP server,</li>-->
         <li>A mail processing engine that supports the Mailet API.</li>
@@ -42,14 +42,14 @@
       </ul>
     </p>
   
-    <p>James is deployed on top of Spring.</p>
-    
   </section>
 
-  <section name="Project Organization">
+  <section name="Technical Architecture">
   
     <img src="images/uml/org.apache.james-package.png"/>
   
+    <p>James is deployed on top of Spring, ActiveMQ, OpenJPA, Netty,...</p>
+    
   </section>
 
   <section name="Design Objectives">
@@ -57,77 +57,86 @@
       <subsection name="Features">
       
         <p>These are some of the currently implemented features:</p>
+
         <p><i><b>Complete portability</b></i>  Apache James is be a 100% pure Java application
-       based on the Java 2 platform and the JavaMail 1.4 API.</p>
-       <p><i><b>Protocol abstraction</b></i>  Unlike other mail engines, protocols are seen only
-       like "communication languages" ruling comunications between clients and
-       the server. Apache James is not be tied to any particular protocol but
-       follow an abstracted server design (like JavaMail did on the
-       client side)</p>
+           based on the Java 2 platform and the JavaMail 1.4 API.</p>
+
+        <p><i><b>Protocol abstraction</b></i>  Unlike other mail engines, protocols are seen only
+           like "communication languages" ruling comunications between clients and
+           the server. Apache James is not be tied to any particular protocol but
+           follow an abstracted server design (like JavaMail did on the
+           client side)</p>
+
         <p><i><b>Complete solution</b></i>  the mail system is able to handle both mail
-       transport and storage in a single server application. Apache James
-       works alone without the need for any other server or solution.</p>
-        <p>
-          <i>
-            <b>Mailet support</b>
-          </i>  Apache James supports the Apache Mailet API. A Mailet
+           transport and storage in a single server application. Apache James
+           works alone without the need for any other server or solution.</p>
+
+        <p><i><b>Mailet support</b></i>  Apache James supports the Apache Mailet API. A Mailet
        is a discrete piece of mail-processing logic which is incorporated into
        a Mailet-compliant mail-server's processing. This easy-to-write,
        easy-to-use pattern allows developers to build powerful customized mail
        systems. Examples of the services a Mailet might provide include: a
        mail-to-fax or mail-to-phone transformer, a filter, a language translator, a mailing
-       list manager, etc. Several Mailets are included in the JAMES
-       distribution (see <a href="documentation.html">documentation</a>).</p>
-        <p>
-          <i>
-            <b>Resource abstraction</b>
-          </i>  Like protocols, resources are abstracted and,
+       list manager, etc. Several Mailets are included in the James
+       distribution (see <a href="dev-provided-mailets.html">documentation</a>).</p>
+
+        <p><i><b>Resource abstraction</b></i>  Like protocols, resources are abstracted and,
        accessed through defined interfaces (JavaMail for transport, JDBC for
        spool storage or user accounts in RDBMS's, Apache Mailet API). The server is
        highly modular and reuse solutions from other projects.</p>
-        <p>
-          <i>
-            <b>Secure and multi-threaded design</b>
-          </i>  Based on the technology developed
-       for the Apache JServ servlet engine, Apache James has a careful,
+
+        <p><i><b>Secure and multi-threaded design</b></i>  Based on well known
+        frameworks such as Spring, ActiveMQ, OpenJPA, Netty,..., Apache James has a careful,
        security-oriented, full multi-threaded design, to allow performance,
        scalability and mission-critical use.</p>
+
         <p>Anything else you may want if you help us write it :-)</p>
+
       </subsection>
-      <subsection name="Standards compliance">
+
+      <subsection name="Standards Compliance">
+
         <p>It is the existence of published "open" standards which 
-      allows independant teams to develop interoperable software.
-      <br/>James attempts to support a number of these standards most of which are 
+      allows independant teams to develop interoperable software.</p>
+      
+      <p>James attempts to support a number of these standards most of which are 
       IETF RFC's and in the areas covered by these standards the published standard 
-      is our requirements document.
-      <br/>This sometimes leads to confusion where behaviour is not 
+      is our requirements document.</p>
+      
+      <p>This sometimes leads to confusion where behaviour is not 
       the subject of a relevant standard, or conflict where common 
-      (de-facto) behaviour is actually at odds with a supported standard.
-      <br/>We believe that it is our responsibility to adhere to the published standard. 
+      (de-facto) behaviour is actually at odds with a supported standard.</p>
+      
+      <p>We believe that it is our responsibility to adhere to the published standard. 
       If we allow our implementation to deviate it means that we are tacitly encouraging 
       the situation whereby interoperability is no longer guarenteed by standards 
       compliance alone, but also requires access to undocumented and possibly 
       even commercially licenced technology. There is no easy route for a 
       newcomer to aquire these secrets, and interoperabilty 
       becomes something only available to the elite.</p>
+      
       <p>The James policy for issues of non-compliance tries to tread the fine line
       between a pragmatic acceptance of other people's misinterpretation of the
       RFC's and an evangelical defence of open standards as the key to freedom of interoperation.</p>
+      
       <p>In practice this policy is that certain well argued of cases of
       non-compliance which can be *safely* worked around, will be tolerated by
       James.</p>
+      
       <p>In cases (like jira issue JAMES-344) where variance from a published standard is
       required it is desirable that this functionality is disabled in James by default,
       it must be prominently and clearly documented that this causes James 
       to violate the relevant standard, and should be enabled by explicit 
       configuration, making its use a conscious decision of the user rather 
       than an decision taken by the James team.</p>
+      
       <p>In cases where the required behaviour is not within the scope of any standard which
       James claims to support (such as behaviour which is a de-facto standard or
       an <i>internet draft</i> RFC but not yet subject of a <i>standards track</i> RFC) it is
       acceptable to implement the behaviour so long as it is adequately
       documented (for instance by refrence to an <i>internet draft</i> or 
       other public document) and users can be clear about what to expect from James.</p>
+
       </subsection>
 
   </section>

Modified: james/server/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/index.xml?rev=1032098&r1=1032097&r2=1032098&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/index.xml (original)
+++ james/server/trunk/src/site/xdoc/index.xml Sat Nov  6 15:44:59 2010
@@ -62,16 +62,18 @@
 	    
 	    <p>This documentation is intended to be an introduction to the concepts behind the James usage, as well 
 	      as a guide to <a href="install.html">install</a>, <a href="config.html">configure</a> 
+	      <a href="manage.html">manage</a>, <a href="monitor.html">monitor</a> 
 	      and <a href="dev.html">develop</a> James server.</p>
-
-        <p>Download James Mail Server.</p>
+	      
+        <p>Download James Mail Server 3.0-M2 and <a href="quick-start.html">quick-start</a> it!</p>
         <p>
           <span class="minibutton btn-download">
-            <a href="javascript:window.location='http://james.apache.org/download.cgi#Apache-James-Server';">
+            <a href="javascript:window.location='http://james.apache.org/download.cgi#Apache_James_Server';">
               <span><span class="icon"></span>Early James Server 3.0-M2</span>
             </a>
           </span>
         </p>
+        <p>For the very courageous ones, we also have snapshot builds for You (no guarantee!).</p>
         <p>
           <span class="minibutton btn-download">
             <a href="javascript:window.location='http://people.apache.org/builds/james/nightly/';">
@@ -101,11 +103,16 @@
 	        <p>100% pure Java Mail server designed to be a complete and portable enterprise 
 	           mail engine solution.</p>
 	           
-	        <p>Supports currently available IETF protocols, including SMTP, LMTP, POP3 and IMAP4 
-	           James is able to store user and message data either in a file-system (Maildir), 
+	        <p>Supports currently available IETF protocols, including SMTP, LMTP, POP3 and IMAP4.</p>
+	         
+	        <p>James is able to store user and message data either in a file-system (Maildir), 
 	           any JPA-compatible database and even JCR, allowing fast, reliable, 
 	           even real-time replicated storage.</p>
 	         
+	        <p>Provides a powerful, flexible mail application engine through support for the Apache Mailet 
+	           API.  With its Mailet pipeline architecture, James can be used not only to provide standard e-mail 
+	           services, but also to implement custom e-mail applications.</p>
+	           
 	      </subsection>
 		      
          </td><td width="50%">
@@ -114,7 +121,7 @@
           
             <p>Configure the stores,... via the well-known Spring framework - <a href="config.html">read more</a>.</p>
         
-            <img src="images/conf/config-example.png" height="400px" />
+            <p><img src="images/conf/config-example.png" height="400px" /></p>
         
           </subsection>
           
@@ -126,7 +133,7 @@
         
             <p>Manage domains, users,... via well-known JMX tools - <a href="manage.html">read more</a>.</p>
             
-            <img src="images/jmx-management/jmx-user-part.png" />
+            <p><img src="images/jmx-management/jmx-user-part.png" /></p>
 
           </subsection>
           
@@ -134,15 +141,16 @@
 
   	      <subsection name="Extensible">
 	    
-	        <p>James serves as a mail application platform.  The James project hosts the Apache Mailet API, 
-	          and provides the Mailet container. These features makes it easy to design, write, and deploy 
-	          custom applications for mail processing.  This modularity and ease of customization is one of James' 
-	          strengths, and can allow administrators to produce powerful applications surprisingly easily.</p>
+	        <p>James serves as a mail application platform.</p>
+	        
+	        <p>The James project hosts the Apache Mailet API, 
+	          and provides the Mailet container. These features makes it easy
+	          to design, write, and deploy custom applications for mail processing.</p>
+	          
+	        <p>This modularity and ease of customization is one of James' 
+	           strengths, and can allow administrators to produce powerful
+               applications surprisingly easily.</p>
 	 
-	        <p>Provides a powerful, flexible mail application engine through support for the Apache Mailet 
-	           API.  With its Mailet pipeline architecture, James can be used not only to provide standard e-mail 
-	           services, but also to implement custom e-mail applications.</p>
-	           
 	      </subsection>
 
          </td></tr>
@@ -157,9 +165,9 @@
 	           Spring container provides a strong foundation for the James server.</p>
 	    
 	        <p>The internal and exposed APIs for this 3.0-M2 release are under current validation and are 
-	          expected to be subject to change - <a href="dev-architecture.html">read more</a>.</p>
+	          expected to be subject to change - <a href="dev.html">read more</a>.</p>
 	         
-            <img src="images/uml/org.apache.james-package-small.png" width="400px" />
+            <p><img src="images/uml/org.apache.james-package-small.png" width="400px" /></p>
         
   	      </subsection>
   	      
@@ -173,7 +181,7 @@
                version 3.0 is able to maintain a constant mail throughput rate of thousands of 
 	           messages/minute for continuous periods  - <a href="feature-performance.html">read more</a></p>
 
-            <img src="images/jmx-monitoring/jmx-process-root.png" height="400px" />
+            <p><img src="images/jmx-monitoring/jmx-process-root.png" height="400px" /></p>	
         
           </subsection>
          

Modified: james/server/trunk/src/site/xdoc/release-notes.xml
URL: http://svn.apache.org/viewvc/james/server/trunk/src/site/xdoc/release-notes.xml?rev=1032098&r1=1032097&r2=1032098&view=diff
==============================================================================
--- james/server/trunk/src/site/xdoc/release-notes.xml (original)
+++ james/server/trunk/src/site/xdoc/release-notes.xml Sat Nov  6 15:44:59 2010
@@ -55,14 +55,14 @@
 <p>If you're interested in contributing to the James project, please subscribe to the James 
   <a href="http://james.apache.org/mail.html">mailing lists</a>.</p>
 
-<h2>Bug</h2>
+<h3>Bug</h3>
 <ul>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-241'>JAMES-241</a>] - fail gracefully upon large messages/attachments</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-302'>JAMES-302</a>] - Functionality of org.apache.james.dnsserver.DNSServer.getByName(String) is not symetric to java.net.InetAddress.getByName(String)</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-344'>JAMES-344</a>] - FetchMail cannot parse particular format of "Received" header</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-457'>JAMES-457</a>] - POP3 server doesn't perform an exlusive-access locks in a transaction required by rcf1939.</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-717'>JAMES-717</a>] - AbstractStorageQuota  use one queriesper mail  to calculate the mailbox size . This is very ineffective and can cause problems with sql</li>
-<li>[<a href='https://issues.apache.org/jira/browse/JAMES-795'>JAMES-795</a>] - CLONE -If FetchMail cannot parse Received header, it cannot process the message even with <remotereceivedheader reject="false".../></li>
+<li>[<a href='https://issues.apache.org/jira/browse/JAMES-795'>JAMES-795</a>] - CLONE -If FetchMail cannot parse Received header, it cannot process the message even with &lt;remotereceivedheader reject="false"...&gt;</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-900'>JAMES-900</a>] - Possible race-condition in MimeMessageCopyOnWriteProxy</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1009'>JAMES-1009</a>] - Cleaning up DB enteries upon user account deletion </li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1102'>JAMES-1102</a>] -  james-listmanager.xml file: invalid XML file format</li>
@@ -75,7 +75,7 @@
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1116'>JAMES-1116</a>] - James fails to start when JCR Mailbox is used because of incorrect spring-beans.xml entries</li>
 </ul>
     
-<h2>Improvement</h2>
+<h3>Improvement</h3>
 <ul>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-348'>JAMES-348</a>] - make JDK independent (e.g. also IBM JVM should work)</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-640'>JAMES-640</a>] - large attachment (3 or more Mbyte) will make mbox repository very slow</li>
@@ -87,13 +87,13 @@
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1108'>JAMES-1108</a>] - Rewrite ActiveMQQueue to use BlobMessages and a custom BlobTransferPolicy</li>
 </ul>
     
-<h2>New Feature</h2>
+<h3>New Feature</h3>
 <ul>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-948'>JAMES-948</a>] - Composite pattern employed to implement And, Or, Xor and Not matcher.</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1114'>JAMES-1114</a>] - Add Handler for the SMTPHandlerChain which set mail priority</li>
 </ul>
                     
-<h2>Task</h2>
+<h3>Task</h3>
 <ul>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-885'>JAMES-885</a>] - Remote Manager Decoupling</li>
 <li>[<a href='https://issues.apache.org/jira/browse/JAMES-1076'>JAMES-1076</a>] - Allign packages for MBeans or use StandardMBean</li>



---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org