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