001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.shared.ldap.extras.controls; 021 022 023import org.apache.directory.shared.ldap.model.message.Control; 024 025 026/** 027 * A SyncModifyDnControl object, to send the parameters used in a MODIFYDN operation 028 * that was carried out on a syncrepl provider server. 029 * 030 * The consumer will use the values present in this control to perform the same operation 031 * on its local data, which helps in avoiding huge number of updates to the consumer. 032 * 033 * NOTE: syncrepl, defined in RFC 4533, doesn't mention about this approach, this is a special 034 * extension provided by Apache Directory Server 035 * 036 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 037 */ 038public interface SyncModifyDn extends Control 039{ 040 041 /** This control OID */ 042 public static final String OID = "1.3.6.1.4.1.4203.1.9.1.5"; 043 044 045 String getEntryDn(); 046 047 048 void setEntryDn( String entryDn ); 049 050 051 String getNewSuperiorDn(); 052 053 054 void setNewSuperiorDn( String newSuperiorDn ); 055 056 057 String getNewRdn(); 058 059 060 void setNewRdn( String newRdn ); 061 062 063 boolean isDeleteOldRdn(); 064 065 066 void setDeleteOldRdn( boolean deleteOldRdn ); 067 068 069 SyncModifyDnType getModDnType(); 070 071 072 void setModDnType( SyncModifyDnType modDnType ); 073}