mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Matthew Swift
27.19.2013 5cdb6a9c719d2932aeeb08462d5a786d854cb6bd
Initial work towards OPENDJ-1195: Realign the SDK developer guide with the SDK trunk once the new Maven module and package layout has been validated

* convert opendj-ldap-sdk module into a Maven group (pom + only dependencies)
* kept old opendj-ldap-sdk site as primary "About" page in order to avoid breaking bookmarks and links. The opendj-core module's site is hidden
* remove all sub-module site.xml files and instead inherit menus from parent
* switch SDK Javadoc URLs to point at opendj-core Javadoc since opendj-ldap-sdk Javadoc is stale
* add simple place holder index.xml.vm site pages for most sub-modules
* change how we document getting the binaries: instead reference the dependencies report. Although slight less helpful to the reader, at least the links won't become stale.
3 files deleted
5 files added
13 files modified
1087 ■■■■■ changed files
opendj-sdk/opendj-core/pom.xml 10 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm 102 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-grizzly/pom.xml 6 ●●●● patch | view | raw | blame | history
opendj-sdk/opendj-grizzly/src/main/site/xdoc/index.xml.vm 103 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk-examples/pom.xml 16 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk-examples/src/site/site.xml 85 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm 2 ●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk/pom.xml 108 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk/src/site/site.xml 82 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm 90 ●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-toolkit/pom.xml 20 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-toolkit/src/site/site.xml 83 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-ldap-toolkit/src/site/xdoc/index.xml.vm 2 ●●● patch | view | raw | blame | history
opendj-sdk/opendj-rest2ldap-servlet/pom.xml 15 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm 103 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-rest2ldap/pom.xml 7 ●●●● patch | view | raw | blame | history
opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm 103 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-server2x-adapter/pom.xml 7 ●●●● patch | view | raw | blame | history
opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm 103 ●●●●● patch | view | raw | blame | history
opendj-sdk/pom.xml 10 ●●●● patch | view | raw | blame | history
opendj-sdk/src/site/site.xml 30 ●●●●● patch | view | raw | blame | history
opendj-sdk/opendj-core/pom.xml
@@ -34,9 +34,9 @@
  <artifactId>opendj-core</artifactId>
  <name>OpenDJ Core APIs</name>
  <description>
    This module includes OpenDJ core APIs for implementing LDAP Directory
    This module provides the core APIs required for implementing LDAP Directory
    client and server applications. Unlike the SDK this module does not
    include a default network transport.
    include a default network transport which must be obtained separately.
  </description>
  <packaging>bundle</packaging>
  <dependencies>
@@ -115,11 +115,7 @@
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>cim</report>
              <report>distribution-management</report>
              <report>dependencies</report>
            </reports>
          </reportSet>
        </reportSets>
opendj-sdk/opendj-core/src/site/xdoc/index.xml.vm
New file
@@ -0,0 +1,102 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013 ForgeRock AS
  !
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About ${project.name}</title>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About ${project.name}">
      <p>
        ${project.description}
      </p>
    </section>
    <section name="Get ${project.name}">
      <p>
        Start developing your applications by obtaining ${project.name}
        using any of the following methods:
    </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
  &lt;/repository>
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
    </section>
    <section name="Getting started">
      <p>
        Please refer to the <a href="../opendj-ldap-sdk">example</a> in the OpenDJ LDAP SDK page.
      </p>
    </section>
  </body>
</document>
opendj-sdk/opendj-grizzly/pom.xml
@@ -101,11 +101,7 @@
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>cim</report>
              <report>distribution-management</report>
              <report>dependencies</report>
            </reports>
          </reportSet>
        </reportSets>
opendj-sdk/opendj-grizzly/src/main/site/xdoc/index.xml.vm
New file
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013 ForgeRock AS
  !
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About ${project.name}</title>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About ${project.name}">
      <p>
        ${project.description}
      </p>
    </section>
    <section name="Get ${project.name}">
      <p>
        Start developing your applications by obtaining ${project.name}
        using any of the following methods:
    </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
  &lt;/repository>
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
    </section>
    <section name="Getting started">
      <p>
        The following example shows how ${project.name} may be used:
      </p>
      <source>TODO</source>
    </section>
  </body>
