directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1414783 - in /directory/site/trunk/content: api/ api/groovy-api/ images/
Date Wed, 28 Nov 2012 16:15:08 GMT
Author: elecharny
Date: Wed Nov 28 16:15:06 2012
New Revision: 1414783

URL: http://svn.apache.org/viewvc?rev=1414783&view=rev
Log:
Added new images, and new API pages

Added:
    directory/site/trunk/content/api/groovy-api/
    directory/site/trunk/content/api/groovy-api/1-groovy-ldap-download.mdtext
      - copied, changed from r1414761, directory/site/trunk/content/api/groovy-ldap-download.mdtext
    directory/site/trunk/content/api/groovy-api/2-groovy-ldap-user-guide.mdtext
      - copied, changed from r1414761, directory/site/trunk/content/api/groovy-ldap-user-guide.mdtext
    directory/site/trunk/content/api/groovy-api/3-groovy-ldap-implementation.mdtext
    directory/site/trunk/content/api/groovy-api/4-groovy-ldap-build.mdtext
    directory/site/trunk/content/images/JetBrains_logo.png   (with props)
    directory/site/trunk/content/images/SQLManager.bmp   (with props)
    directory/site/trunk/content/images/borland.gif   (with props)
    directory/site/trunk/content/images/opengroup_logo.png   (with props)
    directory/site/trunk/content/images/opensourceposeidon_supportedby.gif   (with props)
    directory/site/trunk/content/images/zenl_logo.gif   (with props)
Removed:
    directory/site/trunk/content/api/groovy-ldap-download.mdtext
    directory/site/trunk/content/api/groovy-ldap-user-guide.mdtext
Modified:
    directory/site/trunk/content/api/groovy-ldap.mdtext

