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 2018/01/12 08:38:51 UTC
svn commit: r1023718 - in /websites/staging/directory/trunk/content: ./
api/dev-guide/ api/dev-guide/images/
Author: buildbot
Date: Fri Jan 12 08:38:51 2018
New Revision: 1023718
Log:
Staging update by buildbot for directory
Added:
websites/staging/directory/trunk/content/api/dev-guide/
websites/staging/directory/trunk/content/api/dev-guide/1-introduction.html
websites/staging/directory/trunk/content/api/dev-guide/2-general-structure.html
websites/staging/directory/trunk/content/api/dev-guide/images/
websites/staging/directory/trunk/content/api/dev-guide/images/architecture.graphml (with props)
websites/staging/directory/trunk/content/api/dev-guide/images/architecture.png (with props)
websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.graphml (with props)
websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.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 Jan 12 08:38:51 2018
@@ -1 +1 @@
-1819572
+1820955
Added: websites/staging/directory/trunk/content/api/dev-guide/1-introduction.html
==============================================================================
--- websites/staging/directory/trunk/content/api/dev-guide/1-introduction.html (added)
+++ websites/staging/directory/trunk/content/api/dev-guide/1-introduction.html Fri Jan 12 08:38:51 2018
@@ -0,0 +1,238 @@
+<!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/brown.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../../images/api-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="./../../">
+
+ Main
+
+ </a>
+ |
+ <a href="./../../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../../studio">
+
+ Studio
+
+ </a>
+ |
+ <a href="./../../api">
+
+ <STRONG>LDAP API</STRONG>
+
+ </a>
+ |
+ <a href="./../../mavibot">
+
+ Mavibot
+
+ </a>
+ |
+ <a href="./../../escimo">
+
+ eSCIMo
+
+ </a>
+ |
+ <a href="./../../fortress">
+
+ Fortress
+
+ </a>
+ |
+ <a href="./../../kerby">
+
+ Kerby
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <!--ul>
+ <li>
+ <a href="http://bit.ly/1n9YlQT" target="_blank">
+ <img src="./../../images/ApacheConBudapest.png" width="125" height="125" alt="I'm Speaking at ApacheCon Europe 2014! Join me!" title="I'm Speaking at ApacheCon Europe 2014! Join me!" border="0" style="margin-bottom:-3px;"/>
+ </a>
+ </li>
+ </ul-->
+ <h5>LDAP API 1.0</h5>
+ <ul>
+ <li><a href="./../../api/">Home</a></li>
+ <li><a href="./../../api/news.html">News</a></li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../../api/downloads.html">Version 1.0.0</a> <IMG src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../../api/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../../api/vision.html">Vision</a></li>
+ <li><a href="./../../api/java-api.html">Java API</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../../api/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../../api/user-guide.html">User Guide</a></li>
+ <li><a href="./../../api/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <li><a href="./../../api/gen-docs/latest/xref/">Cross-Reference</a></li>
+ <!--li><a href="./../../api/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../../api/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>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../dev-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-general-structure.html">2 - General structure</a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+<style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="1-introduction">1 - Introduction<a class="headerlink" href="#1-introduction" title="Permanent link">¶</a></h1>
+<p>This Developer Guide teaches developers about the inner logic of the API. It can be useful to those interested in the project, giving them some clues about how it all works and its design, and also to those who want to extend the API by adding Controls, Extended Operations, or schema elements like SyntaxCheckers, Comparators, etc.</p>
+<h2 id="content">Content<a class="headerlink" href="#content" title="Permanent link">¶</a></h2>
+<ul>
+<li><a href="2-general-structure.html">2 - General structure</a></li>
+<li><a href="3-building.html">3 - Building</a></li>
+<li><a href="4-asn1.html">4 - ASN/1</a></li>
+<li><a href="5-network.html">5 - Network</a></li>
+<li><a href="6-codec.html">6 - Encoding/Decoding</a></li>
+<li><a href="7-ldap-messages.html">7 - LDAP Messages</a></li>
+<li><a href="8-schema.html">8 - Schema</a></li>
+<li><a href="9-dn.html">9 - Dn</a></li>
+<li><a href="10-entry.html">10 - Entry</a></li>
+<li><a href="11-filter.html">11 - Filter</a></li>
+<li><a href="12-cursor.html">12 - Cursor</a></li>
+<li><a href="13-controls.html">13 - Controls</a></li>
+<li><a href="14-extended-operations.html">14 - Extended Operations</a></li>
+<li><a href="15-ldif.html">15 - LDIF</a></li>
+<li><a href="16-dsml.html">16 - DSML</a></li>
+<li><a href="17-osgi.html">17 - OSGi</a></li>
+</ul>
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../dev-guide.html">User Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="2-general-structure.html">2 - General structure</a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2015, <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 eSCIMo, eSCIMo, Fortress, Apache Fortress, EnMasse, Apache EnMasse, Apache Kerby, Kerby
+ Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/directory/trunk/content/api/dev-guide/2-general-structure.html
==============================================================================
--- websites/staging/directory/trunk/content/api/dev-guide/2-general-structure.html (added)
+++ websites/staging/directory/trunk/content/api/dev-guide/2-general-structure.html Fri Jan 12 08:38:51 2018
@@ -0,0 +1,326 @@
+<!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 - General Structure — Apache Directory</title>
+
+ <link href="./../../css/common.css" rel="stylesheet" type="text/css">
+ <link href="./../../css/brown.css" rel="stylesheet" type="text/css">
+
+
+ <link rel="shortcut icon" href="./../../images/api-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="./../../">
+
+ Main
+
+ </a>
+ |
+ <a href="./../../apacheds">
+
+ ApacheDS
+
+ </a>
+ |
+ <a href="./../../studio">
+
+ Studio
+
+ </a>
+ |
+ <a href="./../../api">
+
+ <STRONG>LDAP API</STRONG>
+
+ </a>
+ |
+ <a href="./../../mavibot">
+
+ Mavibot
+
+ </a>
+ |
+ <a href="./../../escimo">
+
+ eSCIMo
+
+ </a>
+ |
+ <a href="./../../fortress">
+
+ Fortress
+
+ </a>
+ |
+ <a href="./../../kerby">
+
+ Kerby
+
+ </a>
+ </div><!-- subProjectsNavBar -->
+ </div><!-- header -->
+ <div id="content">
+ <div id="leftColumn">
+
+<div id="navigation">
+
+ <!--ul>
+ <li>
+ <a href="http://bit.ly/1n9YlQT" target="_blank">
+ <img src="./../../images/ApacheConBudapest.png" width="125" height="125" alt="I'm Speaking at ApacheCon Europe 2014! Join me!" title="I'm Speaking at ApacheCon Europe 2014! Join me!" border="0" style="margin-bottom:-3px;"/>
+ </a>
+ </li>
+ </ul-->
+ <h5>LDAP API 1.0</h5>
+ <ul>
+ <li><a href="./../../api/">Home</a></li>
+ <li><a href="./../../api/news.html">News</a></li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+ <li><a href="./../../api/downloads.html">Version 1.0.0</a> <IMG src="./../../images/new_badge.gif" alt="" style="margin-bottom:-3px;" border="0"></li>
+ <li><a href="./../../api/download-old-versions.html">Older versions</a></li>
+ </ul>
+ <h5>Getting Started</h5>
+ <ul>
+ <li><a href="./../../api/vision.html">Vision</a></li>
+ <li><a href="./../../api/java-api.html">Java API</a></li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li><a href="./../../api/five-minutes-tutorial.html">Five minutes tutorial</a></li>
+ <li><a href="./../../api/user-guide.html">User Guide</a></li>
+ <li><a href="./../../api/gen-docs/latest/apidocs/">JavaDocs</a></li>
+ <li><a href="./../../api/gen-docs/latest/xref/">Cross-Reference</a></li>
+ <!--li><a href="./../../api/gen-docs/latest/">Generated Reports</a></li-->
+ <li><a href="./../../api/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>
+
+</div><!-- navigation -->
+
+ </div><!-- leftColumn -->
+ <div id="rightColumn">
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+ <a href="1-introduction.html">1 - Introduction</a>
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../dev-guide.html">Developer Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="3-building.html">3 - Building</a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+<style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="2-general-structure">2 - General Structure<a class="headerlink" href="#2-general-structure" title="Permanent link">¶</a></h1>
+<p>The <em>LDAP API</em> is split into many modules. Here is their hierarchy :</p>
+<pre>
+LDAP API root
+ |
+ +-- all
+ |
+ +-- asn1
+ | |
+ | +-- api
+ | |
+ | +-- ber
+ |
+ +-- distribution
+ |
+ +-- dsml
+ | |
+ | +-- engine
+ | |
+ | +-- parser
+ |
+ +-- i18n
+ |
+ +-- integ
+ |
+ +-- integ-osgi
+ |
+ +-- ldap
+ | |
+ | +-- client
+ | | |
+ | | +-- all
+ | | |
+ | | +-- api
+ | |
+ | +-- codec
+ | | |
+ | | +-- core
+ | | |
+ | | +-- standalone
+ | |
+ | +-- extras
+ | | |
+ | | +-- aci
+ | | |
+ | | +-- codec
+ | | |
+ | | +-- codec-api
+ | | |
+ | | +--sp
+ | | |
+ | | +-- trigger
+ | | |
+ | | +-- util
+ | |
+ | +-- model
+ | |
+ | +-- net
+ | | |
+ | | +-- mina
+ | |
+ | +-- schema
+ | |
+ | +-- converter
+ | |
+ | +-- data
+ |
+ +-- util
+</pre>
+
+<ul>
+<li>
+<p>The <em>all</em> module is just a packaging module, gathering all the other modules in one single jar to simplify the work o those who want to use the API. One can import each module speparately, or the <em>all</em> module only. Note that it does not include the tests and integration modules (<em>integ</em>, <em>integ-osgi</em> and <em>distribution</em>)</p>
+</li>
+<li>
+<p>The <em>asn1</em> module contains the code needed to handle <em>ASN/1</em> encoding/decoding.</p>
+</li>
+<li>
+<p>The <em>distribution</em> module just create the packages</p>
+</li>
+<li>
+<p>The <em>dsml</em> module covers <em>DSML</em> features</p>
+</li>
+<li>
+<p>The <em>i18n</em> module contains all the messages, in various languages (english, french and german at the moment)</p>
+</li>
+<li>
+<p>The <em>integ</em> module is for integration tests, covering many of the existing modules</p>
+</li>
+<li>
+<p>The <em>integ-osgi</em> module covers tests related to <em>OSGi</em> integration. It checks that we can instanciate some component within an <em>OSGi</em> framework.</p>
+</li>
+<li>
+<p>The <em>ldap</em> modules are the meat of the <em>API</em> : they contain all the needed modules related to <em>LDAP</em>, and mainly the <em>model</em> module. Note that the <em>net</em> module should not be part of <em>ldap</em>, per se...</p>
+</li>
+<li>
+<p>The <em>util</em> module contains classes that are shared across the various modules.</p>
+</li>
+</ul>
+<p>Anyway, from a developer point of view, that does not tell a lot about the inner struture.</p>
+<p>Clearly, the entry point is the <em>Connection</em> interface and its inherited class, which reside in the <em>api-ldap-client-api</em> module, in <em>/ldap/client/.api</em>. This is the interface - or one of its implementation - that is used to connect to a LDAP server. Here is the full hierarchy :</p>
+<p><img alt="LdapConnection" src="images/ldap-connection.png" /></p>
+<p>The user will need a <em>LdapNetworkConnection</em> most of the time, the wrapper is just used by the connection pool. Note that <em>ApacheDS</em> has its own implementation (not represented in this picture), called <em>LdapCoresSessionConnection</em>.</p>
+<p>So, bottom line, if you want to have a look at how the <em>API</em> works, the entry point is the *LdapNetworkConnection class.</p>
+<h2 id="layers">Layers<a class="headerlink" href="#layers" title="Permanent link">¶</a></h2>
+<p>If you consider a <em>LdapConnection</em>, obviously, you will have to connect to a remote server, and you will need a part of the code handling the network. This is done - currently - using <em>Apache MINA</em>, which is an <em>NIO</em> framework. That means all the communication with the remote <em>LDAP</em> server is done asynchroniously.</p>
+<p>We also made so the <em>API</em> to be <em>OSGi</em> compliant. That means some of the parts need to be 'activated'. The idea was to make it possible to extend the <em>API</em> easily by adding component that could be loaded dynamically. So far, it's not a completed work, but still, this is a on-going process.</p>
+<p>The following pitcure shows for 10 000 feet the <em>LDAP API</em> architecture :</p>
+<p><img alt="LDAP API Architecture" src="images/architecture.png" /></p>
+
+
+ <div class="nav">
+ <div class="nav_prev">
+
+ <a href="1-introduction.html">1 - Introduction</a>
+
+ </div>
+ <div class="nav_up">
+
+ <a href="../dev-guide.html">Developer Guide</a>
+
+ </div>
+ <div class="nav_next">
+
+ <a href="3-building.html">3 - Building</a>
+
+ </div>
+ <div class="clearfix"></div>
+ </div>
+
+
+ </div><!-- rightColumn -->
+ <div id="endContent"></div>
+ </div><!-- content -->
+ <div id="footer">© 2003-2015, <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 eSCIMo, eSCIMo, Fortress, Apache Fortress, EnMasse, Apache EnMasse, Apache Kerby, Kerby
+ Apache, the Apache feather logo, and the Apache Directory project logos are trademarks of The Apache Software Foundation.
+ </div>
+ </div><!-- container -->
+ </body>
+</html>
\ No newline at end of file
Added: websites/staging/directory/trunk/content/api/dev-guide/images/architecture.graphml
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/directory/trunk/content/api/dev-guide/images/architecture.graphml
------------------------------------------------------------------------------
svn:mime-type = application/xml
Added: websites/staging/directory/trunk/content/api/dev-guide/images/architecture.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/directory/trunk/content/api/dev-guide/images/architecture.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.graphml
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.graphml
------------------------------------------------------------------------------
svn:mime-type = application/xml
Added: websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/directory/trunk/content/api/dev-guide/images/ldap-connection.png
------------------------------------------------------------------------------
svn:mime-type = image/png