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 2006-2008 Sun Microsystems, Inc.
015 * Portions copyright 2012-2013 ForgeRock AS.
016 */
017package org.opends.server.replication.protocol;
018
019import org.opends.server.replication.common.CSN;
020
021/**
022 * This class describe the replication context that is attached to
023 * ModifyDN operation.
024 */
025public class ModifyDnContext extends OperationContext
026{
027  private String newSuperiorEntryUUID;
028
029  /**
030   * Creates a new ModifyDN Context with the provided parameters.
031   *
032   * @param csn The CSN of the operation.
033   * @param entryUUID the unique Id of the modified entry.
034   * @param newSuperiorEntryUUID The unique Identifier of the new parent,
035   *                    can be null if the entry is to stay below the same
036   *                    parent.
037   */
038  public ModifyDnContext(CSN csn, String entryUUID, String newSuperiorEntryUUID)
039  {
040    super(csn, entryUUID);
041    this.newSuperiorEntryUUID = newSuperiorEntryUUID;
042  }
043
044  /**
045   * Get the unique Identifier of the new parent.
046   * Can be null if the entry is to stay below the same parent.
047   *
048   * @return Returns the unique Identifier of the new parent..
049   */
050  public String getNewSuperiorEntryUUID()
051  {
052    return newSuperiorEntryUUID;
053  }
054}