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 java.util.List;
041
042import com.unboundid.ldif.LDIFModifyChangeRecord;
043import com.unboundid.util.NotExtensible;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This interface defines a set of methods that may be safely called in an LDAP
053 * modify request without altering its contents.  This interface must not be
054 * implemented by any class other than {@link ModifyRequest}.
055 * <BR><BR>
056 * This interface does not inherently provide the assurance of thread safety for
057 * the methods that it exposes, because it is still possible for a thread
058 * referencing the object which implements this interface to alter the request
059 * using methods not included in this interface.  However, if it can be
060 * guaranteed that no thread will alter the underlying object, then the methods
061 * exposed by this interface can be safely invoked concurrently by any number of
062 * threads.
063 */
064@NotExtensible()
065@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
066public interface ReadOnlyModifyRequest
067       extends ReadOnlyLDAPRequest
068{
069  /**
070   * Retrieves the DN of the entry to modify.
071   *
072   * @return  The DN of the entry to modify.
073   */
074  @NotNull()
075  String getDN();
076
077
078
079  /**
080   * Retrieves the set of modifications for this modify request.  The returned
081   * list must not be altered.
082   *
083   * @return  The set of modifications for this modify request.
084   */
085  @NotNull()
086  List<Modification> getModifications();
087
088
089
090  /**
091   * {@inheritDoc}
092   */
093  @Override()
094  @NotNull()
095  ModifyRequest duplicate();
096
097
098
099  /**
100   * {@inheritDoc}
101   */
102  @Override()
103  @NotNull()
104  ModifyRequest duplicate(@Nullable Control[] controls);
105
106
107
108  /**
109   * Retrieves an LDIF modify change record with the contents of this modify
110   * request.
111   *
112   * @return  An LDIF modify change record with the contents of this modify
113   *          request.
114   */
115  @NotNull()
116  LDIFModifyChangeRecord toLDIFChangeRecord();
117
118
119
120  /**
121   * Retrieves a string array whose lines contain an LDIF representation of the
122   * corresponding modify change record.
123   *
124   * @return  A string array whose lines contain an LDIF representation of the
125   *          corresponding modify change record.
126   */
127  @NotNull()
128  String[] toLDIF();
129
130
131
132  /**
133   * Retrieves an LDIF string representation of this modify request.
134   *
135   * @return  An LDIF string representation of this modify request.
136   */
137  @NotNull()
138  String toLDIFString();
139}