</document>
opendj-sdk/opendj-ldap-sdk-examples/pom.xml
@@ -76,22 +76,6 @@
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
              <report>cim</report>
              <report>distribution-management</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <links>
opendj-sdk/opendj-ldap-sdk-examples/src/site/site.xml
File was deleted
opendj-sdk/opendj-ldap-sdk-examples/src/site/xdoc/index.xml.vm
@@ -126,7 +126,7 @@
          its
          dependencies is to get the latest version from our
          <a
            href="http://maven.forgerock.org/repo/snapshots/org/forgerock/opendj/opendj-ldap-sdk-examples/${currentSDKversion}">repository</a>
            href="${mavenRepoSnapshots}/org/forgerock/opendj/opendj-ldap-sdk-examples/${currentSDKversion}">repository</a>
          .
        </p>
      </subsection>
opendj-sdk/opendj-ldap-sdk/pom.xml
@@ -21,10 +21,12 @@
  !
  ! CDDL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !      Copyright 2011-2013 ForgeRock AS
  !    
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <artifactId>opendj-project</artifactId>
@@ -34,11 +36,11 @@
  <artifactId>opendj-ldap-sdk</artifactId>
  <name>OpenDJ SDK</name>
  <description>
    This module provides a complete LDAP SDK for developing LDAP Directory
    client and server applications. It includes both the core APIs and a
    default Grizzly based network transport.
    This group module provides a complete LDAP SDK for developing LDAP Directory
    client and server applications. It includes both the core APIs and the
    Grizzly based network transport.
  </description>
  <packaging>jar</packaging>
  <packaging>pom</packaging>
  <dependencies>
    <dependency>
      <groupId>org.forgerock.opendj</groupId>
@@ -51,85 +53,6 @@
      <version>${project.version}</version>
    </dependency>
  </dependencies>
  <properties>
    <opendj.osgi.import>
      com.sun.security.auth*;resolution:=optional,
      *
    </opendj.osgi.import>
  </properties>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <configuration>
          <createSourcesJar>true</createSourcesJar>
          <promoteTransitiveDependencies>true</promoteTransitiveDependencies>
          <artifactSet>
            <includes>
              <include>org.forgerock.opendj:opendj-core</include>
              <include>org.forgerock.opendj:opendj-grizzly</include>
            </includes>
          </artifactSet>
        </configuration>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>com.github.goldin</groupId>
            <artifactId>copy-maven-plugin</artifactId>
            <version>0.2.5</version>
        <executions>
          <execution>
            <id>unpack-jar-to-classes</id>
            <phase>package</phase>
            <goals>
              <goal>copy</goal>
            </goals>
            <configuration>
              <resource>
                  <targetPath>${project.build.outputDirectory}</targetPath>
                  <file>${project.build.directory}/${project.build.finalName}.jar</file>
                  <unpack>true</unpack>
              </resource>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <extensions>true</extensions>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>bundle</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <instructions>
                        <Include-Resource>META-INF/services=target/classes/META-INF/services</Include-Resource>
                    </instructions>
                </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-source-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
  <reporting>
    <plugins>
      <plugin>
@@ -138,24 +61,11 @@
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>cim</report>
              <report>distribution-management</report>
              <report>dependencies</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <configuration>
          <links>
           <link>http://commons.forgerock.org/i18n-framework/i18n-core/apidocs</link>
          </links>
        </configuration>
      </plugin>
    </plugins>
  </reporting>
</project>
opendj-sdk/opendj-ldap-sdk/src/site/site.xml
File was deleted
opendj-sdk/opendj-ldap-sdk/src/site/xdoc/index.xml.vm
@@ -20,14 +20,14 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !      Copyright 2011-2013 ForgeRock AS
  !    
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About OpenDJ LDAP SDK</title>
    <author email="opendj-dev@forgerock.org">ForgeRock AS</author>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About OpenDJ LDAP SDK">
