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 2011/05/25 14:02:14 UTC
svn commit: r1127486 - in /james/mailbox/trunk/src/site:
resources/images/uml/org-apache-james-mailbox-api-msc.png xdoc/index.xml
xdoc/mailbox-api.xml xdoc/mailbox-jpa.xml xdoc/mailbox-maildir.xml
xdoc/mailbox-memory.xml xdoc/mailbox-store.xml
Author: eric
Date: Wed May 25 12:02:14 2011
New Revision: 1127486
URL: http://svn.apache.org/viewvc?rev=1127486&view=rev
Log:
Comment some Mailbox class diagrams (MAILBOX-47)
Added:
james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-msc.png (with props)
Modified:
james/mailbox/trunk/src/site/xdoc/index.xml
james/mailbox/trunk/src/site/xdoc/mailbox-api.xml
james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml
james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml
james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml
james/mailbox/trunk/src/site/xdoc/mailbox-store.xml
Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-msc.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-msc.png?rev=1127486&view=auto
==============================================================================
Binary file - no diff available.
Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-msc.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: james/mailbox/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/index.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/index.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/index.xml Wed May 25 12:02:14 2011
@@ -52,7 +52,8 @@
</section>
<section name="Develop on Apache James Mailbox">
- <p>Go to the <a href="source-code.html">source code</a> page to get more information on how to develop on James Mailbox.</p>
+ <p>Go to the <a href="source-code.html">source code</a> page to get more information on how to
+ develop on Apache James Mailbox.</p>
<p>You can also read more on the <a href="mailbox-api.html">Mailbox API</a>,
the base and utility classes (<a href="mailbox-store.html">Mailbox Store</a>)
and the different implementation we propose (<a href="mailbox-memory.html">Memory</a>,
Modified: james/mailbox/trunk/src/site/xdoc/mailbox-api.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-api.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-api.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-api.xml Wed May 25 12:02:14 2011
@@ -26,23 +26,47 @@
<body>
<section name="Responsibility">
+ <p>This module contains the interfaces and exceptions to be used by the
+ mailbox clients. It represents the "external view" of the mailbox
+ library client.</p>
+ <p>The services the mailbox library provides can be summarized as "store/retrieve/search/delete mails"
+ and update the mails metadata (via uid and flags)</p>
+ <p>The main entrance interfaces are represented by 3 managers, each responsible
+ for a specific area: the mailbox manager, the message manager and the
+ subscription manager.</p>
+ <p>For example, Apache James Server injects the managers in the POP3, SMTP, IMAP4 servers
+ and in the Mailet container.</p>
+ <p>Each implementation (<a href="mailbox-memory.html">Memory</a>,
+ <a href="mailbox-maildir.html">Maildir</a>,
+ <a href="mailbox-jpa.html">JPA</a>,
+ <a href="mailbox-jcr.html">JCR)</a>) is responsible
+ to implement the management interfaces. All "common/util" implementations
+ reside in the <a href="mailbox-store.html">Mailbox Store</a> module.</p>
</section>
- <section name="Interfaces">
+ <section name="Manager Interfaces">
<subsection name="Mailbox Manager">
+ <p>The Mailbox Manager is responsible for session creation, operations on mailbox (create, delete, search)
+ and to return a Message Manager. It also allows to copy and list messages.</p>
<p><img src="images/uml/org-apache-james-mailbox-api-mailboxmanager.png"/></p>
</subsection>
<subsection name="Message Manager">
+ <p>The Message Manager is responsible to create, delete message and its associated metadata (the uid and the flags).</p>
<p><img src="images/uml/org-apache-james-mailbox-api-messagemanager.png"/></p>
</subsection>
<subsection name="Subscription Manager">
+ <p>The Subscription Manager is responsible for the (un)subscription between a user and a mailbox.</p>
<p><img src="images/uml/org-apache-james-mailbox-api-subscriptionmanager.png"/></p>
</subsection>
</section>
+
+ <section name="Other Interfaces and Classes">
+ <p><img src="images/uml/org-apache-james-mailbox-api-msc.png"/></p>
+ </section>
</body>
Modified: james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml Wed May 25 12:02:14 2011
@@ -29,7 +29,11 @@
</section>
<section name="Classes">
- <p><img src="images/uml/org-apache-james-mailbox-jpa-managers.png"/></p>
+
+ <subsection name="Managers">
+ <p><img src="images/uml/org-apache-james-mailbox-jpa-managers.png"/></p>
+ </subsection>
+
</section>
</body>
Modified: james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml Wed May 25 12:02:14 2011
@@ -29,7 +29,11 @@
</section>
<section name="Classes">
- <p><img src="images/uml/org-apache-james-mailbox-maildir-managers.png"/></p>
+
+ <subsection name="Managers">
+ <p><img src="images/uml/org-apache-james-mailbox-maildir-managers.png"/></p>
+ </subsection>
+
</section>
</body>
Modified: james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml Wed May 25 12:02:14 2011
@@ -29,7 +29,11 @@
</section>
<section name="Classes">
- <p><img src="images/uml/org-apache-james-mailbox-memory-managers.png"/></p>
+
+ <subsection name="Managers">
+ <p><img src="images/uml/org-apache-james-mailbox-memory-managers.png"/></p>
+ </subsection>
+
</section>
</body>
Modified: james/mailbox/trunk/src/site/xdoc/mailbox-store.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-store.xml?rev=1127486&r1=1127485&r2=1127486&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-store.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-store.xml Wed May 25 12:02:14 2011
@@ -26,23 +26,36 @@
<body>
<section name="Responsibility">
+ <p>The Mailbox Store is responsible for all "common/util" implementations that can be
+ used by the various Mailbox implementations.</p>
</section>
<section name="Store Model">
+ <p>The main classes are the Mailbox and the Message.
+ A Message contains a list of Property and a list of Header.
+ A Subscription has a mailbox and a user attribute.</p>
<p><img src="images/uml/org-apache-james-mailbox-store-model.png"/></p>
</section>
- <section name="Classes">
+ <section name="Managers">
<subsection name="Store Mailbox Manager">
+ <p>All public and protected methods that can be used by a Mailbox Manager implementations.</p>
+ <p>You need to instanciate the StoreMailboxManager with a mailboxSessionMapperFactory,
+ an authenticator, a uidProvider and a mailboxPathlocker.</p>
<p><img src="images/uml/org-apache-james-mailbox-store-mailboxmanager.png"/></p>
</subsection>
<subsection name="Store Message Manager">
+ <p>All public and protected methods that can be used by a Message Manager implementations.</p>
+ <p>You need to instanciate the StoreMessageManager with a messageSessionMapperFactory,
+ a uidProvider, a mailboxEventDispatcher and a mailbox.</p>
<p><img src="images/uml/org-apache-james-mailbox-store-messagemanager.png"/></p>
</subsection>
<subsection name="Store Subscription Manager">
+ <p>All public and protected methods that can be used by a Subscription Manager implementations.</p>
+ <p>You need to instanciate the StoreSubscriptionManager with a subscriptionSessionMapperFactory.</p>
<p><img src="images/uml/org-apache-james-mailbox-store-subscriptionmanager.png"/></p>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org