001/* 002 * Copyright 2007-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2007-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) 2008-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; 037 038 039 040import com.unboundid.ldif.LDIFModifyDNChangeRecord; 041import com.unboundid.util.NotExtensible; 042import com.unboundid.util.ThreadSafety; 043import com.unboundid.util.ThreadSafetyLevel; 044 045 046 047/** 048 * This interface defines a set of methods that may be safely called in an LDAP 049 * modify DN request without altering its contents. This interface must not be 050 * implemented by any class other than {@link ModifyDNRequest}. 051 * <BR><BR> 052 * This interface does not inherently provide the assurance of thread safety for 053 * the methods that it exposes, because it is still possible for a thread 054 * referencing the object which implements this interface to alter the request 055 * using methods not included in this interface. However, if it can be 056 * guaranteed that no thread will alter the underlying object, then the methods 057 * exposed by this interface can be safely invoked concurrently by any number of 058 * threads. 059 */ 060@NotExtensible() 061@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 062public interface ReadOnlyModifyDNRequest 063 extends ReadOnlyLDAPRequest 064{ 065 /** 066 * Retrieves the current DN of the entry to move/rename. 067 * 068 * @return The current DN of the entry to move/rename. 069 */ 070 String getDN(); 071 072 073 074 /** 075 * Retrieves the new RDN for the entry. 076 * 077 * @return The new RDN for the entry. 078 */ 079 String getNewRDN(); 080 081 082 083 /** 084 * Indicates whether the current RDN value should be removed from the entry. 085 * 086 * @return {@code true} if the current RDN value should be removed from the 087 * entry, or {@code false} if not. 088 */ 089 boolean deleteOldRDN(); 090 091 092 093 /** 094 * Retrieves the new superior DN for the entry. 095 * 096 * @return The new superior DN for the entry, or {@code null} if the entry is 097 * not to be moved below a new parent. 098 */ 099 String getNewSuperiorDN(); 100 101 102 103 /** 104 * {@inheritDoc} 105 */ 106 @Override() 107 ModifyDNRequest duplicate(); 108 109 110 111 /** 112 * {@inheritDoc} 113 */ 114 @Override() 115 ModifyDNRequest duplicate(Control[] controls); 116 117 118 119 /** 120 * Retrieves an LDIF modify DN change record with the contents of this modify 121 * DN request. 122 * 123 * @return An LDIF modify DN change record with the contents of this modify 124 * DN request. 125 */ 126 LDIFModifyDNChangeRecord toLDIFChangeRecord(); 127 128 129 130 /** 131 * Retrieves a string array whose lines contain an LDIF representation of the 132 * corresponding modify DN change record. 133 * 134 * @return A string array whose lines contain an LDIF representation of the 135 * corresponding modify DN change record. 136 */ 137 String[] toLDIF(); 138 139 140 141 /** 142 * Retrieves an LDIF string representation of this modify DN request. 143 * 144 * @return An LDIF string representation of this modify DN request. 145 */ 146 String toLDIFString(); 147}