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

Mark Craig
07.42.2013 80ac1d539f91b20c641e91b4e5137bfbaea7f34c
CR-1809 Fix for OPENDJ-957: Clean up TODO items in core documentation
5 files modified
10214 ■■■■ changed files
opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml 6 ●●●●● patch | view | raw | blame | history
opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml 29 ●●●●● patch | view | raw | blame | history
opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml 8 ●●●●● patch | view | raw | blame | history
opendj3/src/main/docbkx/release-notes/chap-whats-new.xml 112 ●●●●● patch | view | raw | blame | history
opendj3/src/main/docbkx/shared/man-dsconfig.xml 10059 ●●●● patch | view | raw | blame | history
opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml
@@ -28,7 +28,7 @@
         xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
         xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
         xmlns:xlink='http://www.w3.org/1999/xlink'
        >
         xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <title>Configuring Password Policy</title>
 <indexterm><primary>Password policy</primary></indexterm>
 
@@ -41,9 +41,7 @@
 
 <para>This chapter covers password policy, including examples of how
 to configure password policies for common use cases.</para>
 <!-- TODO: A section with a larger set of examples would be nice. -->
 <section xml:id="pwp-overview">
  <title>About OpenDJ Password Policies</title>
  
opendj3/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -864,7 +864,7 @@
 <section xml:id="action-rest">
  <title>Using Actions</title>
  <para>OpenDJ implements an action that lets the server choose the resource ID
  <para>OpenDJ implements an action that lets the server set the resource ID
  on creation. To use this action, perform an HTTP POST with header
  <literal>Content-Type: application/json</literal>,
  <literal>_action=create</literal> in the query string, and the JSON content of
@@ -873,7 +873,6 @@
  <para>The following example creates a new user entry. Lines are folded for
  readability.</para>
  <para>TODO, fix pending https://bugster.forgerock.org/jira/browse/OPENDJ-775</para>
  <screen width="82">$ curl
 --request POST
 --user kvaughan:bribery
@@ -919,8 +918,6 @@
    "displayName" : "Kirsten Vaughan"
  } ]
}</screen>
  <para>TODO, https://bugster.forgerock.org/jira/browse/OPENDJ-695</para>
 </section>
 <section xml:id="query-rest">
@@ -1127,16 +1124,6 @@
}</screen>
       </listitem>
      </varlistentry>
      <!--
      <varlistentry>
       <term><literal><replaceable>json-pointer</replaceable> <replaceable>string</replaceable> <replaceable>json-value</replaceable></literal></term>
       <listitem>
        <para>Matches an extended comparison.</para>
        <screen>TODO</screen>
       </listitem>
      </varlistentry>
      -->
     </variablelist>
    </listitem>
   </varlistentry>