@@ -38,40 +38,31 @@
        Java directory server, and more. You can use OpenDJ SDK to create client
        applications for use with any server that complies with the,
        <a href='http://tools.ietf.org/html/rfc4510'>RFC 4510: Lightweight Directory
          Access Protocol (LDAP):
          Technical Specification Road Map</a>
        .
        Access Protocol (LDAP): Technical Specification Road Map</a>.
      </p>
      <p>
        The OpenDJ LDAP SDK brings you easy-to-use connection management,
        connection pooling, load balancing, and all the standard LDAP operations
        to read and
        write directory entries. OpenDJ LDAP SDK also lets you build
        applications
        with
        capabilities defined in additional draft and
        experimental RFCs that
        are
        supported by modern LDAP servers.</p>
        to read and write directory entries. OpenDJ LDAP SDK also lets you build
        applications with capabilities defined in additional draft and
        experimental RFCs that are supported by modern LDAP servers.
      </p>
    </section>
    <section name="Get the OpenDJ LDAP SDK">
      <p>
        You can start developing your LDAP applications now by obtaining the
        OpenDJ
        LDAP SDK using any of the following methods:
    </p>
        OpenDJ LDAP SDK using any of the following methods:
      </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your
          <b>pom.xml</b>
          :
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>http://maven.forgerock.org/repo/releases&lt;/url>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
@@ -79,44 +70,52 @@
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>http://maven.forgerock.org/repo/snapshots&lt;/url>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
&lt;/repositories></source>
        <p>
          The following dependency will load both the OpenDJ Core APIs and the
          OpenDJ Grizzly network transport:
        </p>
        <source>&lt;dependencies>
  &lt;dependency>
    &lt;groupId>org.forgerock.opendj&lt;/groupId>
    &lt;artifactId>opendj-ldap-sdk&lt;/artifactId>
    &lt;version>${currentSDKversion}&lt;/version>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
    &lt;type>pom&lt;/type>
  &lt;/dependency>
&lt;/dependencies></source>
        <p>
          In some use-cases, such as developing LDAP unit tests or embedded
          LDAP applications, the network transport is not required, in which
          case you can simply declare a dependency on the OpenDJ core APIs:
        </p>
        <source>&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>opendj-core&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          The easiest way to download the OpenDJ LDAP SDK and all of its
          dependencies is to get either the
          <a href="http://builds.forgerock.org/view/OpenDJ/job/OpenDJ3/lastStableBuild/org.forgerock.opendj$opendj-ldap-toolkit/artifact/org.forgerock.opendj/opendj-ldap-toolkit/${currentSDKversion}/opendj-ldap-toolkit-${currentSDKversion}.zip">OpenDJ LDAP SDK Toolkit ZIP file</a>
          or the
          <a href="http://builds.forgerock.org/view/OpenDJ/job/OpenDJ3/lastStableBuild/org.forgerock.opendj$opendj-ldap-sdk-examples/artifact/org.forgerock.opendj/opendj-ldap-sdk-examples/${currentSDKversion}/opendj-ldap-sdk-examples-${currentSDKversion}.jar">OpenDJ LDAP SDK Examples JAR file</a>
          . Alternatively, if you can download the individual JARs from the
          following locations:
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="http://builds.forgerock.org/view/OpenDJ/job/OpenDJ3/lastStableBuild/org.forgerock.opendj$opendj-ldap-sdk/artifact/org.forgerock.opendj/opendj-ldap-sdk/${currentSDKversion}/opendj-ldap-sdk-${currentSDKversion}.jar">opendj-ldap-sdk-${currentSDKversion}.jar</a> - OpenDJ LDAP SDK</li>
          <li><a href="http://maven.forgerock.org/repo/releases/org/forgerock/commons/i18n-core/${i18nFrameworkVersion}/i18n-core-${i18nFrameworkVersion}.jar">i18n-core-${i18nFrameworkVersion}.jar</a> - ForgeRock Commons I18N Framework</li>
          <li><a href="http://search.maven.org/remotecontent?filepath=org/glassfish/grizzly/grizzly-framework/${grizzlyFrameworkVersion}/grizzly-framework-${grizzlyFrameworkVersion}.jar">grizzly-framework-${grizzlyFrameworkVersion}.jar</a> - Grizzly IO Framework</li>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/opendj-core">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/opendj-core/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using
          <a href="source-repository.html">Subversion</a>
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
@@ -124,12 +123,9 @@
    <section name="Getting started">
      <p>
        The following example shows how the OpenDJ SDK may be used to
        connect to
        a Directory Server, authenticate, and then perform a
        search. The search
        results are output as LDIF to the standard
        output:
        </p>
        connect to a Directory Server, authenticate, and then perform a
        search. The search results are output as LDIF to the standard output:
      </p>
      <source>// Create an LDIF writer which will write the search results to stdout.
