directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1404884 - in /directory/site/trunk/content/api: groovy-ldap.mdtext java-api.mdtext user-guide.mdtext user-guide/ user-guide/1-introduction.mdtext vision.mdtext
Date Fri, 02 Nov 2012 06:57:54 GMT
Author: elecharny
Date: Fri Nov  2 06:57:53 2012
New Revision: 1404884

URL: http://svn.apache.org/viewvc?rev=1404884&view=rev
Log:
Added some pages, fixed some links and tittles

Added:
    directory/site/trunk/content/api/java-api.mdtext
    directory/site/trunk/content/api/user-guide/
    directory/site/trunk/content/api/user-guide.mdtext
    directory/site/trunk/content/api/user-guide/1-introduction.mdtext
    directory/site/trunk/content/api/vision.mdtext
Modified:
    directory/site/trunk/content/api/groovy-ldap.mdtext

Modified: directory/site/trunk/content/api/groovy-ldap.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-ldap.mdtext?rev=1404884&r1=1404883&r2=1404884&view=diff
==============================================================================
--- directory/site/trunk/content/api/groovy-ldap.mdtext (original)
+++ directory/site/trunk/content/api/groovy-ldap.mdtext Fri Nov  2 06:57:53 2012
@@ -1,4 +1,4 @@
-Title: Five Minutes Tutorial
+Title: Groovy LDAP
 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

