Prep work for OPENDJ-1342: align APIs for DNs

Jean-Noël Rouvignac

05.20.2016 f023ac7e42377159729f4855242f96e130ef3c90

Prep work for OPENDJ-1342: align APIs for DNs

DN.getRDN(int) => DN.rdn(int)
server's DN now implements Iterable<RDN>

*Test*.java:
Fixed ambiguity with assertThat() methods and the use of DNs.

 opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/browser/NodeRefresher.java

@@ -799,7 +799,7 @@
              int diff = dn.size() - rdns.length;
              for (int i=0; i < rdns.length; i++)
              {
                rdns[i] = dn.getRDN(i + diff);
                rdns[i] = dn.rdn(i + diff);
              }
              final DN parentToAddDN = new DN(rdns);
              boolean mustAddParent = true;

 opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/AciList.java

@@ -417,10 +417,10 @@
          int keepRDNCount=keyRDNCount - oldRDNCount;
          RDN[] newRDNs = new RDN[keepRDNCount + newRDNCount];
          for (int i=0; i < keepRDNCount; i++) {
            newRDNs[i] = hashEntry.getKey().getRDN(i);
            newRDNs[i] = hashEntry.getKey().rdn(i);
          }
          for (int i=keepRDNCount, j=0; j < newRDNCount; i++,j++) {
            newRDNs[i] = newDN.getRDN(j);
            newRDNs[i] = newDN.rdn(j);
          }
          DN relocateDN=new DN(newRDNs);
          List<Aci> acis = new LinkedList<>();

 opendj-server-legacy/src/main/java/org/opends/server/authorization/dseecompat/PatternDN.java

@@ -12,7 +12,7 @@
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2008 Sun Microsystems, Inc.
 * Portions Copyright 2014-2015 ForgeRock AS.
 * Portions Copyright 2014-2016 ForgeRock AS.
 */
package org.opends.server.authorization.dseecompat;

