001/*
002 * Copyright 2012-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2012-2023 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2012-2023 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds;
037
038
039
040import com.unboundid.ldap.sdk.DN;
041import com.unboundid.ldap.sdk.ReadOnlyEntry;
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This interface defines an API that may be implemented by classes which wish
052 * to be notified of processing performed in the course of moving a subtree
053 * between servers.
054 * <BR>
055 * <BLOCKQUOTE>
056 *   <B>NOTE:</B>  This class, and other classes within the
057 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
058 *   supported for use against Ping Identity, UnboundID, and
059 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
060 *   for proprietary functionality or for external specifications that are not
061 *   considered stable or mature enough to be guaranteed to work in an
062 *   interoperable way with other types of LDAP servers.
063 * </BLOCKQUOTE>
064 */
065@Extensible()
066@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
067public interface MoveSubtreeListener
068{
069  /**
070   * Performs any processing which may be needed before the provided entry is
071   * added to the target server.
072   *
073   * @param  entry  A read-only representation of the entry to be added to the
074   *                target server.
075   *
076   * @return  The original entry if the add should proceed without changes, a
077   *          new entry (which must have the same DN as the provided entry) if
078   *          the entry should be added with changes, or {@code null} if the
079   *          entry should not be added to the target server (but will still be
080   *          removed from the source server).
081   */
082  @Nullable()
083  ReadOnlyEntry doPreAddProcessing(@NotNull ReadOnlyEntry entry);
084
085
086
087  /**
088   * Performs any processing which may be needed after the provided entry has
089   * been added to the target server.
090   *
091   * @param  entry  A read-only representation of the entry that was added to
092   *                the target server.  Note that depending on the algorithm
093   *                used to perform the move, the entry may not yet be
094   *                accessible in the target server.  Also note that the add may
095   *                potentially be reverted if move processing encounters an
096   *                error later in its processing.
097   */
098  void doPostAddProcessing(@NotNull ReadOnlyEntry entry);
099
100
101
102  /**
103   * Performs any processing which may be needed before the specified entry is
104   * deleted from the source server.
105   *
106   * @param  entryDN  The DN of the entry that is to be removed from the
107   *                  source server.  Note that depending on the algorithm used
108   *                  to perform the move, the entry may already be inaccessible
109   *                  in the source server.
110   */
111  void doPreDeleteProcessing(@NotNull DN entryDN);
112
113
114
115  /**
116   * Performs any processing which may be needed after the specified entry has
117   * been deleted from the source server.
118   *
119   * @param  entryDN  The DN of the entry that has been removed from the source
120   *                  server.  Note that the delete may potentially be reverted
121   *                  if move processing encounters an error later in its
122   *                  processing.
123   */
124  void doPostDeleteProcessing(@NotNull DN entryDN);
125}