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