001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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 a control which may be used to
054 * process an add, delete, modify, or modify DN operation in the Directory
055 * Server which will not be replicated to other servers.  This control is
056 * primarily intended for use in manually resolving replication conflicts.
057 * <BR>
058 * <BLOCKQUOTE>
059 *   <B>NOTE:</B>  This class, and other classes within the
060 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
061 *   supported for use against Ping Identity, UnboundID, and
062 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
063 *   for proprietary functionality or for external specifications that are not
064 *   considered stable or mature enough to be guaranteed to work in an
065 *   interoperable way with other types of LDAP servers.
066 * </BLOCKQUOTE>
067 * <BR>
068 * This request control has an OID of 1.3.6.1.4.1.30221.1.5.2 and a criticality
069 * of true.  It does not have a value.
070 * <BR><BR>
071 * <H2>Example</H2>
072 * The following example demonstrates the use of the replication repair request
073 * control:
074 * <PRE>
075 * ModifyRequest modifyRequest = new ModifyRequest("dc=example,dc=com",
076 *      new Modification(ModificationType.REPLACE, "attrName", "attrValue"));
077 * modifyRequest.addControl(new ReplicationRepairRequestControl());
078 * LDAPResult modifyResult = connection.modify(modifyRequest);
079 * </PRE>
080 */
081@NotMutable()
082@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
083public final class ReplicationRepairRequestControl
084       extends Control
085{
086  /**
087   * The OID (1.3.6.1.4.1.30221.1.5.2) for the replication repair request
088   * control.
089   */
090  @NotNull public static final String REPLICATION_REPAIR_REQUEST_OID =
091       "1.3.6.1.4.1.30221.1.5.2";
092
093
094
095  /**
096   * The serial version UID for this serializable class.
097   */
098  private static final long serialVersionUID = 8036161025439278805L;
099
100
101
102  /**
103   * Creates a new replication repair request control.  It will be marked
104   * critical.
105   */
106  public ReplicationRepairRequestControl()
107  {
108    super(REPLICATION_REPAIR_REQUEST_OID, true, null);
109  }
110
111
112
113  /**
114   * Creates a new replication repair request control which is decoded from
115   * the provided generic control.
116   *
117   * @param  control  The generic control to be decoded as a replication repair
118   *                  request control.
119   *
120   * @throws  LDAPException  If the provided control cannot be decoded as a
121   *                         replication repair request control.
122   */
123  public ReplicationRepairRequestControl(@NotNull final Control control)
124         throws LDAPException
125  {
126    super(control);
127
128    if (control.hasValue())
129    {
130      throw new LDAPException(ResultCode.DECODING_ERROR,
131                              ERR_REPLICATION_REPAIR_REQUEST_HAS_VALUE.get());
132    }
133  }
134
135
136
137  /**
138   * {@inheritDoc}
139   */
140  @Override()
141  @NotNull()
142  public String getControlName()
143  {
144    return INFO_CONTROL_NAME_REPLICATION_REPAIR_REQUEST.get();
145  }
146
147
148
149  /**
150   * {@inheritDoc}
151   */
152  @Override()
153  public void toString(@NotNull final StringBuilder buffer)
154  {
155    buffer.append("ReplicationRepairRequestControl()");
156  }
157}