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