CR-7039 OPENDJ-1547 Example.ldif should be part of the doc build

Mark Craig

22.07.2015 20e5f98b9264a52f65a17c4738172163a8a87aad

CR-7039 OPENDJ-1547 Example.ldif should be part of the doc build

This patch uses a new feature of the doc build plugin
to move extra resource files in with the versioned doc sources.

 opendj-server-legacy/pom.xml

@@ -1961,13 +1961,14 @@
            <groupId>org.forgerock.commons</groupId>
            <artifactId>forgerock-doc-maven-plugin</artifactId>
            <inherited>false</inherited>
            <!-- Use conditional text to exclude local-db related elements in hand-written docs.
            <configuration>
              <copyResourceFiles>true</copyResourceFiles>
              <!-- Use conditional text to exclude local-db related elements in hand-written docs.
              <exclusions>
                <condition>local-db</condition>
              </exclusions>
            </configuration>
            -->
            </configuration>
            <executions>
              <execution>
                <id>build-doc</id>

 opendj-server-legacy/src/main/docbkx/admin-guide/chap-connection-handlers.xml

@@ -1185,7 +1185,7 @@
   xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
   Configuration</citetitle></link>. The default mapping works out of the box
   with Example.com data generated as part of the setup process and with
   <link xlink:show="new" xlink:href="http://opendj.forgerock.org/Example.ldif"
   <link xlink:show="new" xlink:href="../resources/Example.ldif"
   >Example.ldif</link>.</para>

   <step>

 opendj-server-legacy/src/main/docbkx/admin-guide/chap-privileges-acis.xml

@@ -1289,8 +1289,10 @@
   </screen>

   <para>
    You can download an example of the captured command,
    <link xlink:href="http://opendj.forgerock.org/captured-global-aci-edits.sh"
    An example of the captured command is
    <link
     xlink:href="../resources/captured-global-aci-edits.sh"
     xlink:show="new"
    >captured-global-aci-edits.sh</link>.
   </para>


 opendj-server-legacy/src/main/docbkx/install-guide/chap-install-cli.xml

@@ -875,7 +875,7 @@
   the gateway translates between JSON and LDAP representations of your
   data. The default <literal>mappings</literal> are built to work with
   generated example data and also the sample content in <link xlink:show="new"
   xlink:href="http://opendj.forgerock.org/Example.ldif"
   xlink:href="../resources/Example.ldif"
   >Example.ldif</link>.</para>

   <para>At minimum, make sure that the host name and port numbers for

 opendj-server-legacy/src/main/docbkx/resources/Example.ldif

New file
Diff too large

 opendj-server-legacy/src/main/docbkx/resources/captured-global-aci-edits.sh

