svn commit: r1510921 - in /directory/site/trunk/content/mavibot: download-old-versions.mdtext downloads.mdtext index.mdtext

[el...@apache.org]

Author: elecharny
Date: Tue Aug  6 12:15:55 2013
New Revision: 1510921

URL: http://svn.apache.org/r1510921
Log:
Added a first page on Mavibot

Added:
    directory/site/trunk/content/mavibot/download-old-versions.mdtext
    directory/site/trunk/content/mavibot/downloads.mdtext
Modified:
    directory/site/trunk/content/mavibot/index.mdtext

Added: directory/site/trunk/content/mavibot/download-old-versions.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/mavibot/download-old-versions.mdtext?rev=1510921&view=auto
==============================================================================
--- directory/site/trunk/content/mavibot/download-old-versions.mdtext (added)
+++ directory/site/trunk/content/mavibot/download-old-versions.mdtext Tue Aug  6 12:15:55 2013
@@ -0,0 +1,49 @@
+Title: Download Old Versions
+Notice: 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.
+
+# Download Old Versions
+
+There is currently no old versions ...
+
+<DIV class="note" markdown="1">
+We encourage you to verify the integrity of the downloaded file using:
+
+* the ASC file (OpenPGP compatible signature) with the [KEYS](http://www.apache.org/dist/directory/KEYS) file (code signing keys used to sign the product)
+* the MD5 file (checksum).
+</DIV>
+
+## Verify the integrity of the file
+
+The PGP signatures can be verified using PGP or GPG. First download the [keys](http://www.apache.org/dist/directory/KEYS) file as well as the asc signature file for the relevant distribution. Then verify the signatures using:
+
+	$ pgpk -a KEYS
+	$ pgpv apache_1.3.24.tar.gz.asc
+
+or
+
+	$ pgp -ka KEYS
+	$ pgp apache_1.3.24.tar.gz.asc
+
+or
+
+	$ gpg --import KEYS
+	$ gpg --verify apache_1.3.24.tar.gz.asc
+
+ 
+
+Alternatively, you can verify the MD5 signature on the files. A unix program called md5 or md5sum is included in many unix distributions. It is also available as part of [GNU Textutils](http://www.gnu.org/software/textutils/textutils.html). Windows users can get binary md5 programs from [here](http://www.fourmilab.ch/md5/), [here](http://www.pc-tools.net/win32/freeware/console/], or [here|http://www.slavasoft.com/fsum/).
\ No newline at end of file

Added: directory/site/trunk/content/mavibot/downloads.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/mavibot/downloads.mdtext?rev=1510921&view=auto
==============================================================================
--- directory/site/trunk/content/mavibot/downloads.mdtext (added)
+++ directory/site/trunk/content/mavibot/downloads.mdtext Tue Aug  6 12:15:55 2013
@@ -0,0 +1,36 @@
+Title: Mavibot Downloads
+Notice: 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.
+
+# Downloads
+
+## Jar Download 
+
+The Apache Mavibot package is distributed as a jar.
+
+* ![Download](../images/download-archive.png) [Download Archive zip/tar.gz](download/download-archive.html)
+* ![Download](../images/download-sources.png) [Download Sources](download/download-sources.html)
+
+## Maven Dependency
+
+The Apache Mavibot package is also available as a Maven dependency:
+
+    <dependency>
+        <groupId>org.apache.directory.mavibot</groupId>
+        <artifactId>mavibit</artifactId>
+        <version>${mavibit-version}</version>
+    </dependency>
\ No newline at end of file

Modified: directory/site/trunk/content/mavibot/index.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/mavibot/index.mdtext?rev=1510921&r1=1510920&r2=1510921&view=diff
==============================================================================
--- directory/site/trunk/content/mavibot/index.mdtext (original)
+++ directory/site/trunk/content/mavibot/index.mdtext Tue Aug  6 12:15:55 2013
@@ -18,8 +18,38 @@ Notice: Licensed to the Apache Software 
 
 # Apache Mavibot&trade;
 
-Apache MAVIBOT 
+Mavibot is a MVCC B+Tree implementation in Java.
 
-This is a schema aware API, with some convenient ways to access a LDAP server. This API is not only targeting the Apache Directory Server, but should work pristine with any LDAP server.
+## Btree basics
+
+A *Btree* is a data structure that stores _<Key, Value>_ tuples in a tree, with the guarantee that the tree will be ordered, and that the depth of the tree is the same for all the leaves. A *Btree* has nodes and leaves (with the only exception of a *Btree* with only a root page). The nodes are used to route to the underlying values, and have children. Leaves don't have children.
+
+Nodes and leaves have a maximum number of elements stored into them, and when they are full, they are split. If the split is done on a leaf, we may have to reorganize the tree so that either we can move some elements up and keep the tree at the current height, or we may have to reorganize the full tree so that all the leaves are at the same level, which will then be one deeper (if we added some value) than the tree before the split.
+
+## Btree vs B+Tree
+
+The difference between those two data structures is that *Btree* store values in the nodes, when *B+Tree* do store all the values in leaves.
+
+At first glance, we can say that finding a value in a *Btree* will be faster, as we may not go down to the leaves to find it. OTOH, a *B+Tree* has many advantages, but the two major advantages are :
+
+* we don't need to go up in the tree to browse the tree when searching for more than one value, we can just read the leaves, as they are chained.
+* We will have smaller nodes, so we can cache more of the tree pages than if we have values in the nodes.
+
+Those two big advantages make the *B+Tree* more interesting to use than the simpler *Btree*.
+
+(See [Wikipedia page on B+tree](http://en.wikipedia.org/wiki/B%2B_tree) and [Wikipedia page on Btree](http://en.wikipedia.org/wiki/B-tree) )
+
+
+## MVCC
+[MVCC](http://en.wikipedia.org/wiki/Multiversion_concurrency_control) (Multi Version Concurrency Control) is a way to provide concurrent access to the *Btree* (it's extensively used in many other areas, like programming languages and transactional memory). The main idea is to create a new version of the tree each time we do a modification. It also allows the reorganization of the data on the fly, but this is an extra benefit.
+
+The way it works is that when you do a search on the tree, you first acquire the current revision. Even if the search is taking a while, because it fetches many values, the tree will remain unchanged for the selected revision
+
+Any modification done on the tree will first create a new revision, and the modified pages will first be copied, so that the previous versions will still be available for any search operation being executed at the same time.
+
+It has three direct consequences :
+
+ * first, a search will always return 'outdated' values, in the way that new data won't be returned, as they will be stored in a version which is newer.
+ * Second, and more important, we don't need any lock to access the data when doing a search, as there is no possible modification on a versioned tree.
+ * Third, concurrent modifications are thus limited, as we want to be sure that we don't override some modification done by another thread. They are ways to mitigate this constraints, but in most of the case, it's acceptable.
 
-It's also an extensible API : new Controls, schema elements and network layer could be added or used in the near future. It's also OSGi capable.