001/* 002 * Copyright 2012-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2012-2020 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) 2015-2020 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.ThreadSafety; 044import com.unboundid.util.ThreadSafetyLevel; 045 046 047 048/** 049 * This interface defines an API that may be implemented by classes which wish 050 * to be notified of processing performed in the course of moving a subtree 051 * between servers. 052 * <BR> 053 * <BLOCKQUOTE> 054 * <B>NOTE:</B> This class, and other classes within the 055 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 056 * supported for use against Ping Identity, UnboundID, and 057 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 058 * for proprietary functionality or for external specifications that are not 059 * considered stable or mature enough to be guaranteed to work in an 060 * interoperable way with other types of LDAP servers. 061 * </BLOCKQUOTE> 062 */ 063@Extensible() 064@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 065public interface MoveSubtreeListener 066{ 067 /** 068 * Performs any processing which may be needed before the provided entry is 069 * added to the target server. 070 * 071 * @param entry A read-only representation of the entry to be added to the 072 * target server. 073 * 074 * @return The original entry if the add should proceed without changes, a 075 * new entry (which must have the same DN as the provided entry) if 076 * the entry should be added with changes, or {@code null} if the 077 * entry should not be added to the target server (but will still be 078 * removed from the source server). 079 */ 080 ReadOnlyEntry doPreAddProcessing(ReadOnlyEntry entry); 081 082 083 084 /** 085 * Performs any processing which may be needed after the provided entry has 086 * been added to the target server. 087 * 088 * @param entry A read-only representation of the entry that was added to 089 * the target server. Note that depending on the algorithm 090 * used to perform the move, the entry may not yet be 091 * accessible in the target server. Also note that the add may 092 * potentially be reverted if move processing encounters an 093 * error later in its processing. 094 */ 095 void doPostAddProcessing(ReadOnlyEntry entry); 096 097 098 099 /** 100 * Performs any processing which may be needed before the specified entry is 101 * deleted from the source server. 102 * 103 * @param entryDN The DN of the entry that is to be removed from the 104 * source server. Note that depending on the algorithm used 105 * to perform the move, the entry may already be inaccessible 106 * in the source server. 107 */ 108 void doPreDeleteProcessing(DN entryDN); 109 110 111 112 /** 113 * Performs any processing which may be needed after the specified entry has 114 * been deleted from the source server. 115 * 116 * @param entryDN The DN of the entry that has been removed from the source 117 * server. Note that the delete may potentially be reverted 118 * if move processing encounters an error later in its 119 * processing. 120 */ 121 void doPostDeleteProcessing(DN entryDN); 122}