final LDIFEntryWriter writer = new LDIFEntryWriter(System.out);
Connection connection = null;
opendj-sdk/opendj-ldap-toolkit/pom.xml
@@ -106,24 +106,4 @@
      </plugin>
    </plugins>
  </build>
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
              <report>cim</report>
              <report>distribution-management</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
    </plugins>
  </reporting>
</project>
opendj-sdk/opendj-ldap-toolkit/src/site/site.xml
File was deleted
opendj-sdk/opendj-ldap-toolkit/src/site/xdoc/index.xml.vm
@@ -57,7 +57,7 @@
        <p>
          The easiest way to download the OpenDJ LDAP Toolkit is to get the latest version from our
          <a
            href="http://maven.forgerock.org/repo/snapshots/org/forgerock/opendj/opendj-ldap-toolkit/${currentSDKversion}">repository</a>
            href="${mavenRepoSnapshots}/org/forgerock/opendj/opendj-ldap-toolkit/${currentSDKversion}">repository</a>
          .
        </p>
      </subsection>
opendj-sdk/opendj-rest2ldap-servlet/pom.xml
@@ -179,4 +179,19 @@
          </plugins>
        </pluginManagement>
    </build>
    <reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-project-info-reports-plugin</artifactId>
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>dependencies</report>
                        </reports>
                    </reportSet>
                </reportSets>
            </plugin>
        </plugins>
    </reporting>
</project>
opendj-sdk/opendj-rest2ldap-servlet/src/site/xdoc/index.xml.vm
New file
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013 ForgeRock AS
  !
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About ${project.name}</title>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About ${project.name}">
      <p>
        ${project.description}
      </p>
    </section>
    <section name="Get ${project.name}">
      <p>
        Start developing your applications by obtaining ${project.name}
        using any of the following methods:
    </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
  &lt;/repository>
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
    </section>
    <section name="Getting started">
      <p>
        The following example shows how ${project.name} may be used:
      </p>
      <source>TODO</source>
    </section>
  </body>
</document>
opendj-sdk/opendj-rest2ldap/pom.xml
@@ -93,12 +93,7 @@
                <reportSets>
                    <reportSet>
                        <reports>
                            <report>mailing-list</report>
                            <report>issue-tracking</report>
                            <report>license</report>
                            <report>scm</report>
                            <report>cim</report>
                            <report>distribution-management</report>
                            <report>dependencies</report>
                        </reports>
                    </reportSet>
                </reportSets>
opendj-sdk/opendj-rest2ldap/src/site/xdoc/index.xml.vm
New file
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013 ForgeRock AS
  !
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About ${project.name}</title>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About ${project.name}">
      <p>
        ${project.description}
      </p>
    </section>
    <section name="Get ${project.name}">
      <p>
        Start developing your applications by obtaining ${project.name}
        using any of the following methods:
    </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
  &lt;/repository>
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
    </section>
    <section name="Getting started">
      <p>
        The following example shows how ${project.name} may be used:
      </p>
      <source>TODO</source>
    </section>
  </body>