@@ -132,7 +132,7 @@

      for (int i = 0; i < dn.size(); i++)
      {
        if (!equality[i].matchesRDN(dn.getRDN(i)))
        if (!equality[i].matchesRDN(dn.rdn(i)))
        {
          return false;
        }
@@ -156,7 +156,7 @@

        for (; pos < initialLength; pos++)
        {
          if (!subInitial[pos].matchesRDN(dn.getRDN(pos)))
          if (!subInitial[pos].matchesRDN(dn.rdn(pos)))
          {
            return false;
          }
@@ -182,7 +182,7 @@
          boolean match = false;
          for (; pos < end; pos++)
          {
            if (element[0].matchesRDN(dn.getRDN(pos)))
            if (element[0].matchesRDN(dn.rdn(pos)))
            {
              if (subMatch(dn, pos, element, anyLength))
              {
@@ -216,7 +216,7 @@
        pos = valueLength - finalLength;
        for (int i=0; i < finalLength; i++,pos++)
        {
          if (!subFinal[i].matchesRDN(dn.getRDN(pos)))
          if (!subFinal[i].matchesRDN(dn.rdn(pos)))
          {
            return false;
          }
@@ -231,7 +231,7 @@
  {
    for (int i = 1; i < length; i++)
    {
      if (!element[i].matchesRDN(dn.getRDN(pos + i)))
      if (!element[i].matchesRDN(dn.rdn(pos + i)))
      {
        return false;
      }

 opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/DnKeyFormat.java

@@ -71,7 +71,7 @@
    for (int i = startSize; i >= 0; i--)
    {
        builder.appendByte(DN.NORMALIZED_RDN_SEPARATOR);
        dn.getRDN(i).toNormalizedByteString(builder);
        dn.rdn(i).toNormalizedByteString(builder);
    }
    return builder.toByteString();
  }

 opendj-server-legacy/src/main/java/org/opends/server/backends/pluggable/EntryContainer.java

@@ -2162,12 +2162,12 @@
    RDN[] newDNComponents = new RDN[oldDNKeepComponents+newSuffixDNComponents];
    for (int i=0; i < oldDNKeepComponents; i++)
    {
      newDNComponents[i] = oldDN.getRDN(i);
      newDNComponents[i] = oldDN.rdn(i);
    }

    for (int i=oldDNKeepComponents, j=0; j < newSuffixDNComponents; i++,j++)
    {
      newDNComponents[i] = newSuffixDN.getRDN(j);
      newDNComponents[i] = newSuffixDN.rdn(j);
    }

    return new DN(newDNComponents);

 opendj-server-legacy/src/main/java/org/opends/server/extensions/SubjectAttributeToUserAttributeCertificateMapper.java

@@ -56,6 +56,7 @@
import org.opends.server.types.Entry;
import org.opends.server.types.IndexType;
import org.opends.server.types.InitializationException;
import org.opends.server.types.RDN;
import org.opends.server.types.SearchFilter;
import org.opends.server.types.SearchResultEntry;

@@ -196,9 +197,9 @@
    }

    LinkedList<SearchFilter> filterComps = new LinkedList<>();
    for (int i=0; i < peerDN.size(); i++)
    for (RDN rdn : peerDN)
    {
      for (AVA ava : peerDN.getRDN(i))
      for (AVA ava : rdn)
      {
        String lowerName = toLowerCase(ava.getAttributeName());


 opendj-server-legacy/src/main/java/org/opends/server/tools/makeldif/DNTag.java

@@ -115,11 +115,11 @@
    {
      int count = Math.min(numComponents, dn.size());

      templateValue.getValue().append(dn.getRDN(0));
      templateValue.getValue().append(dn.rdn(0));
      for (int i = 1; i < count; i++)
      {
        templateValue.append(",");
        templateValue.getValue().append(dn.getRDN(i));
        templateValue.getValue().append(dn.rdn(i));
      }
    }
    else
@@ -127,11 +127,11 @@
      int sz = dn.size();
      int count = Math.min(Math.abs(numComponents), sz);

      templateValue.getValue().append(dn.getRDN(sz - count));
      templateValue.getValue().append(dn.rdn(sz - count));
      for (int i = 1; i < count; i++)
      {
        templateValue.append(",");
        templateValue.getValue().append(dn.getRDN(sz - count + i));
        templateValue.getValue().append(dn.rdn(sz - count + i));
      }
    }


 opendj-server-legacy/src/main/java/org/opends/server/tools/makeldif/UnderscoreDNTag.java

@@ -109,22 +109,22 @@

    if (numComponents == 0)
    {
      templateValue.getValue().append(dn.getRDN(0));
      templateValue.getValue().append(dn.rdn(0));
      for (int i=1; i < dn.size(); i++)
      {
        templateValue.append("_");
        templateValue.getValue().append(dn.getRDN(i));
        templateValue.getValue().append(dn.rdn(i));
      }
    }
    else if (numComponents > 0)
    {
      int count = Math.min(numComponents, dn.size());

      templateValue.getValue().append(dn.getRDN(0));
      templateValue.getValue().append(dn.rdn(0));
      for (int i = 1; i < count; i++)
      {
        templateValue.append("_");
        templateValue.getValue().append(dn.getRDN(i));
        templateValue.getValue().append(dn.rdn(i));
      }
    }
    else
@@ -132,10 +132,10 @@
      int sz = dn.size();
      int count = Math.min(Math.abs(numComponents), sz);

      templateValue.getValue().append(dn.getRDN(sz - count));
      templateValue.getValue().append(dn.rdn(sz - count));
      for (int i = 1; i < count; i++) {
        templateValue.append("_");
        templateValue.getValue().append(dn.getRDN(sz - count + i));
        templateValue.getValue().append(dn.rdn(sz - count + i));
      }
    }


 opendj-server-legacy/src/main/java/org/opends/server/tools/makeldif/UnderscoreParentDNTag.java

@@ -73,11 +73,11 @@
      return TagResult.SUCCESS_RESULT;
    }

    templateValue.getValue().append(parentDN.getRDN(0));
    templateValue.getValue().append(parentDN.rdn(0));
    for (int i=1; i < parentDN.size(); i++)
    {
      templateValue.append("_");
      templateValue.getValue().append(parentDN.getRDN(i));
      templateValue.getValue().append(parentDN.rdn(i));
    }

    return TagResult.SUCCESS_RESULT;

 opendj-server-legacy/src/main/java/org/opends/server/types/DN.java

@@ -23,6 +23,8 @@
import static org.opends.server.util.StaticUtils.*;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;

@@ -48,7 +50,7 @@
     mayInstantiate=true,
     mayExtend=false,
     mayInvoke=true)
public final class DN implements Comparable<DN>, Serializable
public final class DN implements Comparable<DN>, Iterable<RDN>, Serializable
{
  private static final LocalizedLogger logger = LocalizedLogger.getLoggerForThisClass();
  /** A singleton instance of the root/null DN (a DN with no components). */
@@ -282,7 +284,7 @@
   * @return  The RDN component at the specified position in the set
   *          of components for this DN.
   */
  public RDN getRDN(int pos)
  public RDN rdn(int pos)
  {
    return rdnComponents[pos];
  }
@@ -2539,5 +2541,9 @@
    return toNormalizedByteString().compareTo(other.toNormalizedByteString());
  }

  @Override
  public Iterator<RDN> iterator()
  {
    return Arrays.asList(rdnComponents).iterator();
  }
}


 opendj-server-legacy/src/main/java/org/opends/server/types/SearchFilter.java

@@ -3420,11 +3420,9 @@
    // attributes, then do so.
    if (dnAttributes)
    {
      DN entryDN = entry.getName();
      int count = entryDN.size();
      for (int rdnIndex = 0; rdnIndex < count; rdnIndex++)
      for (RDN rdn : entry.getName())
      {
        for (AVA ava : entryDN.getRDN(rdnIndex))
        for (AVA ava : rdn)
        {
          try
          {

 opendj-server-legacy/src/test/java/org/opends/server/admin/client/ldap/MockLDAPConnection.java

@@ -12,7 +12,7 @@
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2007-2008 Sun Microsystems, Inc.
 * Portions Copyright 2014-2015 ForgeRock AS.
 * Portions Copyright 2014-2016 ForgeRock AS.
 */
package org.opends.server.admin.client.ldap;

@@ -279,7 +279,7 @@

    // Create required glue entries.
    for (int i = 0; i < entryDN.size() - 1; i++) {
      RDN rdn = entryDN.getRDN(entryDN.size() - i - 1);
      RDN rdn = entryDN.rdn(entryDN.size() - i - 1);
      DN dn = parent.getDN().child(rdn);

      if (!entries.containsKey(dn)) {

 opendj-server-legacy/src/test/java/org/opends/server/backends/ChangelogBackendTestCase.java

@@ -1430,14 +1430,14 @@
  {
    DN actualDN = resultEntry.getName();
    DN expectedDN = DN.valueOf("changenumber=" + changeNumber + ",cn=changelog");
    assertThat(actualDN).isEqualTo(expectedDN);
    assertThat((Object) actualDN).isEqualTo(expectedDN);
  }

  private void assertDNWithCSN(SearchResultEntry resultEntry, CSN csn) throws Exception
  {
    DN actualDN = resultEntry.getName();
    DN expectedDN = DN.valueOf("replicationcsn=" + csn + "," + DN_OTEST + ",cn=changelog");
    assertThat(actualDN).isEqualTo(expectedDN);
    assertThat((Object) actualDN).isEqualTo(expectedDN);
  }

  /**

 opendj-server-legacy/src/test/java/org/opends/server/backends/pluggable/PluggableBackendImplTestCase.java

@@ -684,7 +684,7 @@
    backend.search(createSearchOperation(
        newEntry.getName().parent(), SearchScope.WHOLE_SUBTREE, "(&(sn=Smith)(jpegphoto=foo))", returnedEntries));
    assertThat(returnedEntries).hasSize(1);
    assertThat(returnedEntries.get(0).getName()).isEqualTo(newEntry.getName());
    assertThat((Object) returnedEntries.get(0).getName()).isEqualTo(newEntry.getName());
  }

  private SearchOperation createSearchOperation(DN baseDN, SearchScope scope, String searchFilter,

 opendj-server-legacy/src/test/java/org/opends/server/replication/server/changelog/file/ChangeNumberIndexerTest.java

@@ -11,7 +11,7 @@
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2013-2015 ForgeRock AS.
 * Copyright 2013-2016 ForgeRock AS.
 * Portions Copyright 2014 ForgeRock AS.
 */
package org.opends.server.replication.server.changelog.file;
@@ -700,7 +700,7 @@
      final ChangeNumberIndexRecord record = allValues.get(i);
      // check content in order
      String desc2 = "actual was:<" + record + ">, but expected was:<" + expectedMsg + ">";
      assertThat(record.getBaseDN()).as(desc2).isEqualTo(expectedMsg.getBaseDN());
      assertThat((Object) record.getBaseDN()).as(desc2).isEqualTo(expectedMsg.getBaseDN());
      assertThat(record.getCSN()).as(desc2).isEqualTo(expectedMsg.getCSN());
    }
  }

 opendj-server-legacy/src/test/java/org/opends/server/replication/server/changelog/file/ECLMultiDomainDBCursorTest.java

@@ -11,7 +11,7 @@
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2014-2015 ForgeRock AS.
 * Copyright 2014-2016 ForgeRock AS.
 */
package org.opends.server.replication.server.changelog.file;

@@ -171,24 +171,24 @@
  private void assertMessagesInOrder(DN baseDN, UpdateMsg msg1, UpdateMsg msg2) throws Exception
  {
    assertThat(eclCursor.getRecord()).isNull();
    assertThat(eclCursor.getData()).isNull();
    assertThat((Object) eclCursor.getData()).isNull();

    if (msg1 != null)
    {
      assertThat(eclCursor.next()).isTrue();
      assertThat(eclCursor.getRecord()).isEqualTo(msg1);
      assertThat(eclCursor.getData()).isEqualTo(baseDN);
      assertThat((Object) eclCursor.getData()).isEqualTo(baseDN);
    }
    if (msg2 != null)
    {
      assertThat(eclCursor.next()).isTrue();
      assertThat(eclCursor.getRecord()).isEqualTo(msg2);
      assertThat(eclCursor.getData()).isEqualTo(baseDN);
      assertThat((Object) eclCursor.getData()).isEqualTo(baseDN);
    }

    assertThat(eclCursor.next()).isFalse();
    assertThat(eclCursor.getRecord()).isNull();
    assertThat(eclCursor.getData()).isNull();
    assertThat((Object) eclCursor.getData()).isNull();
  }

  private void addDomainCursorToCursor(DN baseDN, SequentialDBCursor cursor) throws ChangelogException

 opendj-server-legacy/src/test/java/org/opends/server/replication/server/changelog/file/FileChangeNumberIndexDBTest.java

@@ -60,7 +60,7 @@

    assertThat(record).isNotNull();
    assertThat(record.getKey()).isEqualTo(msg.getChangeNumber());
    assertThat(record.getValue().getBaseDN()).isEqualTo(msg.getBaseDN());
    assertThat((Object) record.getValue().getBaseDN()).isEqualTo(msg.getBaseDN());
    assertThat(record.getValue().getCSN()).isEqualTo(msg.getCSN());
  }


 opendj-server-legacy/src/test/java/org/opends/server/schema/LDAPSyntaxTest.java

@@ -470,7 +470,7 @@
      assertEquals(searchOperation.getResultCode(), ResultCode.SUCCESS);
      List<SearchResultEntry> entries = searchOperation.getSearchEntries();
      assertThat(entries).as("expected one entry to be returned").isNotEmpty();
      assertThat(entries.get(0).getName()).isEqualTo(DN.valueOf("cn=test1,o=test"));
      assertThat((Object) entries.get(0).getName()).isEqualTo(DN.valueOf("cn=test1,o=test"));
    }
    finally
    {

 opendj-server-legacy/src/test/java/org/opends/server/types/TestDN.java

@@ -16,8 +16,6 @@
 */
package org.opends.server.types;

import org.forgerock.opendj.ldap.schema.AttributeType;

import static org.assertj.core.api.Assertions.*;
import static org.opends.server.TestCaseUtils.*;
import static org.opends.server.core.DirectoryServer.*;
@@ -27,6 +25,7 @@

import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.ldap.ByteStringBuilder;
import org.forgerock.opendj.ldap.schema.AttributeType;
import org.opends.server.TestCaseUtils;
import org.opends.server.core.DirectoryServer;
import org.testng.Assert;
@@ -590,9 +589,9 @@

    assertEquals(p.rdn(), RDN.valueOf("dc=bar"));

    assertEquals(p.getRDN(0), RDN.valueOf("dc=bar"));
    assertEquals(p.getRDN(1), RDN.valueOf("dc=opends"));
    assertEquals(p.getRDN(2), RDN.valueOf("dc=org"));
    assertEquals(p.rdn(0), RDN.valueOf("dc=bar"));
    assertEquals(p.rdn(1), RDN.valueOf("dc=opends"));
    assertEquals(p.rdn(2), RDN.valueOf("dc=org"));

    assertEquals(p.parent(), DN.valueOf("dc=opends,dc=org"));
    assertEquals(p.parent(), e.parent());
@@ -665,7 +664,7 @@
    DN dn = DN.valueOf(s);
    RDN rdn = RDN.valueOf(r);

    assertEquals(dn.getRDN(i), rdn, "For DN " + s);
    assertEquals(dn.rdn(i), rdn, "For DN " + s);
  }


@@ -702,7 +701,7 @@
    DN dn = DN.valueOf(s);

    // Shoudld throw.
    dn.getRDN(i);
    dn.rdn(i);

    Assert.fail("Excepted exception for RDN index " + i + " in DN " + s);
  }
@@ -804,10 +803,10 @@

    assertEquals(c.rdn(), RDN.valueOf("dc=foo"));

    assertEquals(c.getRDN(0), RDN.valueOf("dc=foo"));
    assertEquals(c.getRDN(1), RDN.valueOf("dc=bar"));
    assertEquals(c.getRDN(2), RDN.valueOf("dc=opends"));
    assertEquals(c.getRDN(3), RDN.valueOf("dc=org"));
    assertEquals(c.rdn(0), RDN.valueOf("dc=foo"));
    assertEquals(c.rdn(1), RDN.valueOf("dc=bar"));
    assertEquals(c.rdn(2), RDN.valueOf("dc=opends"));
    assertEquals(c.rdn(3), RDN.valueOf("dc=org"));

    assertEquals(c.parent(), DN.valueOf("dc=bar,dc=opends,dc=org"));
    assertEquals(c.parent(), e.parent());
@@ -1209,8 +1208,7 @@
  {
    DN dn = DN.valueOf(dnString);
    DN renamed = dn.rename(DN.valueOf(fromDN), DN.valueOf(toDN));

    assertThat(renamed).isEqualTo(DN.valueOf(expectedDN));
    assertThat((Object) renamed).isEqualTo(DN.valueOf(expectedDN));
  }
}