Partial fix for OPENDJ-699: Implement DN reference mapping

Matthew Swift

05.15.2013 d6264c618deb82efe028ca19a5eba006c1942fa5

Partial fix for OPENDJ-699: Implement DN reference mapping

* fix typo in Javadoc.

 opendj3/opendj-rest2ldap/src/main/java/org/forgerock/opendj/rest2ldap/Rest2LDAP.java

@@ -112,7 +112,7 @@
         * configuration. See
         * {@link Rest2LDAP#configureConnectionFactory(JsonValue)} for a
         * detailed specification of the JSON configuration.
         * 
         *
         * @param configuration
         *            The JSON configuration.
         * @return A reference to this builder.
@@ -129,16 +129,16 @@
         * configuration. The caller is still required to set the connection
         * factory. The configuration should look like this, excluding the
         * C-like comments:
         * 
         *
         * <pre>
         * {
         *     // The base DN beneath which LDAP entries are to be found.
         *     "baseDN" : "ou=people,dc=example,dc=com",
         * 
         *
         *     // The mechanism which should be used for read resources during updates, must be
         *     // one of "disabled", "controls", or "search".
         *     "readOnUpdatePolicy" : "controls",
         * 
         *
         *     // Additional LDAP attributes which should be included with entries during add (create) operations.
         *     "additionalLDAPAttributes" : [
         *         {
@@ -149,28 +149,28 @@
         *             ]
         *         }
         *     ],
         * 
         *
         *     // The strategy which should be used for deriving LDAP entry names from JSON resources.
         *     "namingStrategy" : {
         *         // Option 1) the RDN and resource ID are both derived from a single user attribute in the entry.
         *         "strategy" : "clientDNNaming",
         *         "dnAttribute" : "uid"
         * 
         *
         *         // Option 2) the RDN and resource ID are derived from separate user attributes in the entry.
         *         "strategy" : "clientNaming",
         *         "dnAttribute" : "uid",
         *         "idAttribute" : "mail"
         * 
         *
         *         // Option 3) the RDN and is derived from a user attribute and the resource ID from an operational
         *         //           attribute in the entry.
         *         "strategy" : "serverNaming",
         *         "dnAttribute" : "uid",
         *         "idAttribute" : "entryUUID"
         *     },
         * 
         *
         *     // The attribute which will be used for performing MVCC.
         *     "etagAttribute" : "etag",
         * 
         *
         *     // The JSON to LDAP attribute mappings.
         *     "attributes" : {
         *         "schemas"     : { "constant" : [ "urn:scim:schemas:core:1.0" ] },
@@ -184,7 +184,7 @@
         *         },
         *         "manager"     : { "reference" : {
         *             "ldapAttribute" : "manager",
         *             "mapping"       : { "object" : {
         *             "mapper"        : { "object" : {
         *                 "id"          : { "simple"   : { "ldapAttribute" : "uid", "isSingleValued" : true } },
         *                 "displayName" : { "simple"   : { "ldapAttribute" : "cn", "isSingleValued" : true } }
         *             } }
@@ -193,7 +193,7 @@
         *     }
         * }
         * </pre>
         * 
         *
         * @param configuration
         *            The JSON configuration.
         * @return A reference to this builder.
@@ -255,7 +255,7 @@
        /**
         * Sets the policy which should be used in order to read an entry before
         * it is deleted, or after it is added or modified.
         * 
         *
         * @param policy
         *            The policy which should be used in order to read an entry
         *            before it is deleted, or after it is added or modified.
@@ -269,7 +269,7 @@
        /**
         * Sets the schema which should be used when attribute types and
         * controls.
         * 
         *
         * @param schema
         *            The schema which should be used when attribute types and
         *            controls.
@@ -534,7 +534,7 @@
    /**
     * Creates a new connection factory using the provided JSON configuration.
     * The configuration should look like this, excluding the C-like comments:
     * 
     *
     * <pre>
     * {
     *     // The primary data center, must contain at least one LDAP server.
@@ -548,7 +548,7 @@
     *             "port"     : 389
     *         },
     *     ],
     * 
     *
     *     // The optional secondary (fail-over) data center.
     *     "secondaryLDAPServers" : [
     *         {
@@ -560,18 +560,18 @@
     *             "port"     : 389
     *         },
     *     ],
     * 
     *
     *     // Connection pool configuration.
     *     "connectionPoolSize"       : 10,
     *     "heartBeatIntervalSeconds" : 30,
     * 
     *
     *     // SSL/TLS configuration (optional and TBD).
     *     "useSSL" : {
     *         // Elect to use StartTLS instead of SSL.
     *         "useStartTLS" : true,
     *         ...
     *     },
     * 
     *
     *     // Authentication configuration (optional and TBD).
     *     "authentication" : {
     *         "bindDN"   : "cn=directory manager",
@@ -579,7 +579,7 @@
     *     },
     * }
     * </pre>
     * 
     *
     * @param configuration
     *            The JSON configuration.
     * @return A new connection factory using the provided JSON configuration.