</document>
opendj-sdk/opendj-server2x-adapter/pom.xml
@@ -85,12 +85,7 @@
        <reportSets>
          <reportSet>
            <reports>
              <report>mailing-list</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
              <report>cim</report>
              <report>distribution-management</report>
              <report>dependencies</report>
            </reports>
          </reportSet>
        </reportSets>
opendj-sdk/opendj-server2x-adapter/src/site/xdoc/index.xml.vm
New file
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013 ForgeRock AS
  !
-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
  <properties>
    <title>About ${project.name}</title>
    <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
  </properties>
  <body>
    <section name="About ${project.name}">
      <p>
        ${project.description}
      </p>
    </section>
    <section name="Get ${project.name}">
      <p>
        Start developing your applications by obtaining ${project.name}
        using any of the following methods:
    </p>
      <subsection name="Maven">
        <p>
          By far the simplest method is to develop your application using Maven
          and add the following settings to your <b>pom.xml</b>:
        </p>
        <source>&lt;repositories>
  &lt;repository>
    &lt;id>forgerock-staging-repository&lt;/id>
    &lt;name>ForgeRock Release Repository&lt;/name>
    &lt;url>${mavenRepoReleases}&lt;/url>
    &lt;snapshots>
      &lt;enabled>false&lt;/enabled>
    &lt;/snapshots>
  &lt;/repository>
  &lt;repository>
    &lt;id>forgerock-snapshots-repository&lt;/id>
    &lt;name>ForgeRock Snapshot Repository&lt;/name>
    &lt;url>${mavenRepoSnapshots}&lt;/url>
    &lt;releases>
      &lt;enabled>false&lt;/enabled>
    &lt;/releases>
  &lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
  &lt;dependency>
    &lt;groupId>${project.groupId}&lt;/groupId>
    &lt;artifactId>${project.artifactId}&lt;/artifactId>
    &lt;version>${project.version}&lt;/version>
  &lt;/dependency>
&lt;/dependencies></source>
      </subsection>
      <subsection name="Download">
        <p>
          If you are not using Maven then you will need to download a pre-built
          binary from the ForgeRock Maven repository, along with any compile
          time <a href="dependencies.html">dependencies</a>:
        </p>
        <ul>
          <li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
          <li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
        </ul>
      </subsection>
      <subsection name="Build">
        <p>
          For the DIY enthusiasts you can build it yourself by checking out the
          latest code using <a href="source-repository.html">Subversion</a>
          and building it with Maven 3.
        </p>
      </subsection>
    </section>
    <section name="Getting started">
      <p>
        The following example shows how ${project.name} may be used:
      </p>
      <source>TODO</source>
    </section>
  </body>
</document>
opendj-sdk/pom.xml
@@ -28,7 +28,7 @@
  <parent>
    <groupId>org.forgerock</groupId>
    <artifactId>forgerock-parent</artifactId>
    <version>1.1.0</version>
    <version>1.2.0-SNAPSHOT</version>
  </parent>
  <groupId>org.forgerock.opendj</groupId>
  <artifactId>opendj-project</artifactId>
@@ -99,6 +99,8 @@
    <module>opendj-server2x-adapter</module>
  </modules>
  <properties>
    <mavenRepoSnapshots>http://maven.forgerock.org/repo/snapshots</mavenRepoSnapshots>
    <mavenRepoReleases>http://maven.forgerock.org/repo/releases</mavenRepoReleases>
    <forgerockBuildToolsVersion>1.0.2</forgerockBuildToolsVersion>
    <currentSDKversion>${project.version}</currentSDKversion>
    <stableSDKversion>version.not.defined</stableSDKversion>
@@ -410,6 +412,8 @@
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
              <report>cim</report>
              <report>distribution-management</report>
            </reports>
          </reportSet>
        </reportSets>