Copied: directory/site/trunk/content/api/groovy-api/1-groovy-ldap-download.mdtext (from r1414761,
directory/site/trunk/content/api/groovy-ldap-download.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-api/1-groovy-ldap-download.mdtext?p2=directory/site/trunk/content/api/groovy-api/1-groovy-ldap-download.mdtext&p1=directory/site/trunk/content/api/groovy-ldap-download.mdtext&r1=1414761&r2=1414783&rev=1414783&view=diff
==============================================================================
--- directory/site/trunk/content/api/groovy-ldap-download.mdtext (original)
+++ directory/site/trunk/content/api/groovy-api/1-groovy-ldap-download.mdtext Wed Nov 28 16:15:06
2012
@@ -1,4 +1,8 @@
-Title: Groovy LDAP Download, Sources & Building
+Title: 1 - Groovy LDAP : Download, Sources & Building
+NavUp: ../groovy-ldap.html
+NavUpText: Groovy LDAP
+NavNext: 2-groovy-ldap-user-guide.html
+NavNextText: 2 - Groovy LDAP User 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
@@ -16,7 +20,7 @@ Notice: Licensed to the Apache Software 
     specific language governing permissions and limitations
     under the License.
 
-# Groovy LDAP Download, Sources & Building
+# 1 - Groovy LDAP : Download, Sources & Building
 
 
 ## Download Groovy LDAP
@@ -26,85 +30,3 @@ Here is a ZIP-File which contains the so
 **[groovy-ldap.zip](download/groovy-ldap.zip)**
 
 
-## Implementation
-
-Currently, the implementation is comprised of some Java classes and two enumerations (search
scopes and modification types). The class _LDAP_ is the main entry point for scripts, just
as the class _LDAPConnection_ in the Netscape SDK. It provides the operations implemented
so far. I have decided to omit methods for connecting and disconnecting explicitly (_bind_,
_unbind_ in LDAP). Instead all methods handle the connection themselves, which makes the Groovy
source code shorter. Class _DirContextToMapObjectFactory_ acts under the hood. It transforms
a _DirContext_ object from JNDI search results and lookups into a Java map. This trick enables
the script writer to use expressions like _tori.cn_ in order to retrieve an attribute value.
 There are probably better solutions to accomplish this task.
-
-
-## Source code
-
-Source code of the proof of concept is currently available for review here :
-
-<http://svn.apache.org/repos/asf/directory/sandbox/szoerner/groovyldap>
-
-In order to check it out, simply type
-
-    D:\Apache>svn co http://svn.apache.org/repos/asf/directory/sandbox/szoerner/groovyldap
-    A    groovyldap\src
-    A    groovyldap\src\main
-    A    groovyldap\src\main\java
-    A    groovyldap\src\main\java\org
-    A    groovyldap\src\main\java\org\apache
-    ...
-    Checked out revision 558335.
-    
-    D:\Apache>_
-
-
-## Building the software
-
-### Resolving the dependencies
-
-Groovy LDAP needs Java 5 to compile. Besides this, it has only one dependency: Groovy itself.
For LDAP communication, JNDI and its LDAP provider are used. These are part of the JDK since
ages. 
-
-In order to build the software, Apache ant is used. For dependency resolution we use [Ivy](http://incubator.apache.org/ivy).
You need to configure your ant tool to use Ivy. One option is to place the corresponding jar
file _ivy-1.4.1.jar_ (or later) in the _lib_ folder of your ant distribution.
-
-### Building with ant and ivy (deprecated)
-
-Simply change to the _groovyldap_ directory and type _ant_.
- 
-    D:\Apache>cd groovyldap
-    D:\Apache\groovyldap>ant
-    Buildfile: build.xml
-    
-    prepare:
-        [mkdir] Created dir: D:\Apache\groovyldap\dist
-        [mkdir] Created dir: D:\Apache\groovyldap\dist\classes
-        [mkdir] Created dir: D:\Apache\groovyldap\lib
-    
-    resolve:
-    [ivy:retrieve] :: Ivy 1.4.1 - 20061109165313 :: http://ivy.jayasoft.org/ ::
-    
-    ...
-
-    jarfile:
-          [jar] Building jar: D:\Apache\groovyldap\dist\groovy-ldap.jar
-    
-    BUILD SUCCESSFUL
-    Total time: 7 seconds
-    D:\Apache\groovyldap>_
-
-Done.
-
-The jarfile which includes the software, _groovy-ldap.jar_, is created in the _dist_ directory.
Feel free to call _ant clean_ afterwards. 
-
-### Building with Maven
-
-We are changing the build process to Maven 2, in order to have the same build tool for all
sub projects within Apache Directory. 
-
-Simply change to the _groovyldap_ directory and type _mvn install_.
- 
-    D:\Apache\groovyldap>mvn install
-    [INFO] Scanning for projects...
-    [INFO] -----------------------------------------------------------------
-    [INFO] Building Apache Directory Groovy LDAP
-    [INFO]    task-segment: [install]
-    [INFO] -----------------------------------------------------------------
-    ...
-    [INFO] -----------------------------------------------------------------
-    [INFO] BUILD SUCCESSFUL
-    [INFO] -----------------------------------------------------------------
-    [INFO] Total time: 25 seconds
-    [INFO] Finished at: Mon Mar 02 22:06:54 CET 2009
-    [INFO] Final Memory: 19M/38M
-    [INFO] -----------------------------------------------------------------
\ No newline at end of file

Copied: directory/site/trunk/content/api/groovy-api/2-groovy-ldap-user-guide.mdtext (from
r1414761, directory/site/trunk/content/api/groovy-ldap-user-guide.mdtext)
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-api/2-groovy-ldap-user-guide.mdtext?p2=directory/site/trunk/content/api/groovy-api/2-groovy-ldap-user-guide.mdtext&p1=directory/site/trunk/content/api/groovy-ldap-user-guide.mdtext&r1=1414761&r2=1414783&rev=1414783&view=diff
==============================================================================
--- directory/site/trunk/content/api/groovy-ldap-user-guide.mdtext (original)
+++ directory/site/trunk/content/api/groovy-api/2-groovy-ldap-user-guide.mdtext Wed Nov 28
16:15:06 2012
@@ -1,4 +1,10 @@
-Title: Groovy LDAP User Guide
+Title: 2 - Groovy LDAP : User Guide
+NavPrev: 1-groovy-ldap-download.html
+NavPrevText: 1 - Groovy LDAP Download
+NavUp: ../groovy-ldap.html
+NavUpText: Groovy LDAP
+NavNext: 3-groovy-ldap-implementation.html
+NavNextText: 3 - Groovy LDAP Implementation
 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
@@ -16,7 +22,7 @@ Notice: Licensed to the Apache Software 
     specific language governing permissions and limitations
     under the License.
 
-<h1>Groovy LDAP User Guide</h1>
+<h1>2 - Groovy LDAP : User Guide</h1>
 
 > **Note:** This guide is work in progress and is written at the same time as Groovy LDAP
integration developes. The API may change. Feedback highly welcome.
 

Added: directory/site/trunk/content/api/groovy-api/3-groovy-ldap-implementation.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-api/3-groovy-ldap-implementation.mdtext?rev=1414783&view=auto
==============================================================================
--- directory/site/trunk/content/api/groovy-api/3-groovy-ldap-implementation.mdtext (added)
+++ directory/site/trunk/content/api/groovy-api/3-groovy-ldap-implementation.mdtext Wed Nov
28 16:15:06 2012
@@ -0,0 +1,50 @@
+Title: 3 - Groovy LDAP : Implementation
+NavPrev: 1-groovy-ldap-user-guide.html
+NavPrevText: 2 - Groovy LDAP User Guide
+NavUp: ../groovy-ldap.html
+NavUpText: Groovy LDAP
+NavNext: 4-groovy-ldap-building.html
+NavNextText: 4 - Groovy LDAP Building the Software
+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.
+
+# 3 - Groovy LDAP : Implementation
+
+## Implementation
+
+Currently, the implementation is comprised of some Java classes and two enumerations (search
scopes and modification types). The class _LDAP_ is the main entry point for scripts, just
as the class _LDAPConnection_ in the Netscape SDK. It provides the operations implemented
so far. I have decided to omit methods for connecting and disconnecting explicitly (_bind_,
_unbind_ in LDAP). Instead all methods handle the connection themselves, which makes the Groovy
source code shorter. Class _DirContextToMapObjectFactory_ acts under the hood. It transforms
a _DirContext_ object from JNDI search results and lookups into a Java map. This trick enables
the script writer to use expressions like _tori.cn_ in order to retrieve an attribute value.
 There are probably better solutions to accomplish this task.
+
+
+## Source code
+
+Source code of the proof of concept is currently available for review here :
+
+<http://svn.apache.org/repos/asf/directory/sandbox/szoerner/groovyldap>
+
+In order to check it out, simply type
+
+    D:\Apache>svn co http://svn.apache.org/repos/asf/directory/sandbox/szoerner/groovyldap
+    A    groovyldap\src
+    A    groovyldap\src\main
+    A    groovyldap\src\main\java
+    A    groovyldap\src\main\java\org
+    A    groovyldap\src\main\java\org\apache
+    ...
+    Checked out revision 558335.
+    
+    D:\Apache>_
+

Added: directory/site/trunk/content/api/groovy-api/4-groovy-ldap-build.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-api/4-groovy-ldap-build.mdtext?rev=1414783&view=auto
==============================================================================
--- directory/site/trunk/content/api/groovy-api/4-groovy-ldap-build.mdtext (added)
+++ directory/site/trunk/content/api/groovy-api/4-groovy-ldap-build.mdtext Wed Nov 28 16:15:06
2012
@@ -0,0 +1,83 @@
+Title: 4 - Groovy LDAP : Buildng the Software
+NavPrev: 2-groovy-ldap-implementation.html
+NavPrevText: 2 - Groovy LDAP Implementation
+NavUp: ../groovy-ldap.html
+NavUpText: Groovy LDAP
+NavNext: 
+NavNextText: 
+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.
+
+# 4 - Groovy LDAP : Buildng the Software
+
+## Building the software
+
+### Resolving the dependencies
+
+Groovy LDAP needs Java 5 to compile. Besides this, it has only one dependency: Groovy itself.
For LDAP communication, JNDI and its LDAP provider are used. These are part of the JDK since
ages. 
+
+In order to build the software, Apache ant is used. For dependency resolution we use [Ivy](http://incubator.apache.org/ivy).
You need to configure your ant tool to use Ivy. One option is to place the corresponding jar
file _ivy-1.4.1.jar_ (or later) in the _lib_ folder of your ant distribution.
+
+### Building with ant and ivy (deprecated)
+
+Simply change to the _groovyldap_ directory and type _ant_.
+ 
+    D:\Apache>cd groovyldap
+    D:\Apache\groovyldap>ant
+    Buildfile: build.xml
+    
+    prepare:
+        [mkdir] Created dir: D:\Apache\groovyldap\dist
+        [mkdir] Created dir: D:\Apache\groovyldap\dist\classes
+        [mkdir] Created dir: D:\Apache\groovyldap\lib
+    
+    resolve:
+    [ivy:retrieve] :: Ivy 1.4.1 - 20061109165313 :: http://ivy.jayasoft.org/ ::
+    
+    ...
+
+    jarfile:
+          [jar] Building jar: D:\Apache\groovyldap\dist\groovy-ldap.jar
+    
+    BUILD SUCCESSFUL
+    Total time: 7 seconds
+    D:\Apache\groovyldap>_
+
+Done.
+
+The jarfile which includes the software, _groovy-ldap.jar_, is created in the _dist_ directory.
Feel free to call _ant clean_ afterwards. 
+
+### Building with Maven
+
+We are changing the build process to Maven 2, in order to have the same build tool for all
sub projects within Apache Directory. 
+
+Simply change to the _groovyldap_ directory and type _mvn install_.
+ 
+    D:\Apache\groovyldap>mvn install
+    [INFO] Scanning for projects...
+    [INFO] -----------------------------------------------------------------
+    [INFO] Building Apache Directory Groovy LDAP
+    [INFO]    task-segment: [install]
+    [INFO] -----------------------------------------------------------------
+    ...
+    [INFO] -----------------------------------------------------------------
+    [INFO] BUILD SUCCESSFUL
+    [INFO] -----------------------------------------------------------------
+    [INFO] Total time: 25 seconds
+    [INFO] Finished at: Mon Mar 02 22:06:54 CET 2009
+    [INFO] Final Memory: 19M/38M
+    [INFO] -----------------------------------------------------------------
\ No newline at end of file

Modified: directory/site/trunk/content/api/groovy-ldap.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/api/groovy-ldap.mdtext?rev=1414783&r1=1414782&r2=1414783&view=diff
==============================================================================
--- directory/site/trunk/content/api/groovy-ldap.mdtext (original)
+++ directory/site/trunk/content/api/groovy-ldap.mdtext Wed Nov 28 16:15:06 2012
@@ -40,6 +40,7 @@ Here are two example scripts which use G
 
 The attribute values of an LDAP entry can be defined with the help of the expressive Map
syntax of Groovy (\[DIRxSBOX:...\)). The following script uses the add operation to create
a new entry in the directory:
 
+    :::Groovy
     import org.apache.directory.groovyldap.LDAP
 
     ldap = LDAP.newInstance('ldap://zanzibar:10389', 'uid=admin,ou=system', '******')
@@ -54,6 +55,7 @@ The attribute values of an LDAP entry ca
 
 In LDIF format, the entry in the directory looks like this afterwards.
 
+    :::text
     dn: cn=Heather Nova,dc=example,dc=com
     cn: Heather Nova
     sn: Nova
@@ -64,6 +66,7 @@ In LDIF format, the entry in the directo
 
 Besides the operations found in the classic LDAP API, Groovy LDAP provides advanced functionality
with the help of features specific to the Groovy language. Here is an example which performs
a search operation, and executes the behavior given via a closure for each entry found:
 
+    :::Groovy
     import org.apache.directory.groovyldap.LDAP
 
     ldap = LDAP.newInstance('ldap://zanzibar:10389/dc=example,dc=com')
@@ -96,7 +99,7 @@ An interesting alternative to Groovy LDA
 
 ## Where to go from here
 
- * [Download](groovy-ldap-download.html) a binary version including the source code
- * Read the [User Guide](groovy-ldap-user-guide.html) in order to understand which operations
are already implemented, and how to use them
- * Learn more about the [implementation](groovy-ldap-download.html#implementation)
- * Learn how to [build the software](groovy-ldap-download.html#building-the-software) on
your own
\ No newline at end of file
+ * [Download](groovy-api/1-groovy-ldap-download.html) a binary version including the source
code
+ * Read the [User Guide](groovy-api/2-groovy-ldap-user-guide.html) in order to understand
which operations are already implemented, and how to use them
+ * Learn more about the [implementation](groovy-api/3-groovy-ldap-download.html)
+ * Learn how to [build the software](groovy-api/4-groovy-ldap-build.html) on your own
\ No newline at end of file

Added: directory/site/trunk/content/images/JetBrains_logo.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/JetBrains_logo.png?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/JetBrains_logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/site/trunk/content/images/SQLManager.bmp
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/SQLManager.bmp?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/SQLManager.bmp
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/site/trunk/content/images/borland.gif
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/borland.gif?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/borland.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/site/trunk/content/images/opengroup_logo.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/opengroup_logo.png?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/opengroup_logo.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/site/trunk/content/images/opensourceposeidon_supportedby.gif
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/opensourceposeidon_supportedby.gif?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/opensourceposeidon_supportedby.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/site/trunk/content/images/zenl_logo.gif
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/images/zenl_logo.gif?rev=1414783&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/site/trunk/content/images/zenl_logo.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream



Mime
View raw message