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/24 15:48:02 UTC

svn commit: r1127050 - in /james/mailbox/trunk/src/site: ./ resources/images/uml/ xdoc/

Author: eric
Date: Tue May 24 13:48:01 2011
New Revision: 1127050

URL: http://svn.apache.org/viewvc?rev=1127050&view=rev
Log:
Introduce one documentation page per mailbox module and bring in some class diagrams (MAILBOX-47)

Added:
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxmanager.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxsession.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-messagemanager.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-subscriptionmanager.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-jpa-managers.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-maildir-managers.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-memory-managers.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-package.png
      - copied unchanged from r1125992, james/mailbox/trunk/src/site/resources/images/uml/org.apache.james.mailbox-package.png
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-mailboxmanager.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-messagemanager.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-model.png   (with props)
    james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-subscriptionmanager.png   (with props)
    james/mailbox/trunk/src/site/xdoc/mailbox-api.xml
    james/mailbox/trunk/src/site/xdoc/mailbox-jcr.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
    james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml
Removed:
    james/mailbox/trunk/src/site/resources/images/uml/org.apache.james.mailbox-package.png
Modified:
    james/mailbox/trunk/src/site/site.xml
    james/mailbox/trunk/src/site/xdoc/index.xml
    james/mailbox/trunk/src/site/xdoc/source-code.xml

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxmanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxmanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxmanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxsession.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxsession.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-mailboxsession.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-messagemanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-messagemanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-messagemanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-subscriptionmanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-subscriptionmanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-api-subscriptionmanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-jpa-managers.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-jpa-managers.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-jpa-managers.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-maildir-managers.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-maildir-managers.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-maildir-managers.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-memory-managers.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-memory-managers.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-memory-managers.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-mailboxmanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-mailboxmanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-mailboxmanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-messagemanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-messagemanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-messagemanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-model.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-model.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-model.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-subscriptionmanager.png
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-subscriptionmanager.png?rev=1127050&view=auto
==============================================================================
Binary file - no diff available.

Propchange: james/mailbox/trunk/src/site/resources/images/uml/org-apache-james-mailbox-store-subscriptionmanager.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: james/mailbox/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/site.xml?rev=1127050&r1=1127049&r2=1127050&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/site.xml (original)
+++ james/mailbox/trunk/src/site/site.xml Tue May 24 13:48:01 2011
@@ -43,6 +43,13 @@
     <menu name="Mailbox">
       <item name="Introduction" href="/index.html" />
       <item name="Source Code" href="/source-code.html" />
+      <item name="Mailbox API" href="/mailbox-api.html" />
+      <item name="Mailbox Store" href="/mailbox-store.html" />
+      <item name="Mailbox Memory" href="/mailbox-memory.html" />
+      <item name="Mailbox Maildir" href="/mailbox-maildir.html" />
+      <item name="Mailbox JPA" href="/mailbox-jpa.html" />
+      <item name="Mailbox JCR" href="/mailbox-jcr.html" />
+      <item name="Mailbox Tool" href="/mailbox-tool.html" />
     </menu>  
      
     <menu name="References">

Modified: james/mailbox/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/index.xml?rev=1127050&r1=1127049&r2=1127050&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/index.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/index.xml Tue May 24 13:48:01 2011
@@ -53,7 +53,13 @@
 
   <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>
-    <img src="images/uml/org.apache.james.mailbox-package.png"/>
+    <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>, 
+    <a href="mailbox-maildir.html">Maildir</a>, 
+    <a href="mailbox-jpa.html">JPA</a>, 
+    <a href="mailbox-jcr.html">JCR)</a>.</p>
+    <img src="images/uml/org-apache-james-mailbox-package.png"/>
   </section>
 
 </body>

Added: 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=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-api.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-api.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox API</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Interfaces">
+  
+    <subsection name="Mailbox Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-api-mailboxmanager.png"/></p>
+    </subsection>
+    
+    <subsection name="Message Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-api-messagemanager.png"/></p>
+    </subsection>
+
+    <subsection name="Subscription Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-api-subscriptionmanager.png"/></p>
+    </subsection>
+
+  </section>
+
+</body>
+
+</document>

Added: james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml?rev=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox JCR</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Classes">
+  </section>
+
+</body>
+
+</document>

Added: 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=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox JPA</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Classes">
+    <p><img src="images/uml/org-apache-james-mailbox-jpa-managers.png"/></p>
+  </section>
+
+</body>
+
+</document>

Added: 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=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox Maildir</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Classes">
+    <p><img src="images/uml/org-apache-james-mailbox-maildir-managers.png"/></p>
+  </section>
+
+</body>
+
+</document>

Added: 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=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox Memory</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Classes">
+    <p><img src="images/uml/org-apache-james-mailbox-memory-managers.png"/></p>
+  </section>
+
+</body>
+
+</document>

Added: 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=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-store.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-store.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox Store</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Store Model">
+    <p><img src="images/uml/org-apache-james-mailbox-store-model.png"/></p>
+  </section>
+
+  <section name="Classes">
+  
+    <subsection name="Store Mailbox Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-store-mailboxmanager.png"/></p>
+    </subsection>
+
+    <subsection name="Store Message Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-store-messagemanager.png"/></p>
+    </subsection>
+
+    <subsection name="Store Subscription Manager">
+      <p><img src="images/uml/org-apache-james-mailbox-store-subscriptionmanager.png"/></p>
+    </subsection>
+    
+  </section>
+
+</body>
+
+</document>

Added: james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml?rev=1127050&view=auto
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml (added)
+++ james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml Tue May 24 13:48:01 2011
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.    
+-->
+<document>
+
+  <properties>
+     <title>Mailbox API</title>
+  </properties>
+
+<body>
+
+  <section name="Responsibility">
+  </section>
+
+  <section name="Classes">
+  </section>
+
+</body>
+
+</document>

Modified: james/mailbox/trunk/src/site/xdoc/source-code.xml
URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/source-code.xml?rev=1127050&r1=1127049&r2=1127050&view=diff
==============================================================================
--- james/mailbox/trunk/src/site/xdoc/source-code.xml (original)
+++ james/mailbox/trunk/src/site/xdoc/source-code.xml Tue May 24 13:48:01 2011
@@ -47,7 +47,7 @@
 
   <section name="Source Code Organization">
     <div style="float:left; margin=4px;">
-      <img src="images/uml/org.apache.james.mailbox-package.png"/>
+      <img src="images/uml/org-apache-james-mailbox-package.png"/>
     </div>
   </section>
 



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