@@ -420,7 +424,7 @@
    <repository>
      <id>forgerock-staging-repository</id>
      <name>ForgeRock Release Repository</name>
      <url>http://maven.forgerock.org/repo/releases</url>
      <url>${mavenRepoReleases}</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
@@ -428,7 +432,7 @@
    <repository>
      <id>forgerock-snapshots-repository</id>
      <name>ForgeRock Snapshot Repository</name>
      <url>http://maven.forgerock.org/repo/snapshots</url>
      <url>${mavenRepoSnapshots}</url>
      <releases>
        <enabled>false</enabled>
      </releases>
opendj-sdk/src/site/site.xml
@@ -43,7 +43,7 @@
   <item name="OpenDJ" href="http://opendj.forgerock.org" />
  </breadcrumbs>
  <menu name="OpenDJ">
  <menu name="OpenDJ" inherit="top">
   <item name="Welcome" href="index.html" />
   <item name="News" href="news.html" />
   <item name="FAQ" href="faq.html" />
@@ -57,27 +57,30 @@
   <item name="Enterprise Downloads" href="http://www.forgerock.com/download-stack/"/>
  </menu>
  <menu name="OpenDJ Directory Server">
  <menu name="OpenDJ Directory Server" inherit="top">
    <item name="About" href="opendj-server" />
  </menu>
  <menu name="OpenDJ LDAP SDK">
  <menu name="OpenDJ LDAP SDK" inherit="top">
    <item name="About" href="opendj-ldap-sdk" />
    <item name="Grizzly Integration" href="opendj-grizzly" />
    <item name="Examples" href="opendj-ldap-sdk-examples" />
    <item name="Toolkit" href="opendj-ldap-toolkit" />
    <item name="Rest2LDAP" href="opendj-rest2ldap" />
    <item name="Rest2LDAP Servlet" href="opendj-rest2ldap-servlet" />
  </menu>
  <menu name="OpenDJ Mobile Apps">
  <menu name="OpenDJ Mobile Apps" inherit="top">
    <item name="Contact Manager (Android)"
          href="http://commons.forgerock.org/mobile/contact-manager/" />
  </menu>
  <menu name="Released Documentation">
  <menu name="Released Documentation" inherit="top">
    <item name="OpenDJ 2.6.0" href="http://docs.forgerock.org/en/opendj/2.6.0/" />
    <item name="OpenDJ 2.5.0-Xpress1" href="http://docs.forgerock.org/en/opendj/2.5.0-Xpress1/" />
  </menu>
  <menu name="OpenDJ Documentation">
  <menu name="OpenDJ Documentation" inherit="top">
   <item name="All Formats" href="docs.html" />
   <item name="Release Notes" href="./opendj-server/doc/release-notes/index.html" />
   <item name="Installation Guide" href="./opendj-server/doc/install-guide/index.html" />
@@ -85,14 +88,15 @@
   <item name="Developer Guide" href="./doc/dev-guide/index.html" />
   <item name="Config Reference" href="./opendj-server/configref/index.html" />
   <item name="Plugin Javadoc" href="./opendj-server/javadoc/index.html" />
   <item name="SDK Javadoc" href="./opendj-ldap-sdk/apidocs/index.html" />
   <item name="SDK Javadoc" href="./opendj-core/apidocs/index.html" />
  </menu>
  <menu name="OpenDJ Development">
   <item name="Join" href="https://sso.forgerock.com/openam/UI/Login" />
   <item name="Issue Tracking" href="issue-tracking.html" />
   <item name="License" href="license.html" />
   <item name="Source Repository" href="source-repository.html" />
  <menu name="OpenDJ Development" inherit="top">
    <item name="Source Repository" href="source-repository.html" />
    <item name="Continuous Integration" href="integration.html" />
    <item name="Maven Repository" href="distribution-management.html" />
    <item name="Issue Tracking" href="issue-tracking.html" />
    <item name="License" href="license.html" />
  </menu>
 </body>