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