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 java.util.List; 041 042import com.unboundid.ldif.LDIFModifyChangeRecord; 043import com.unboundid.util.NotExtensible; 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 request without altering its contents. This interface must not be 052 * implemented by any class other than {@link ModifyRequest}. 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 ReadOnlyModifyRequest 065 extends ReadOnlyLDAPRequest 066{ 067 /** 068 * Retrieves the DN of the entry to modify. 069 * 070 * @return The DN of the entry to modify. 071 */ 072 String getDN(); 073 074 075 076 /** 077 * Retrieves the set of modifications for this modify request. The returned 078 * list must not be altered. 079 * 080 * @return The set of modifications for this modify request. 081 */ 082 List<Modification> getModifications(); 083 084 085 086 /** 087 * {@inheritDoc} 088 */ 089 @Override() 090 ModifyRequest duplicate(); 091 092 093 094 /** 095 * {@inheritDoc} 096 */ 097 @Override() 098 ModifyRequest duplicate(Control[] controls); 099 100 101 102 /** 103 * Retrieves an LDIF modify change record with the contents of this modify 104 * request. 105 * 106 * @return An LDIF modify change record with the contents of this modify 107 * request. 108 */ 109 LDIFModifyChangeRecord toLDIFChangeRecord(); 110 111 112 113 /** 114 * Retrieves a string array whose lines contain an LDIF representation of the 115 * corresponding modify change record. 116 * 117 * @return A string array whose lines contain an LDIF representation of the 118 * corresponding modify change record. 119 */ 120 String[] toLDIF(); 121 122 123 124 /** 125 * Retrieves an LDIF string representation of this modify request. 126 * 127 * @return An LDIF string representation of this modify request. 128 */ 129 String toLDIFString(); 130}