Spring/spring-ldap
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added site generation.

Browse Source
This commit is contained in:
Ulrik Sandberg
2009-01-16 21:49:30 +00:00
parent d013cf31bd
commit 1bdaea8aa8
32 changed files with 592 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/assembly/minimal.xml
View File

@@ -24,7 +24,7 @@
</moduleSets>
<files>
<file>
<source>target/${artifactId}-${version}.jar</source>
<source>target/${artifactId}-${version}-all.jar</source>
<outputDirectory>dist</outputDirectory>
</file>
</files>

2
src/assembly/with-dependencies.xml
View File

@@ -32,7 +32,7 @@
</moduleSets>
<files>
<file>
<source>target/${artifactId}-${version}.jar</source>
<source>target/${artifactId}-${version}-all.jar</source>
<outputDirectory>dist</outputDirectory>
</file>
<file>

47
src/docbkx/index.xml Normal file
View File

@@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Spring LDAP - Reference Documentation</title>
<releaseinfo>&version;</releaseinfo>
<authorgroup>
<author>
<firstname>Mattias</firstname>
<surname>Arthursson</surname>
</author>
<author>
<firstname>Ulrik</firstname>
<surname>Sandberg</surname>
</author>
<author>
<firstname>Eric</firstname>
<surname>Dalquist</surname>
</author>
</authorgroup>
<legalnotice>
<para>
Copies of this document may be made for your own use and
for distribution to others, provided that you do not
charge any fee for such copies and further provided that
each copy contains this Copyright Notice, whether
distributed in print or electronically.
</para>
</legalnotice>
</bookinfo>
<toc />
<xi:include href="preface.xml" />
<xi:include href="overview.xml" />
<xi:include href="basic.xml" />
<xi:include href="dirobjectfactory.xml" />
<xi:include href="executors.xml" />
<xi:include href="contextprocessor.xml" />
<xi:include href="transactions.xml" />
<xi:include href="simple.xml" />
<xi:include href="configuration.xml" />
<xi:include href="pooling.xml" />
<xi:include href="user-authentication.xml" />
</book>

11
src/docbkx/overview.xml
View File

