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 2013-2015 ForgeRock AS
026 */
027package org.opends.server.replication.plugin;
028
029import org.opends.server.replication.common.CSN;
030import org.opends.server.replication.protocol.ReplicationMsg;
031
032/**
033 * This class if used to build fake Operation from the historical
034 * information that stay in the entry in the database.
035 *
036 * This is useful when a LDAP server can't find a LDAP server that
037 * has already seen all its changes and therefore need to retransmit them.
038 */
039public abstract class FakeOperation
040{
041  private CSN csn;
042
043  /**
044   * Creates a new FakeOperation using the provided CSN.
045   *
046   * @param csn The CSN to use to build the FakeOperation.
047   */
048  public FakeOperation(CSN csn)
049  {
050    this.csn = csn;
051  }
052
053  /**
054   * Get the CSN.
055   *
056   * @return Returns the CSN.
057   */
058  public CSN getCSN()
059  {
060    return csn;
061  }
062
063  /**
064   * Generate a ReplicationMsg from this fake operation.
065   * The ReplicationMsg is used to send the informations about
066   * this operation to the other servers.
067   *
068   * @return A ReplicationMsg that can be used to send information
069   *         about this operation to remote servers.
070   */
071  public abstract ReplicationMsg generateMessage();
072}