You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by bu...@apache.org on 2013/09/20 19:45:19 UTC
svn commit: r879188 - in /websites/staging/directory/trunk/content: ./
mavibot/user-guide/ mavibot/user-guide/images/
Author: buildbot
Date: Fri Sep 20 17:45:19 2013
New Revision: 879188
Log:
Staging update by buildbot for directory
Added:
websites/staging/directory/trunk/content/mavibot/user-guide/
websites/staging/directory/trunk/content/mavibot/user-guide/1-introduction.html
websites/staging/directory/trunk/content/mavibot/user-guide/2-internals.html
websites/staging/directory/trunk/content/mavibot/user-guide/2.1-file-format.html
websites/staging/directory/trunk/content/mavibot/user-guide/images/
websites/staging/directory/trunk/content/mavibot/user-guide/images/PageIOLogical.png (with props)
Modified:
websites/staging/directory/trunk/content/ (props changed)
Propchange: websites/staging/directory/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Sep 20 17:45:19 2013
@@ -1 +1 @@
-1523001
+1525066
Added: websites/staging/directory/trunk/content/mavibot/user-guide/1-introduction.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/user-guide/1-introduction.html (added)
+++ websites/staging/directory/trunk/content/mavibot/user-guide/1-introduction.html Fri Sep 20 17:45:19 2013
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+<!--
+ 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.
+-->
+<html>
+ <head>
+ <title>1 - Introduction — Apache Directory</title>
+
+ <link href="./../../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../../css/turquoise.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../../images/mavibot-icon_16x16.png">
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ _uacct = "UA-1358462-1";
+ urchinTracker();
+ </script>
+ </head>
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="subProjectsNavBar">
+ <a href="./../../">
+
+ Apache Directory Project
+
+ </a>
+ |
+ <a href="./../../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../../studio">
+
+ Apache Directory Studio
+
+ </a>
+ |
+ <a href="./../../api">
+
+ Apache LDAP API
+
+ </a>
+ |
+ <a href="./../../mavibot">
+
+ <STRONG>Mavibot</STRONG>
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <h5>Mavibot 1.0</h5>
+ <ul>
+ <li><a href="./../../mavibot/">Home</a></li>
+ <li><a href="./../../mavibot/news.html">News</a></li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../../mavibot/downloads.html">Version 1.0.0-M1</a> <IMG src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../../mavibot/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../../mavibot/vision.html">Vision</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../../mavibot/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../../mavibot/user-guide.html">User Guide</a></li>
+ <li><a href="./../../mavibot/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <!--li><a href="./../../mavibot/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../../mavibot/developer-guide.html">Developer Guide</a></li>
+ </ul>
+
+
+ <h5>Support</h5>
+ <ul>
+ <li><a href="./../../mailing-lists-and-irc.html">Mailing Lists & IRC</a></li>
+ <li><a href="./../../sources.html">Sources</a></li>
+ <li><a href="./../../issue-tracking.html">Issue Tracking</a></li>
+ <li><a href="./../../commercial-support.html">Commercial Support</a></li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li><a href="./../../contribute.html">How to Contribute</a></li>
+ <li><a href="./../../team.html">Team</a></li>
+ <li><a href="./../../original-project-proposal.html">Original Project Proposal</a></li>
+ <li><a href="./../../special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
+ </ul>
+ <h5>About Apache</h5>
+ <ul>
+ <li><a href="http://www.apache.org/">Apache</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../../images/banner-ldapcon-2013.png" alt="LDAPCon 2013" width="167" height="231"></a>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+<h1 id="1-introduction">1 - Introduction</h1>
+<p>This Mavibot Guide goal is to provide some clue for any developer wanting to use Mavibot. </p>
+<p>It also gives some insights about how Mavibot is built and how it works.</p>
+<p>We hope it will be enough for you to quickly get started, but in any case, if you feel like improving this document, feel free to post your suggestion to the Apache Directory mailing list : any contribution is welcomed !</p>
+<h2 id="contents">Contents</h2>
+<ul>
+<li>[1.1 - .html)</li>
+</ul>
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2012, <a href="http://www.apache.org">The Apache Software Foundation</a> - <a href="./../../privacy-policy.html">Privacy Policy</a><br />
+ Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
Added: websites/staging/directory/trunk/content/mavibot/user-guide/2-internals.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/user-guide/2-internals.html (added)
+++ websites/staging/directory/trunk/content/mavibot/user-guide/2-internals.html Fri Sep 20 17:45:19 2013
@@ -0,0 +1,187 @@
+<!DOCTYPE html>
+<!--
+ 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.
+-->
+<html>
+ <head>
+ <title>1 - Introduction — Apache Directory</title>
+
+ <link href="./../../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../../css/turquoise.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../../images/mavibot-icon_16x16.png">
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ _uacct = "UA-1358462-1";
+ urchinTracker();
+ </script>
+ </head>
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="subProjectsNavBar">
+ <a href="./../../">
+
+ Apache Directory Project
+
+ </a>
+ |
+ <a href="./../../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../../studio">
+
+ Apache Directory Studio
+
+ </a>
+ |
+ <a href="./../../api">
+
+ Apache LDAP API
+
+ </a>
+ |
+ <a href="./../../mavibot">
+
+ <STRONG>Mavibot</STRONG>
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <h5>Mavibot 1.0</h5>
+ <ul>
+ <li><a href="./../../mavibot/">Home</a></li>
+ <li><a href="./../../mavibot/news.html">News</a></li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../../mavibot/downloads.html">Version 1.0.0-M1</a> <IMG src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../../mavibot/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../../mavibot/vision.html">Vision</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../../mavibot/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../../mavibot/user-guide.html">User Guide</a></li>
+ <li><a href="./../../mavibot/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <!--li><a href="./../../mavibot/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../../mavibot/developer-guide.html">Developer Guide</a></li>
+ </ul>
+
+
+ <h5>Support</h5>
+ <ul>
+ <li><a href="./../../mailing-lists-and-irc.html">Mailing Lists & IRC</a></li>
+ <li><a href="./../../sources.html">Sources</a></li>
+ <li><a href="./../../issue-tracking.html">Issue Tracking</a></li>
+ <li><a href="./../../commercial-support.html">Commercial Support</a></li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li><a href="./../../contribute.html">How to Contribute</a></li>
+ <li><a href="./../../team.html">Team</a></li>
+ <li><a href="./../../original-project-proposal.html">Original Project Proposal</a></li>
+ <li><a href="./../../special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
+ </ul>
+ <h5>About Apache</h5>
+ <ul>
+ <li><a href="http://www.apache.org/">Apache</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../../images/banner-ldapcon-2013.png" alt="LDAPCon 2013" width="167" height="231"></a>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+<h1 id="1-introduction">1 - Introduction</h1>
+<p>This Mavibot Guide goal is to provide some clue for any developer wanting to use Mavibot. </p>
+<p>It also gives some insights about how Mavibot is built and how it works.</p>
+<p>We hope it will be enough for you to quickly get started, but in any case, if you feel like improving this document, feel free to post your suggestion to the Apache Directory mailing list : any contribution is welcomed !</p>
+<h2 id="contents">Contents</h2>
+<ul>
+<li>[1.1 - .html)</li>
+</ul>
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2012, <a href="http://www.apache.org">The Apache Software Foundation</a> - <a href="./../../privacy-policy.html">Privacy Policy</a><br />
+ Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
Added: websites/staging/directory/trunk/content/mavibot/user-guide/2.1-file-format.html
==============================================================================
--- websites/staging/directory/trunk/content/mavibot/user-guide/2.1-file-format.html (added)
+++ websites/staging/directory/trunk/content/mavibot/user-guide/2.1-file-format.html Fri Sep 20 17:45:19 2013
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<!--
+ 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.
+-->
+<html>
+ <head>
+ <title>2.1 - File Format — Apache Directory</title>
+
+ <link href="./../../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../../css/turquoise.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../../images/mavibot-icon_16x16.png">
+
+ <!-- Google Analytics -->
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+ <script type="text/javascript">
+ _uacct = "UA-1358462-1";
+ urchinTracker();
+ </script>
+ </head>
+ <body>
+ <div id="container">
+ <div id="header">
+ <div id="subProjectsNavBar">
+ <a href="./../../">
+
+ Apache Directory Project
+
+ </a>
+ |
+ <a href="./../../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../../studio">
+
+ Apache Directory Studio
+
+ </a>
+ |
+ <a href="./../../api">
+
+ Apache LDAP API
+
+ </a>
+ |
+ <a href="./../../mavibot">
+
+ <STRONG>Mavibot</STRONG>
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <h5>Mavibot 1.0</h5>
+ <ul>
+ <li><a href="./../../mavibot/">Home</a></li>
+ <li><a href="./../../mavibot/news.html">News</a></li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../../mavibot/downloads.html">Version 1.0.0-M1</a> <IMG src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../../mavibot/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../../mavibot/vision.html">Vision</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../../mavibot/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../../mavibot/user-guide.html">User Guide</a></li>
+ <li><a href="./../../mavibot/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <!--li><a href="./../../mavibot/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../../mavibot/developer-guide.html">Developer Guide</a></li>
+ </ul>
+
+
+ <h5>Support</h5>
+ <ul>
+ <li><a href="./../../mailing-lists-and-irc.html">Mailing Lists & IRC</a></li>
+ <li><a href="./../../sources.html">Sources</a></li>
+ <li><a href="./../../issue-tracking.html">Issue Tracking</a></li>
+ <li><a href="./../../commercial-support.html">Commercial Support</a></li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li><a href="./../../contribute.html">How to Contribute</a></li>
+ <li><a href="./../../team.html">Team</a></li>
+ <li><a href="./../../original-project-proposal.html">Original Project Proposal</a></li>
+ <li><a href="./../../special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
+ </ul>
+ <h5>About Apache</h5>
+ <ul>
+ <li><a href="http://www.apache.org/">Apache</a></li>
+ <li><a href="http://www.apache.org/licenses/">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/">Security</a></li>
+ </ul>
+ <a href="http://ldapcon.org" target="_blank" rel="nofollow"><img src="./../../images/banner-ldapcon-2013.png" alt="LDAPCon 2013" width="167" height="231"></a>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+<h1 id="21-file-format">2.1 - File format</h1>
+<p>When associated with a RecordManager, Mavibot stores all the Btrees in one single file, which is split in many physical pages, all having the same size. </p>
+<blockquote>
+<p><strong>Note</strong> page size
+Currently, the choice was to use one single size for all the pages, regardless the data we store into them. The rationnal is to
+get close to the OS page size (frequently 512 bytes or 4096 bytes). This is not necessarily the best choice though, let's say
+it's something we might want to change later.</p>
+</blockquote>
+<h2 id="general-file-structure">General file structure</h2>
+<p>The file we use to store the data is a plain binary file, used to store all the BTrees. We can store many btrees in one single file.</p>
+<p>This file is considered as a fileSystem, with fixed size 'pages' (a page is an array of bytes). The page size is arbitrary fixed when teh RecordManager is created, and we will store every logical data n those physical pages, which will require to spread the logical data in many pages in most of the cases.</p>
+<h2 id="pageio">PageIO</h2>
+<p>Let's first introduce the <em>PageIO</em>, which is used to store the data on disk.</p>
+<p>A <em>PageIO</em> contains some raw data. As we have to map some logical data that may be wider than a physical fixed size <em>PageIO</em>, we use potentially more than one <em>PageIO</em> to store the data, and we link the <em>PageIO</em>s alltogether.</p>
+<p>Each <em>PageIO</em> has a height bytes pointer at the beginning, pointing to the next PageIO (or to nothing, if there is no more <em>PageIO</em> in the chain), plus an extra 4 bytes on the first <em>PageIO</em> to define the number of bytes stored in the chain of PageIO. Here is the mapping between a logical page and some PageIOs :</p>
+<p><img alt="PageIO mapping" src="images/PageIOLogical.png" /></p>
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../user-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-.html">2 - </a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2012, <a href="http://www.apache.org">The Apache Software Foundation</a> - <a href="./../../privacy-policy.html">Privacy Policy</a><br />
+ Apache Directory, ApacheDS, Apache Directory Server, Apache Directory Studio, Apache LDAP API, Apache Triplesec, Triplesec, Apache Mavibot, Mavibot, Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
Added: websites/staging/directory/trunk/content/mavibot/user-guide/images/PageIOLogical.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/directory/trunk/content/mavibot/user-guide/images/PageIOLogical.png
------------------------------------------------------------------------------
svn:mime-type = image/png