001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions copyright 2012-2013 ForgeRock AS
026 */
027package org.opends.server.replication.protocol;
028
029import org.opends.server.replication.common.CSN;
030
031/**
032 * This class describe the replication context that is attached to
033 * ModifyDN operation.
034 */
035public class ModifyDnContext extends OperationContext
036{
037  private String newSuperiorEntryUUID;
038
039  /**
040   * Creates a new ModifyDN Context with the provided parameters.
041   *
042   * @param csn The CSN of the operation.
043   * @param entryUUID the unique Id of the modified entry.
044   * @param newSuperiorEntryUUID The unique Identifier of the new parent,
045   *                    can be null if the entry is to stay below the same
046   *                    parent.
047   */
048  public ModifyDnContext(CSN csn, String entryUUID, String newSuperiorEntryUUID)
049  {
050    super(csn, entryUUID);
051    this.newSuperiorEntryUUID = newSuperiorEntryUUID;
052  }
053
054  /**
055   * Get the unique Identifier of the new parent.
056   * Can be null if the entry is to stay below the same parent.
057   *
058   * @return Returns the unique Identifier of the new parent..
059   */
060  public String getNewSuperiorEntryUUID()
061  {
062    return newSuperiorEntryUUID;
063  }
064}