001/* 002 * Copyright 2013-2022 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2013-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) 2013-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 a request control which may be included in a delete or 054 * modify DN request to indicate that the server should skip any referential 055 * integrity processing that would have otherwise been done for that operation. 056 * <BR> 057 * <BLOCKQUOTE> 058 * <B>NOTE:</B> This class, and other classes within the 059 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 060 * supported for use against Ping Identity, UnboundID, and 061 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 062 * for proprietary functionality or for external specifications that are not 063 * considered stable or mature enough to be guaranteed to work in an 064 * interoperable way with other types of LDAP servers. 065 * </BLOCKQUOTE> 066 * <BR> 067 * The request control has an OID of "1.3.6.1.4.1.30221.2.5.30" and does not 068 * have a value. The criticality for this control may be either {@code TRUE} 069 * or {@code FALSE}, which may impact whether a server will process the 070 * associated modify DN or delete operation if the server does not support the 071 * use of this control. If a server receives a critical control that it does 072 * not support for the associated operation, then it will return a failure 073 * result without attempting to process that operation. If a server receives 074 * a non-critical control that it does not support for the associated operation, 075 * then it will process the operation as if that control had not been provided. 076 */ 077@NotMutable() 078@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 079public final class SuppressReferentialIntegrityUpdatesRequestControl 080 extends Control 081{ 082 /** 083 * The OID (1.3.6.1.4.1.30221.2.5.30) for the suppress referential integrity 084 * updates request control. 085 */ 086 @NotNull public static final String SUPPRESS_REFINT_REQUEST_OID = 087 "1.3.6.1.4.1.30221.2.5.30"; 088 089 090 091 /** 092 * The serial version UID for this serializable class. 093 */ 094 private static final long serialVersionUID = 4761880447993567116L; 095 096 097 098 /** 099 * Creates a new suppress referential integrity updates request control. It 100 * will be critical. 101 */ 102 public SuppressReferentialIntegrityUpdatesRequestControl() 103 { 104 this(true); 105 } 106 107 108 109 /** 110 * Creates a new suppress referential integrity updates request control. 111 * 112 * @param isCritical Indicates whether the control should be marked 113 * critical. 114 */ 115 public SuppressReferentialIntegrityUpdatesRequestControl( 116 final boolean isCritical) 117 { 118 super(SUPPRESS_REFINT_REQUEST_OID, isCritical, null); 119 } 120 121 122 123 /** 124 * Creates a new suppress referential integrity updates request control which 125 * is decoded from the provided generic control. 126 * 127 * @param control The generic control to be decoded as a suppress 128 * referential integrity updates request control. 129 * 130 * @throws LDAPException If the provided control cannot be decoded as a 131 * suppress referential integrity updates request 132 * control. 133 */ 134 public SuppressReferentialIntegrityUpdatesRequestControl( 135 @NotNull final Control control) 136 throws LDAPException 137 { 138 super(control); 139 140 if (control.hasValue()) 141 { 142 throw new LDAPException(ResultCode.DECODING_ERROR, 143 ERR_SUPPRESS_REFINT_REQUEST_CONTROL_HAS_VALUE.get()); 144 } 145 } 146 147 148 149 /** 150 * {@inheritDoc} 151 */ 152 @Override() 153 @NotNull() 154 public String getControlName() 155 { 156 return INFO_CONTROL_NAME_SUPPRESS_REFINT_REQUEST.get(); 157 } 158 159 160 161 /** 162 * {@inheritDoc} 163 */ 164 @Override() 165 public void toString(@NotNull final StringBuilder buffer) 166 { 167 buffer.append("SuppressReferentialIntegrityUpdatesRequestControl(" + 168 "isCritical="); 169 buffer.append(isCritical()); 170 buffer.append(')'); 171 } 172}