@@ -1249,36 +1236,38 @@
   </varlistentry>
  </variablelist>
  <!--  Pending implementation https://bugster.forgerock.org/jira/browse/OPENDJ-702
  <para>You can have the server sort JSON resources before it returns them by
  using the <literal>_sortKeys[+-]=<replaceable>field</replaceable>[,&#8230;]</literal>
  query string. TODO, pending implementation https://bugster.forgerock.org/jira/browse/OPENDJ-702</para>
  query string.</para>
  -->
  <!-- Pending implementation https://bugster.forgerock.org/jira/browse/OPENDJ-701
  <variablelist>
   <para>You can page through search results using the following query string
   parameters.</para>
   <para>TODO, pending implementation https://bugster.forgerock.org/jira/browse/OPENDJ-701</para>
   <varlistentry>
    <term><literal>__pagedResultsCookie=<replaceable>string</replaceable></literal></term>
    <listitem>
     <para>TODO</para>
     <para></para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>__pagedResultsOffset=<replaceable>string</replaceable></literal></term>
    <listitem>
     <para>TODO</para>
     <para></para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>__pagedResultsCookie=<replaceable>string</replaceable></literal></term>
    <listitem>
     <para>TODO</para>
     <para></para>
    </listitem>
   </varlistentry>
  </variablelist>
  -->
 </section>
</chapter>
opendj3/src/main/docbkx/dev-guide/chap-using-the-sdk.xml
@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !      Copyright 2011-2013 ForgeRock AS
  !    
-->
<chapter xml:id='chap-using-the-sdk'
@@ -180,6 +180,7 @@
  problems after the fact.</para>
 </section>
 <!-- Pending https://bugster.forgerock.org/jira/browse/OPENDJ-178
 <section xml:id="referral-handling">
  <title>Managing Referrals</title>
  <indexterm>
@@ -189,7 +190,8 @@
  <indexterm>
   <primary>Referrals</primary>
  </indexterm>
  <!-- See https://bugster.forgerock.org/jira/browse/OPENDJ-178 -->
  <para>TODO</para>
  <para></para>
 </section>
 -->
</chapter>
opendj3/src/main/docbkx/release-notes/chap-whats-new.xml
@@ -31,50 +31,65 @@
  xmlns:xinclude='http://www.w3.org/2001/XInclude'>
  <title>What's New in OpenDJ <?eval ${docTargetVersion}?></title>
  <important>
   <!-- Keep the highlights? Or fold this into the main list? -->
   <itemizedlist>
    <para>OpenDJ 2.5.0 brings you the latest features such as:</para>
    <listitem>
     <para>Capability to delegate authentication to Microsoft Active Directory
     (pass-through authentication)</para>
    </listitem>
    <listitem>
     <para>Improved enforcement of referential integrity for groups, whereby
     OpenDJ can now ensure both that members' entries exist when they are added
     to groups, and also that members are removed from groups when their entries
     are deleted</para>
    </listitem>
    <listitem>
     <para>Access log filtering, with additional output configuration to combine
     request and response messages, log control OIDs, and specify timestamp
     formats</para>
    </listitem>
    <listitem>
     <para>Optimistic concurrency control through ETag attributes</para>
    </listitem>
    <listitem>
     <para>Synchronization of Samba and OpenDJ passwords</para>
    </listitem>
   </itemizedlist>
  </important>
  <para>Compared to the OpenDJ <?eval ${stableServerVersion}?> release, OpenDJ
  <?eval ${docTargetVersion}?> fixes a number of issues. OpenDJ
  <?eval ${docTargetVersion}?> provides the following new features.</para>
  
  <itemizedlist>
    <listitem>
     <para>TODO: Bring this list up to date with issue tracker</para>
     <para>OpenDJ now lets you use more TLS cipher suites in SSFs, including
     those provided by Bouncy Castle and IBM. (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-826"
     >OPENDJ-826</link>).</para>
    </listitem>
    <listitem>
     <para>OpenDJ now provides RESTful access to directory data (<link
     xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-687"
     >OPENDJ-687</link>, <link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-688"
     >OPENDJ-688</link>).</para>
     <para>OpenDJ now provides native RESTful access over HTTP to directory
     data. (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-808"
     >OPENDJ-808</link>). See the procedure, <link xlink:show="new"
     xlink:href="admin-guide#setup-rest2ldap-connection-handler"
     xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Set Up REST
     Access to OpenDJ Directory Server</citetitle></link>, to activate this
     feature.</para>
     <para>OpenDJ REST LDAP gateway lets clients access directory data in remote
     LDAP servers over HTTP. (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-757"
     >OPENDJ-757</link>). See the procedure, <link xlink:show="new"
     xlink:href="install-guide#install-rest2ldap-servlet"
     xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Install
     OpenDJ REST LDAP Gateway</citetitle></link>, to get started.</para>
    </listitem>
    <listitem>
     <para>OpenDJ now lets you escape characters in <command>make-ldif</command>
     templates. (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-800"
     >OPENDJ-800</link>).</para>
    </listitem>
    <listitem>
     <para>Persistent connections can now be identified when querying
     <literal>cn=monitor</literal> for the LDAP client connection handler.
     (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-677"
     >OPENDJ-677</link>).</para>
    </listitem>
    <listitem>
     <para>OpenDJ now runs more reliably as a Windows Service. (<link
     xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-617"
     >OPENDJ-617</link>).</para>
    </listitem>
    <listitem>
     <para>Country String syntax now validates ISO 3166 codes. (<link
     xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-562"
     >OPENDJ-562</link>).</para>
    </listitem>
    <listitem>
     <para>OpenDJ now sets <literal>isMemberOf</literal> on groups as well as
     user entries (<link xlink:show="new"
@@ -116,6 +131,11 @@
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-455"
     >OPENDJ-455</link>).</para>
     <para>Also, you can now force OpenDJ upgrade to complete if errors occur in
     non-interactive mode. (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-522"
     >OPENDJ-522</link>).</para>
     <para>See <link xlink:show="new" xlink:href="install-guide#chap-upgrade"
     xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Upgrading to
     OpenDJ <?eval ${docTargetVersion}?></citetitle></link> for
@@ -160,6 +180,13 @@
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-409"
     >OPENDJ-409</link>).</para>
    </listitem>
    <listitem>
     <para>OpenDJ now provides Debian and RPM packages (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-408"
     >OPENDJ-408</link>).</para>
    </listitem>
    <listitem>
     <para>OpenDJ now provides the <command>rebuild-index
     --rebuildDegraded</command> command for rebuilding degraded indexes
@@ -197,7 +224,9 @@
     <para>OpenDJ now uses Berkeley JE 5, which brings many performance
     improvements (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-371"
     >OPENDJ-371</link>).</para>
     >OPENDJ-371</link>, <link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-662"
     >OPENDJ-662</link>).</para>
    </listitem>
    <listitem>
     <para>More OpenDJ tools now prompt for a bind password when none is
@@ -319,7 +348,9 @@
     <para>OpenDJ now supports checking that entries of new group members
     exist (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-221"
     >OPENDJ-221</link>).</para>
     >OPENDJ-221</link>). OpenDJ can now ensure both that members' entries
     exist when they are added to groups, and also that members are removed
     from groups when their entries are deleted.</para>
    </listitem>
    <listitem>
     <para>OpenDJ now better supports more, and larger static groups
@@ -346,7 +377,10 @@
     <para>The character set password validator now supports optional character
     sets (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-168"
     >OPENDJ-168</link>).</para>
     >OPENDJ-168</link>). Also, The character set password validator now
     understands classes like "All non-Latin characters" (<link xlink:show="new"
     xlink:href="https://bugster.forgerock.org/jira/browse/OPENDJ-620"
     >OPENDJ-620</link>)</para>
    </listitem>
    <listitem>
     <para>Collective attributes can now be applied based on the values of
opendj3/src/main/docbkx/shared/man-dsconfig.xml
Diff too large