New file
@@ -0,0 +1,48 @@
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License, Version 1.0 only
# (the "License").  You may not use this file except in compliance
# with the License.
#
# You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
# or http://forgerock.org/license/CDDLv1.0.html.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at legal-notices/CDDLv1_0.txt.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information:
#      Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#
#      Portions Copyright 2015 ForgeRock AS.
#
#
# Captured dsconfig command to replace anonymous read access with authenticated access.
# Edit this script to match your deployment.
#
# This command does not affect global-aci properties allowing anonymous access
# to read the root DSE and to read directory schema definitions,
# nor to use selected LDAP controls and extended operations.
#
# This command works against a server built following the changes introduced
# in http://sources.forgerock.org/changelog/opendj?cs=9325.
# If the global-aci settings are different on your OpenDJ server,
# generate this script for that server as described in the documentation.
#
dsconfig set-access-control-handler-prop \
          --remove global-aci:\(targetattr!=\"userPassword\|\|authPassword\|\|debugsearchindex\|\|changes\|\|changeNumber\|\|changeType\|\|changeTime\|\|targetDN\|\|newRDN\|\|newSuperior\|\|deleteOldRDN\"\)\(version\ 3.0\;\ acl\ \"Anonymous\ read\ access\"\;\ allow\ \(read,search,compare\)\ userdn=\"ldap:///anyone\"\;\) \
          --remove global-aci:\(targetattr=\"createTimestamp\|\|creatorsName\|\|modifiersName\|\|modifyTimestamp\|\|entryDN\|\|entryUUID\|\|subschemaSubentry\|\|etag\|\|governingStructureRule\|\|structuralObjectClass\|\|hasSubordinates\|\|numSubordinates\"\)\(version\ 3.0\;\ acl\ \"User-Visible\ Operational\ Attributes\"\;\ allow\ \(read,search,compare\)\ userdn=\"ldap:///anyone\"\;\) \
          --add global-aci:\(targetattr!=\"userPassword\|\|authPassword\|\|debugsearchindex\|\|changes\|\|changeNumber\|\|changeType\|\|changeTime\|\|targetDN\|\|newRDN\|\|newSuperior\|\|deleteOldRDN\"\)\(version\ 3.0\;\ acl\ \"Authenticated\ read\ access\"\;\ allow\(read,search,compare\)\ userdn=\"ldap:///all\"\;\) \
          --add global-aci:\(targetattr=\"createTimestamp\|\|creatorsName\|\|modifiersName\|\|modifyTimestamp\|\|entryDN\|\|entryUUID\|\|subschemaSubentry\|\|etag\|\|governingStructureRule\|\|structuralObjectClass\|\|hasSubordinates\|\|numSubordinates\"\)\(version\ 3.0\;\ acl\ \"User-Visible\ Operational\ Attributes\"\;\ allow\(read,search,compare\)\ userdn=\"ldap:///all\"\;\) \
          --hostname opendj.example.com \
          --port 4444 \
          --trustStorePath /path/to/opendj/config/admin-truststore \
          --bindDN cn=Directory\ Manager \
          --bindPassword ****** \
          --no-prompt


 opendj-server-legacy/src/main/docbkx/server-dev-guide/chap-groups.xml

@@ -81,7 +81,7 @@
 <tip>
  <para>The examples in this chapter are written with the assumption that an
  <literal>ou=Groups,dc=example,dc=com</literal> entry already exists. If you
  imported data from <link xlink:href="http://opendj.forgerock.org/Example.ldif"
  imported data from <link xlink:href="../resources/Example.ldif"
  xlink:show="new">Example.ldif</link>, then you already have the entry. If you
  generated data during setup and did not create an organizational unit for
  groups yet, create the entry before you try the examples.</para>

 opendj-server-legacy/src/main/docbkx/server-dev-guide/chap-ldap-operations.xml

@@ -1550,7 +1550,7 @@
   create a certificate, then add the certificate attributes to the
   entry.</para>

   <para><link xlink:href="http://opendj.forgerock.org/Example.ldif"
   <para><link xlink:href="../resources/Example.ldif"
   xlink:show="new">Example.ldif</link> includes an entry for
   <literal>cn=My App,ou=Apps,dc=example,dc=com</literal>. Examples in this
   section use that entry, and use the Java <command>keytool</command> command

 opendj-server-legacy/src/main/docbkx/server-dev-guide/chap-rest-operations.xml

@@ -54,7 +54,7 @@
  from
  <link
   xlink:show="new"
   xlink:href="http://opendj.forgerock.org/Example.ldif"
   xlink:href="../resources/Example.ldif"
  >Example.ldif</link>.
 </para>

@@ -198,7 +198,7 @@
   When you install OpenDJ either with generated sample user entries
   or with data from
   <link
    xlink:href="http://opendj.forgerock.org/Example.ldif"
    xlink:href="../resources/Example.ldif"
    xlink:show="new">Example.ldif</link>,
   the relative distinguished name (DN) attribute for sample user entries
   is the user ID (<literal>uid</literal>) attribute.

 opendj-server-legacy/src/main/docbkx/server-dev-guide/chap-virtual-attrs-collective-attrs.xml

@@ -226,7 +226,7 @@
     <para>The following example depends on the <literal>cos</literal> object
     class, and the <literal>classOfService</literal> attribute type defined but
     commented out in the <link xlink:show="new"
     xlink:href="http://opendj.forgerock.org/Example.ldif"><filename
     xlink:href="../resources/Example.ldif"><filename
     >Example.ldif</filename></link> file imported as sample data. To try this
     example for yourself, add the attribute type and object class definitions
     in comments near the top of the file, and then uncomment the
@@ -397,7 +397,7 @@

   <para>This example demonstrates how to instruct OpenDJ to set an employee's
   department number using the manager's department number. To try the example,
   first import <link xlink:href="http://opendj.forgerock.org/Example.ldif"
   first import <link xlink:href="../resources/Example.ldif"
   xlink:show="new"><filename>Example.ldif</filename></link> into OpenDJ in
   order to load the appropriate sample data.</para>

@@ -455,7 +455,7 @@

   <para>This example demonstrates how to instruct OpenDJ to set a user's language
   preferences and street address based on locality. To try the example, first
   import <link xlink:href="http://opendj.forgerock.org/Example.ldif"
   import <link xlink:href="../resources/Example.ldif"
   xlink:show="new"><filename>Example.ldif</filename></link> into OpenDJ in
   order to load the appropriate sample data.</para>


 pom.xml

@@ -197,6 +197,7 @@
         <jCiteSourcePaths>
           <jCiteSourcePath>${project.basedir}/opendj-ldap-sdk-examples/src/main/java</jCiteSourcePath>
         </jCiteSourcePaths>
         <copyResourceFiles>true</copyResourceFiles>
        </configuration>
        <executions>
          <execution>

 src/main/docbkx/dev-guide/chap-get-sdk.xml

@@ -9,8 +9,7 @@
  ! 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.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -72,7 +71,7 @@
  <para>Install an LDAP server such as OpenDJ directory server that you can
  use to test the applications you develop. Also, load sample data into your
  server. The sample data used in this guide are available in LDIF form at
  <link xlink:show="new" xlink:href="http://opendj.forgerock.org/Example.ldif" />.</para>
  <link xlink:show="new" xlink:href="../resources/Example.ldif" />.</para>
 </section>

 <section xml:id="getting-the-ldap-sdk">

 src/main/docbkx/dev-guide/chap-reading.xml

@@ -9,8 +9,7 @@
  ! 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.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,7 +19,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2013 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-reading'
@@ -34,7 +33,7 @@
 <para>Traditionally directories excel at serving read requests. This chapter
 covers the read (search and compare) capabilities that OpenDJ LDAP Java SDK
 provides. The data used in examples here is <link xlink:show="new"
 xlink:href="http://opendj.forgerock.org/Example.ldif">available
 xlink:href="../resources/Example.ldif">available
 online</link>.</para>

 <section xml:id="about-searching">

 src/main/docbkx/dev-guide/chap-simple-proxy.xml

@@ -9,8 +9,7 @@
  ! 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.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,7 +19,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2014 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-simple-proxy'
@@ -221,7 +220,7 @@

  <para>In the above output, the rewriter proxy listens on port 8389,
  connecting to a directory server listening on 1389. The directory server
  contains data from <link xlink:href="http://opendj.forgerock.org/Example.ldif"
  contains data from <link xlink:href="../resources/Example.ldif"
  xlink:show="new"><filename>Example.ldif</filename></link>.</para>
 </section>
</chapter>

 src/main/docbkx/dev-guide/chap-writing.xml

@@ -9,8 +9,7 @@
  ! 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.
  ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,7 +19,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2013 ForgeRock AS
  !      Copyright 2011-2015 ForgeRock AS.
  !    
-->
<chapter xml:id='chap-writing'
@@ -238,17 +237,13 @@

  <para>Static groups enumerate user entries. Static groups can grow large.
  For an example, see the group entry at the end of <link xlink:show="new"
  xlink:href="http://opendj.forgerock.org/big-group.ldif">big-group.ldif</link>:</para>
  xlink:href="../resources/big-group.ldif">big-group.ldif</link>:</para>

  <programlisting language="ldif">dn: cn=Static,ou=Groups,dc=example,dc=com
objectClass: top
objectClass: groupofnames
cn: Static
member: uid=user.0,ou=People,dc=example,dc=com
member: uid=user.1,ou=People,dc=example,dc=com
member: uid=user.2,ou=People,dc=example,dc=com
  <programlisting language="ldif">
[../resources/big-group.ldif:group-top]
...
member: uid=user.10000,ou=People,dc=example,dc=com</programlisting>
[../resources/big-group.ldif:group-bottom]
  </programlisting>

  <para>To update a static group, you either add members or remove members.
  For sample code, see <link

 src/main/docbkx/resources/Example.ldif

New file
Diff too large

 src/main/docbkx/resources/big-group.ldif

New file
Diff too large