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