@@ -5,7 +5,7 @@
<sect1 id="introduction-overview">
<title>Overview</title>
<para>Spring-LDAP (<ulink
<para>Spring LDAP (<ulink
url="http://www.springframework.org/ldap">http://www.springframework.org/ldap</ulink>)
is a library for simpler LDAP programming in Java, built on the same
principles as the <ulink
@@ -224,8 +224,13 @@ public class PersonDaoImpl implements PersonDao {
<title>Spring LDAP package structure</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/package-dependencies.png" format="png" />
<imageobject role="fo">
<imagedata fileref="src/docbkx/resources/images/package-dependencies.png"
format="PNG" align="center" />
</imageobject>
<imageobject role="html">
<imagedata fileref="images/package-dependencies.png"
format="PNG" align="center" />
</imageobject>
</mediaobject>
</figure>

0
src/docbkx/images/NamingException.png → src/docbkx/resources/images/NamingException.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 63 KiB

0
src/docbkx/images/banner4.jpg → src/docbkx/resources/images/banner4.jpg
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 81 KiB

After

Width:  |  Height:  |  Size: 81 KiB

0
src/docbkx/images/bannerR.gif → src/docbkx/resources/images/bannerR.gif
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 7.8 KiB

After

Width:  |  Height:  |  Size: 7.8 KiB

0
src/docbkx/images/logo.png → src/docbkx/resources/images/logo.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 23 KiB

0
src/docbkx/images/package-dependencies.png → src/docbkx/resources/images/package-dependencies.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

BIN
src/docbkx/resources/images/s2_box_logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.7 KiB

BIN
src/docbkx/resources/images/xdev-spring_logo.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

2
src/docbkx/resources/xsl/html.xsl
View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
This is the XSL HTML configuration file for the Spring
Reference Documentation.
LDAP Reference Documentation.
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"

14
src/docbkx/resources/xsl/html_chunk.xsl
View File

@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!--
This is the XSL HTML configuration file for the Spring Reference Documentation.
This is the XSL HTML configuration file for the Spring LDAP Reference Documentation.
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
@@ -73,19 +73,19 @@
<!-- let's have a Spring and SpringSource banner across the top of each page -->
<xsl:template name="user.header.navigation">
<div style="background-color:white;border:none;height:73px;border:1px solid black;">
<a style="border:none;" href="http://static.springframework.org/spring-ws/site/"
title="The Spring Framework - Spring Web Services">
<a style="border:none;" href="http://static.springframework.org/spring-ldap/site/"
title="The Spring Framework - Spring LDAP">
<img style="border:none;" src="images/xdev-spring_logo.jpg"/>
</a>
<a style="border:none;" href="http://www.springsource.com/" title="SpringSource">
<img style="border:none;position:absolute;padding-top:5px;right:42px;" src="images/s2-banner-rhs.png"/>
<img style="border:none;position:absolute;padding-top:5px;right:42px;" src="images/s2_box_logo.png"/>
</a>
</div>
</xsl:template>
<!-- no other header navigation (prev, next, etc.) -->
<xsl:template name="header.navigation"/>
<xsl:param name="navig.showtitles">1</xsl:param>
<!-- let's have a 'Sponsored by SpringSource' strapline (or somesuch) across the bottom of each page -->
<!-- let's have a 'Sponsored by Jayway' strapline (or somesuch) across the bottom of each page -->
<xsl:template name="footer.navigation">
<xsl:param name="prev" select="/foo"/>
<xsl:param name="next" select="/foo"/>
@@ -187,8 +187,8 @@
</td>
<td width="20%" align="center">
<span style="color:white;font-size:90%;">
<a href="http://www.springsource.com/"
title="SpringSource">Sponsored by SpringSource
<a href="http://www.jayway.com/"
title="Jayway">Sponsored by Jayway
</a>
</span>
</td>

50
src/docbkx/spring-ldap-reference.xml
View File

@@ -1,50 +0,0 @@
<?xml version='1.0' encoding="iso-8859-1"?>
<book version="5.0" xml:id="spring-security-reference-guide" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<info>
<title>Spring LDAP</title>
<subtitle>Reference Documentation</subtitle>
<releaseinfo>Version 1.3-RC1</releaseinfo>
<pubdate>2008</pubdate>
<authorgroup>
<author>
<firstname>Mattias</firstname>
<surname>Arthursson</surname>
</author>
<author>
<firstname>Ulrik</firstname>
<surname>Sandberg</surname>
</author>
<author>
<firstname>Eric</firstname>
<surname>Dalquist</surname>
</author>
</authorgroup>
<legalnotice>
<para>
Copies of this document may be made for your own use and
for distribution to others, provided that you do not
charge any fee for such copies and further provided that
each copy contains this Copyright Notice, whether
distributed in print or electronically.
</para>
</legalnotice>
</info>
<toc />
<xi:include href="preface.xml" />
<xi:include href="overview.xml" />
<xi:include href="basic.xml" />
<xi:include href="dirobjectfactory.xml" />
<xi:include href="executors.xml" />
<xi:include href="contextprocessor.xml" />
<xi:include href="transactions.xml" />
<xi:include href="simple.xml" />
<xi:include href="configuration.xml" />
<xi:include href="pooling.xml" />
<xi:include href="user-authentication.xml" />
</book>

15
src/site/apt/downloads/releases.apt Normal file
View File

@@ -0,0 +1,15 @@
---------
Downloads
---------
Downloads
* Get the latest Spring LDAP releases here
* <<Spring LDAP 1.2.1 is the current production release (JDK 1.4+)>>
* {{{http://sourceforge.net/project/showfiles.php?group_id=73357&package_id=202038&release_id=560004}Download}} | {{{http://sourceforge.net/project/shownotes.php?group_id=73357&release_id=560004}Changelog}} | {{{http://forum.springframework.org/showthread.php?t=47223}Announcement}}
* <<Spring LDAP 1.3.0 is the upcoming production release>>
* {{{snapshots.html}Download nightly snapshots}}

32
src/site/apt/downloads/snapshots.apt Normal file
View File

@@ -0,0 +1,32 @@
---------
Snapshots
---------
Snapshot Builds
These builds are provided for testing and development purposes only. They are built by a Bamboo process
automatically using the latest snapshot from Subversion.
The snapshots are deployed to a Maven2 snapshot repository. To use it, just add the following repository to the POM:
+---------------
<repository>
<id>spring-s3</id>
<name>Springframework Maven SNAPSHOT Repository</name>
<url>http://s3.amazonaws.com/maven.springframework.org/snapshot</url>
</repository>
+---------------
Individual dependencies can then be added like so:
+---------------
<dependency>
<groupId>org.springframework.ldap</groupId>
<artifactId>spring-ldap-core</artifactId>
<version>1.3.0.CI-SNAPSHOT</version>
</dependency>
+---------------
Additionally, there are
{{{http://static.springframework.org/spring-ldap/downloads/1.3-snapshot-download.php}zips}}
available which contain all jars.

11
src/site/apt/reference.apt Normal file
View File

@@ -0,0 +1,11 @@
----------------
Reference Manual
----------------
Reference Manual
The reference manual is available as HTML, and as PDF.
* View the {{{reference/html/index.html}HTML version}}
* Download the {{{reference/pdf/spring-ldap-reference.pdf}PDF version}}

28
src/site/apt/resources.apt Normal file
View File

@@ -0,0 +1,28 @@
-------------------
Resources and Tools
-------------------
Resources
On this page, we give some general resources related to LDAP. Note that these
resources are generic, and not tied to Spring LDAP.
* LDAP
** RFCs
* {{{http://www.ietf.org/rfc/rfc2251.txt}RFC 2251}}, LDAPv3 spec
* {{{http://www.ietf.org/rfc/rfc2252.txt}RFC 2252}}, Attribute Syntax Definitions
* {{{http://www.ietf.org/rfc/rfc2253.txt}RFC 2253}}, Distinguished Names
* {{{http://www.ietf.org/rfc/rfc2254.txt}RFC 2254}}, LDAP Search Filters
* {{{http://www.ietf.org/rfc/rfc2255.txt}RFC 2255}}, LDAP URL Format
* {{{http://www.ietf.org/rfc/rfc2256.txt}RFC 2256}}, X.500 User Schema for use with LDAPv3
* {{{http://www.ietf.org/rfc/rfc2696.txt}RFC 2696}}, LDAP Control Extension for Simple Paged Results

42
src/site/apt/upgrading.apt Normal file
View File

@@ -0,0 +1,42 @@
---------
Upgrading
---------
Upgrading from version 1.3.0-RC1 to 1.3.0
Some minor changes were made between version 1.3.0-RC1 and 1.3.0.
* PagedResultsRequestControl has been deprecated in favor of the more appropriately named
PagedResultsDirContextProcessor.
* The default value of the <<<pooling>>> property of DirContextSource has been changed
from <<<true>>> to <<<false>>>.
Upgrading from version 1.2.1 to 1.3.0
Some minor changes were made since version 1.2.1. The following
should help most users the project update their applications:
* NameNotFoundException is no longer silently ignored in searches. It is possible
to use the old behavior by setting the <<<ignoreNameNotFoundException>>> property
to true in LdapTemplate.
* Removed AcegiAuthenticationSource - use SpringSecurityAuthenticationSource
(included with Spring Security) instead.
* Removed deprecated method <<<setUserName()>>> in AbstractContextSource.
* DirContextAdapter#getStringAttributes, getObjectAttributes, and
getAttributeSortedStringSet now all return null if the requested Attribute
is not present, and an empty result (array or set) if present but empty.
* Probably the most requested feature of all - a plain method for simple
authentication is now provided in the ContextSource interface.
* DistinguishedName now returns compactly formatted String representations
from toString, e.g.:
<<<cn=John Doe,ou=Company,c=Sweden>>>
rather than
<<<cn=John Doe, ou=Company, c=Sweden>>>
To keep using the old formatting (for backward compatibility) set the
system property <<<org.springframework.ldap.core.spacedDnFormat>>> to <<<true>>>.

80
src/site/fml/faq.fml Normal file
View File

@@ -0,0 +1,80 @@
<?xml version="1.0" encoding="UTF-8"?>
<faqs title="Frequently Asked Questions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://maven.apache.org/maven-1.x/plugins/faq/faq.xsd">
<!--
<part id="general">
<title>General</title>
<faq id="requirements">
<question>Do I need any other SOAP framework to run Spring Web Services?</question>
<answer>
You don't need any other SOAP framework to use Spring Web services, though it can use some of the
features of Axis 1 and 2.
</answer>
</faq>
<faq id="namespace_err">
<question>I get <tt>NAMESPACE_ERR</tt> exceptions when using Spring-WS. What can I do about it?</question>
<answer>
<p>
If you get the following Exception:
</p>
<pre>
NAMESPACE_ERR: An attempt is made to create or change an object in a way which is incorrect with regard to namespaces.
</pre>
<p>
Most often, this exception is related to an older version of Xalan being used. Make sure to upgrade
to 2.7.0.
</p>
</answer>
</faq>
</part>
<part id="java">
<title>Java</title>
<faq id="java-1.4">
<question>Does Spring-WS work under Java 1.4?</question>
<answer>
<p>
Spring Web Services works under Java 1.4, but it requires some effort to make it work. Java 1.4 is
bundled with the older XML parser Crimson, which does not handle namespaces correctly. Additionally,
it is bundled with an older version of Xalan, which also has problems.
Unfortunately, placing newer versions of these on the class path does not override them.
See <a href="http://xml.apache.org/xalan-j/faq.html#faq-N100D6">this FAQ</a> entry on the Xalan
site, and also <a href="http://xerces.apache.org/xerces2-j/faq-general.html#faq-4">this entry</a>
on the Xerces site.
</p>
<p>
The only solution that works is to add newer versions of Xerces and Xalan in the lib/endorsed
directory of your JDK, as explained in those FAQs (i.e.<tt>$JAVA_HOME/lib/endorsed</tt>).
The following libraries are known to work with Java 1.4.2:
</p>
<table class="bodyTable">
<tbody>
<tr><th>Library</th><th>Version</th></tr>
<tr><td><a href="http://xerces.apache.org/xerces2-j/">Xerces</a></td><td>2.8.1</td></tr>
<tr><td><a href="http://xml.apache.org/xalan-j/">Xalan</a></td><td>2.7.0</td></tr>
<tr><td><a href="http://xerces.apache.org/xerces2-j/">XML-APIs</a></td><td>1.3.04</td></tr>
<tr><td><a href="http://java.sun.com/webservices/downloads/1.3/index.html">SAAJ</a></td><td>1.2</td></tr>
</tbody>
</table>
<p>
If you want to use WS-Security, note that the <code>XwsSecurityInterceptor</code> requires Java 5,
because an underlying library (XWSS) requires it. Instead, you can use the
<code>Wss4jSecurityInterceptor</code>.
</p>
</answer>
</faq>
<faq id="java-1.6">
<question>Does Spring-WS work under Java 1.6?</question>
<answer>
<p>
Java 1.6 ships with SAAJ 1.3, JAXB 2.0, and JAXP 1.4 (a custom version of Xerces and Xalan).
Overriding these libraries by putting different version on the classpath will result in various
classloading issues, or exceptions in <tt>org.apache.xml.serializer.ToXMLSAXHandler</tt>.
The only option for using more recent versions is to put the newer version in the
<code>endorsed</code> directory (see above).
</p>
</answer>
</faq>
</part>
-->
</faqs>

BIN
src/site/resources/images/external.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 230 B

BIN
src/site/resources/images/logos/bamboo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.6 KiB

BIN
src/site/resources/images/logos/contegix.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
src/site/resources/images/logos/jira.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.4 KiB

BIN
src/site/resources/images/logos/s101d.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.9 KiB

BIN
src/site/resources/images/logos/spring.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.4 KiB

BIN
src/site/resources/images/spring-ldap.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 23 KiB

53
src/site/site.xml Normal file
View File

@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Spring Web Services">
<skin>
<groupId>org.springframework.maven.skins</groupId>
<artifactId>maven-spring-skin</artifactId>
<version>1.0.4</version>
</skin>
<publishDate position="left" format="d MMM yyyy"/>
<bannerLeft>
<name>Spring LDAP</name>
<src>images/spring-ldap.png</src>
<href>http://www.springframework.org/ldap</href>
</bannerLeft>
<body>
<links>
<item name="Spring Framework" href="http://www.springframework.org"/>
<item name="Spring LDAP 1.3" href="http://static.springframework.org/spring-ldap/sites/1.3/"/>
</links>
<head>
<script type="text/javascript" language="javascript">
i=11692
</script>
<script type="text/javascript" language="javascript" src="http://t4.trackalyzer.com/trackalyze.js"></script>
</head>
<menu name="Overview">
<item name="Home" href="index.html"/>
<item name="Downloads" href="downloads/releases.html"/>
</menu>
<menu name="Documentation">
<item name="API" href="apidocs/index.html"/>
<item name="Reference" href="reference.html"/>
<item name="FAQ" href="faq.html"/>
<item name="Upgrading" href="upgrading.html"/>
<item name="Resources &amp; Tools" href="resources.html"/>
</menu>
<menu name="Support">
<item name="Support Forums" href="http://forum.springframework.org/forumdisplay.php?f=40"/>
<item name="JIRA" href="http://jira.springframework.org/browse/LDAP"/>
<item name="Road Map"
href="http://jira.springframework.org/browse/LDAP?report=com.atlassian.jira.plugin.system.project:roadmap-panel"/>
</menu>
<menu ref="reports" name="Reports"/>
</body>
<poweredBy>
<logo name="Powered by Spring" href="http://www.springframework.org" img="images/logos/spring.png"/>
<logo name="Powered by Structure 101" href="http://www.headwaysoftware.com/products/structure101/"
img="images/logos/s101d.png"/>
<logo name="Powered by JIRA" href="http://www.atlassian.com/software/jira/" img="images/logos/jira.png"/>
<logo name="Built by Bamboo" href="http://www.atlassian.com/software/bamboo/" img="images/logos/bamboo.png"/>
<logo name="Build with Maven 2" href="http://maven.apache.org" img="images/logos/maven-feather.png"/>
<logo name="Hosted by Contegix" href="http://www.contegix.com/" img="images/logos/contegix.png"/>
</poweredBy>
</project>

39
src/site/xdoc/index.xml Normal file
View File

@@ -0,0 +1,39 @@
<document>
<properties>
<title>Home</title>
</properties>
<body>
<h2>What is Spring LDAP?</h2>
<p> Spring LDAP is a result of applying the template approach found in
for example JdbcTemplate, in the JNDI world. Spring LDAP aims to
eliminate the need for writing raw JNDI/LDAP applications.
</p>
<h2>Key Features</h2>
<ul>
<li><b>Simplifies Coding:</b> The LdapTemplate class encapsulates all the
plumbing work involved in traditional LDAP programming, such as
creating a DirContext, looping through NamingEnumerations, handling
exceptions and cleaning up resources. This leaves the programmer to
handle the important stuff - where to find data (DNs and Filters) and
what do do with it (map to and from domain objects, bind, modify,
unbind, etc.), in the same way that JdbcTemplate relieves the
programmer of all but the actual SQL and how the data maps to the
domain model.</li>
<li><b>Pooling Library:</b> The built-in JNDI pooling support is very
limited, and actually has a few deficiencies. Spring LDAP provides a
much more flexible and powerful pooling library.</li>
<li><b>Reuses your Spring expertise:</b> Spring LDAP uses Spring application
contexts for all configuration, which should help Spring developers get
up-to-speed nice and quickly. Also, the architecture of Spring LDAP
resembles that of Spring JDBC.</li>
<li><b>Supports Transactions:</b> The LDAP standard does not specify transaction support.
Spring LDAP provides a client-side compensating transaction library to fill the void.</li>
<li><b>Integrates with Spring Security:</b> The authentication system of Spring LDAP provides
integration with <a href="http://www.springframework.org/spring-security/">Spring Security</a>.
In fact, Spring Security uses Spring LDAP for its LDAP integration.</li>
<li><b>Built by Maven:</b> This assists you in effectively reusing the Spring LDAP artifacts
in your own Maven-based projects.</li>
<li><b>Apache license.</b> You can confidently use Spring LDAP in your project.</li>
</ul>
</body>
</document>