001/*
002 * Copyright 2012-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2012-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) 2012-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 defines a request control that may be included in a search request
054 * to indicate that the server should include replication conflict entries in
055 * the set of search result entries.
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 * This control is not based on any public standard.  It was originally
068 * developed for use with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent
069 * 8661 Directory Server.  It does not have a value.
070 * <BR><BR>
071 * There is no corresponding response control.  Replication conflict entries may
072 * be identified by the object class "ds-sync-conflict-entry".
073 */
074@NotMutable()
075@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
076public final class ReturnConflictEntriesRequestControl
077       extends Control
078{
079  /**
080   * The OID (1.3.6.1.4.1.30221.2.5.13) for the return conflict entries request
081   * control.
082   */
083  @NotNull public static final String RETURN_CONFLICT_ENTRIES_REQUEST_OID =
084       "1.3.6.1.4.1.30221.2.5.13";
085
086
087
088  /**
089   * The serial version UID for this serializable class.
090   */
091  private static final long serialVersionUID = -7688556660280234650L;
092
093
094
095  /**
096   * Creates a new return conflict entries request control.  It will be marked
097   * critical.
098   */
099  public ReturnConflictEntriesRequestControl()
100  {
101    this(true);
102  }
103
104
105
106  /**
107   * Creates a new return conflict entries request control.
108   *
109   * @param  isCritical  Indicates whether this control should be marked
110   *                     critical.
111   */
112  public ReturnConflictEntriesRequestControl(final boolean isCritical)
113  {
114    super(RETURN_CONFLICT_ENTRIES_REQUEST_OID, isCritical, null);
115  }
116
117
118
119  /**
120   * Creates a new return conflict entries request control which is decoded from
121   * the provided generic control.
122   *
123   * @param  control  The generic control to be decoded as a return conflict
124   *                  entries request control.
125   *
126   * @throws  LDAPException  If the provided control cannot be decoded as a
127   *                         return conflict entries request control.
128   */
129  public ReturnConflictEntriesRequestControl(@NotNull final Control control)
130         throws LDAPException
131  {
132    super(control);
133
134    if (control.hasValue())
135    {
136      throw new LDAPException(ResultCode.DECODING_ERROR,
137           ERR_RETURN_CONFLICT_ENTRIES_REQUEST_HAS_VALUE.get());
138    }
139  }
140
141
142
143  /**
144   * {@inheritDoc}
145   */
146  @Override()
147  @NotNull()
148  public String getControlName()
149  {
150    return INFO_CONTROL_NAME_RETURN_CONFLICT_ENTRIES_REQUEST.get();
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  @Override()
159  public void toString(@NotNull final StringBuilder buffer)
160  {
161    buffer.append("ReturnConflictEntriesRequestControl(isCritical=");
162    buffer.append(isCritical());
163    buffer.append(')');
164  }
165}