001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2010 Sun Microsystems, Inc.
015 * Portions Copyright 2012-2016 ForgeRock AS.
016 */
017package org.opends.server.replication.plugin;
018
019import org.opends.server.replication.common.CSN;
020import org.opends.server.replication.protocol.ModifyDNMsg;
021import org.opends.server.replication.protocol.ReplicationMsg;
022import org.forgerock.opendj.ldap.DN;
023import org.opends.server.types.Entry;
024
025/**
026 * This class if used to build fake MODDN Operation from the historical
027 * information that stay in the entry in the database.
028 *
029 * This is useful when a LDAP server can't find a LDAP server that
030 * has already seen all its changes and therefore need to retransmit them.
031 */
032public class FakeModdnOperation extends FakeOperation
033{
034  private Entry entry;
035
036  /**
037   * Creates a new FakeModdnOperation.
038   *
039   * @param csn     The CSN when the entry was last renamed.
040   * @param entry   The entry that the MODDN operation will rename.
041   */
042  public FakeModdnOperation(CSN csn, Entry entry)
043  {
044    super(csn);
045    this.entry = entry;
046  }
047
048  /** {@inheritDoc} */
049  @Override
050  public ReplicationMsg generateMessage()
051  {
052    DN dn = entry.getName();
053    return new ModifyDNMsg(dn, getCSN(),
054        EntryHistorical.getEntryUUID(entry),
055        LDAPReplicationDomain.findEntryUUID(dn.parent()),
056        false, dn.parent().toString(), dn.rdn().toString());
057  }
058}