Added: directory/site/trunk/content/api/java-api.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/java-api.mdtext?rev=1404884&view=auto
==============================================================================
--- directory/site/trunk/content/api/java-api.mdtext (added)
+++ directory/site/trunk/content/api/java-api.mdtext Fri Nov  2 06:57:53 2012
@@ -0,0 +1,37 @@
+Title: LDAP Java API
+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.
+
+# LDAP Java API
+This is the Java implementation of a new LDAP API. This effort was initially conducted with
the OpenDS team.
+
+## Background
+There are a few existing LDAP API around there. Here is a short list and description.
+
+| API | Version | License | Description |
+|---|---|---|---|
+| [Apache Directory Client API](http://directory.apache.org/api/) | 1.0-M13 | ASL 2.0 | The
Apache Directory Server CLient API. |
+| [jLDAP](http://www.openldap.org/jldap/) | 2008_03-01-1 | OpenLDAP Public License | A Novell
contribution to the OpenLDAP project |
+| [JNDI](http://java.sun.com/products/jndi/reference/docs/index.html) | 1.2 | Sun license
| This is not a pure LDAP API, however it's included in J2SE since Java 5. Probably the API
selected by many developers |
+| [ldapSDK](http://www.mozilla.org/directory/javasdk.html) | 4.17 | Netscape Public License|
The Mozilla API, formally the Netscape LDAP API |
+| [OpenDS client API](https://www.opends.org/wiki/page/ClientAPI) | N/A | CDDL | The OpenDS
API |
+| [UnboundID API](http://www.unboundid.com/products/ldapsdk/) | 0.9.10 | GPLv2 | A new API
developed by the UnboundID company |
+
+(There may be some more we don't know about)
+
+## Features
+The [User Guide](user-guide.html) pages gives the list of features the API provides.

Added: directory/site/trunk/content/api/user-guide.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide.mdtext?rev=1404884&view=auto
==============================================================================
--- directory/site/trunk/content/api/user-guide.mdtext (added)
+++ directory/site/trunk/content/api/user-guide.mdtext Fri Nov  2 06:57:53 2012
@@ -0,0 +1,129 @@
+Title: Users Guide
+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.
+
+# Users guide
+
+<DIV class="note" markdown="1">
+**Work in progress**
+
+This is a very preliminary version...
+
+Pages with a (e) at the end of the title are empty pages
+Pages with a (...) ate the end of the title are not completed yet
+Other pages are finished (but may be reviewed)
+</DIV>
+
+This documentation is about the newly LDAP API developped at the Apache Software Foundation.
We expect this API will be a replacement for all the ancient API ([jLdap](http://www.openldap.org/jldap/),
[Mozilla LDAP SDK](http://www.mozilla.org/directory/) and [JNDI](http://www.oracle.com/technetwork/java/jndi/index.html)).
+
+## About this guide
+
+Getting started. Learn how to use the LDAP API, connect to various LDAP server, manipulate
the data within your directory. 
+
+### Audience
+
+This guide is primarily for people new to the LDAP API. If you plan to use the API as is,
maybe even for your first LDAP experience, you'll (hopefully) find all information necessary
to do so. Only basic tasks are covered. Learn more about the options you have (and many other
things) in the [Advanced User's Guide].
+
+### Feedback welcome!
+
+We are quite interested to improve the content of this guide. Feel free to provide us feedback:
+!email.png! [mailto:users@directory.apache.org](mailto:users@directory.apache.org)
+
+### Table of contents
+
+* [1 - Introduction](1-introduction.html)
+
+    Java and LDAP
+    LDAP in a few words
+    The Apache LDAP API rational
+    Preparation to code
+
+Basic LDAP API usage (...)
+
+    Connection and disconnection
+    Binding and unbinding (...)
+    Searching (...)
+    Adding entries
+    Deleting entries
+    Modifying entries (e)
+    Moving an renaming entries (e)
+    Comparing entries (e)
+    Exception management (...)
+
+Advanced LDAP API usage (...)
+
+    Controls (...)
+    Extended operations (e)
+    Referrals (e)
+    Aliases (e)
+    LDIF, DSML (...)
+    Abandonning an operation (e)
+    Server informations (e)
+
+SchemaManagement (...)
+
+    SchemaManager (...)
+    AttributeTypes (e)
+    ObjectClasses (e)
+    MatchingRules (e)
+    Syntaxes (e)
+    NameForms (e)
+    DITContentRules (e)
+    DITStructureRules (e)
+    MatchingRuleUses (e)
+
+LDAP security (e)
+
+    ACI and ACLs (e)
+    SSL (e)
+    StartTLS (e)
+
+LDAP data structures (...)
+
+    Entry
+    Attribute
+    Dn
+    Rdn
+    Ava
+    Value
+    Modification
+    LdifEntry
+    LdifControl (e)
+    Oid
+    Csn
+    ObjectClass (e)
+    NameForm (e)
+    Message (...)
+    LdapResult
+    Referral (e)
+    Node (e)
+    LdapUrl (...)
+    Cursor (e)
+    AdministrativePoint (e)
+    Refinment (e)
+    SubtreeSpecification (e)
+    AttributeType (...)
+    DITContentRule (e)
+    DITStructureRule (e)
+    LdapSyntax (e)
+    LdapComparator (e)
+    Normalizer (e)
+    SyntaxChecker (e)
+    MatchingRule (e)
+    MatchingRuleUse (e)
+
+LDAP related RFCs

Added: directory/site/trunk/content/api/user-guide/1-introduction.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/user-guide/1-introduction.mdtext?rev=1404884&view=auto
==============================================================================
--- directory/site/trunk/content/api/user-guide/1-introduction.mdtext (added)
+++ directory/site/trunk/content/api/user-guide/1-introduction.mdtext Fri Nov  2 06:57:53
2012
@@ -0,0 +1,27 @@
+Title: 1 - Introduction
+NavUp: ../user-guide.html
+NavUpText: User Guide
+NavNext: 2-basic-ldap-api-usage.html
+NavNextText: 2 - Basic LDAP API Usage
+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.
+
+# 1 - Introduction
+
+This User Guide goal is to provide some clue for any developer wanting to use the LDAP API.
We have mixed some description of each important features with some tested snippet of code
(all of them has been integrated as tests in the API code).
+
+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 !

Added: directory/site/trunk/content/api/vision.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/vision.mdtext?rev=1404884&view=auto
==============================================================================
--- directory/site/trunk/content/api/vision.mdtext (added)
+++ directory/site/trunk/content/api/vision.mdtext Fri Nov  2 06:57:53 2012
@@ -0,0 +1,31 @@
+Title: LDAP API - Vision
+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.
+
+# Vision
+
+When we started to work on replication implementation, we needed a client API in order to
communicate using the LDAP protocol with remote LDAP servers. We could have used some existing
LDAP API, but as we have already defined a lot of base classes we would have had to convert
back and forth, we thought it would be better to build the missing pieces and define our own
complete LDAP API.
+
+This is one of the reasons we started this sub-project.
+
+Another reason is that we worked with Sun a few years ago to draw a new version of JNDI,
an aborted effort, sadly. We also have been contacted by the OpenLDAP team as they wanted
to know if we were ready to maintain jLDAP, as it needed some patches, and as they didn't
have enough workforce to do so. Last, not least, OpenDS team is also interested to see if
we can avoid duplication of efforts, as they are also defining an LDAP API.
+
+All those events make it interesting to try to find a common way to define a new LDAP API,
gathering the interest of the largest developer base possible.
+
+As we have not finished to implement all the needed features, it's easy for us to try to
figure which parts can be shared with other projects, and which parts must be configurable.
A clear example is the underlying network layer: OpenDS will use Grizzly, while we will use
MINA. This should be transparent for developers.
+
+Last, not least, no one can claim to be better than all the other great people out there,
and claim to be able to define the best possible API. We at The ASF believe that collaboration
within a community is better than working alone. We are pleased to share what we have already
done, ready to move forward in better directions if it allows the API to be more reliable,
usable and at the end, easier to use for devlopers.
\ No newline at end of file



Mime
View raw message