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