001/* 002 * Copyright 2008-2022 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2008-2022 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-2022 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.unboundidds.controls; 037 038 039 040import com.unboundid.ldap.sdk.Control; 041import com.unboundid.ldap.sdk.LDAPException; 042import com.unboundid.ldap.sdk.ResultCode; 043import com.unboundid.util.NotMutable; 044import com.unboundid.util.NotNull; 045import com.unboundid.util.ThreadSafety; 046import com.unboundid.util.ThreadSafetyLevel; 047 048import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*; 049 050 051 052/** 053 * This class provides an implementation of an LDAP control that can be used to 054 * request that the Directory Server ignore the NO-USER-MODIFICATION flag for 055 * attribute types. It may be included in an add request to allow the client to 056 * include attributes which are not normally allowed to be externally specified 057 * (e.g., entryUUID, creatorsName, modifiersName, etc.). This control does not 058 * have a value, and there is no corresponding response control. 059 * <BR> 060 * <BLOCKQUOTE> 061 * <B>NOTE:</B> This class, and other classes within the 062 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 063 * supported for use against Ping Identity, UnboundID, and 064 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 065 * for proprietary functionality or for external specifications that are not 066 * considered stable or mature enough to be guaranteed to work in an 067 * interoperable way with other types of LDAP servers. 068 * </BLOCKQUOTE> 069 * <BR> 070 * <H2>Example</H2> 071 * The following example demonstrates the process for attempting to perform an 072 * add operation including the ignore NO-USER-MODIFICATION control so that an 073 * entry can be added which already includes the creatorsName and 074 * createTimestamp attributes: 075 * <PRE> 076 * AddRequest addRequest = new AddRequest("dc=example,dc=com", 077 * new Attribute("objectClass", "top", "domain"), 078 * new Attribute("dc", "example"), 079 * new Attribute("creatorsName", "cn=Admin User DN"), 080 * new Attribute("createTimestamp", "20080101000000Z")); 081 * addRequest.addControl(new IgnoreNoUserModificationRequestControl()); 082 * 083 * try 084 * { 085 * LDAPResult result = connection.add(addRequest); 086 * // The entry was added successfully. 087 * } 088 * catch (LDAPException le) 089 * { 090 * // The attempt to add the entry failed. 091 * } 092 * </PRE> 093 */ 094@NotMutable() 095@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 096public final class IgnoreNoUserModificationRequestControl 097 extends Control 098{ 099 /** 100 * The OID (1.3.6.1.4.1.30221.2.5.5) for the ignore NO-USER-MODIFICATION 101 * request control. 102 */ 103 @NotNull public static final String IGNORE_NO_USER_MODIFICATION_REQUEST_OID = 104 "1.3.6.1.4.1.30221.2.5.5"; 105 106 107 108 /** 109 * The serial version UID for this serializable class. 110 */ 111 private static final long serialVersionUID = 2622432059171073555L; 112 113 114 115 /** 116 * Creates a new ignore NO-USER-MODIFICATION request control. It will be 117 * marked critical. 118 */ 119 public IgnoreNoUserModificationRequestControl() 120 { 121 this(true); 122 } 123 124 125 126 /** 127 * Creates a new ignore NO-USER-MODIFICATION request control with the given 128 * criticality. 129 * 130 * @param isCritical Indicates whether the control should be considered 131 * critical. 132 */ 133 public IgnoreNoUserModificationRequestControl(final boolean isCritical) 134 { 135 super(IGNORE_NO_USER_MODIFICATION_REQUEST_OID, isCritical, null); 136 } 137 138 139 140 /** 141 * Creates a new ignore NO-USER-MODIFICATION request control which is decoded 142 * from the provided generic control. 143 * 144 * @param control The generic control to be decoded as an ignore 145 * NO-USER-MODIFICATION request control. 146 * 147 * @throws LDAPException If the provided control cannot be decoded as an 148 * ignore NO-USER-MODIFICATION request control. 149 */ 150 public IgnoreNoUserModificationRequestControl(@NotNull final Control control) 151 throws LDAPException 152 { 153 super(control); 154 155 if (control.hasValue()) 156 { 157 throw new LDAPException(ResultCode.DECODING_ERROR, 158 ERR_IGNORENUM_REQUEST_HAS_VALUE.get()); 159 } 160 } 161 162 163 164 /** 165 * {@inheritDoc} 166 */ 167 @Override() 168 @NotNull() 169 public String getControlName() 170 { 171 return INFO_CONTROL_NAME_IGNORE_NO_USER_MODIFICATION_REQUEST.get(); 172 } 173 174 175 176 /** 177 * {@inheritDoc} 178 */ 179 @Override() 180 public void toString(@NotNull final StringBuilder buffer) 181 { 182 buffer.append("IgnoreNoUserModificationRequestControl(isCritical="); 183 buffer.append(isCritical()); 184 buffer.append(')'); 185 } 186}