001/* 002 * Copyright 2018-2022 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2018-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) 2018-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 request control that may be 054 * included in a search request to indicate that the server should reject the 055 * request if the server cannot use its defined indexes to identify matching 056 * entries efficiently. This can prevent a requester with the unindexed search 057 * privilege from inadvertently submitting an expensive search request that 058 * could require a long time to complete and potentially consume significant 059 * server resources. This request control has an OID of 060 * "1.3.6.1.4.1.30221.2.5.54", may have a criticality of either true or false, 061 * and does not take a value. 062 * <BR> 063 * <BLOCKQUOTE> 064 * <B>NOTE:</B> This class, and other classes within the 065 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 066 * supported for use against Ping Identity, UnboundID, and 067 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 068 * for proprietary functionality or for external specifications that are not 069 * considered stable or mature enough to be guaranteed to work in an 070 * interoperable way with other types of LDAP servers. 071 * </BLOCKQUOTE> 072 * 073 * @see PermitUnindexedSearchRequestControl 074 */ 075@NotMutable() 076@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 077public final class RejectUnindexedSearchRequestControl 078 extends Control 079{ 080 /** 081 * The OID (1.3.6.1.4.1.30221.2.5.54) for the reject unindexed search request 082 * control. 083 */ 084 @NotNull public static final String REJECT_UNINDEXED_SEARCH_REQUEST_OID = 085 "1.3.6.1.4.1.30221.2.5.54"; 086 087 088 089 /** 090 * The serial version UID for this serializable class. 091 */ 092 private static final long serialVersionUID = 6331056590003014623L; 093 094 095 096 /** 097 * Creates a new reject unindexed search request control with a criticality of 098 * {@code true}. 099 */ 100 public RejectUnindexedSearchRequestControl() 101 { 102 this(true); 103 } 104 105 106 107 /** 108 * Creates a new reject unindexed search request control with the specified 109 * criticality. 110 * 111 * @param isCritical Indicates whether the control should be considered 112 * critical. 113 */ 114 public RejectUnindexedSearchRequestControl(final boolean isCritical) 115 { 116 super(REJECT_UNINDEXED_SEARCH_REQUEST_OID, isCritical); 117 } 118 119 120 121 /** 122 * Creates a new reject unindexed search request control that is decoded from 123 * the provided generic control. 124 * 125 * @param control The generic control to be decoded as a reject unindexed 126 * search request control. 127 * 128 * @throws LDAPException If the provided control cannot be decoded as a 129 * reject unindexed search request control. 130 */ 131 public RejectUnindexedSearchRequestControl(@NotNull final Control control) 132 throws LDAPException 133 { 134 super(control); 135 136 if (control.hasValue()) 137 { 138 throw new LDAPException(ResultCode.DECODING_ERROR, 139 ERR_REJECT_UNINDEXED_SEARCH_REQUEST_HAS_VALUE.get()); 140 } 141 } 142 143 144 145 /** 146 * {@inheritDoc} 147 */ 148 @Override() 149 @NotNull() 150 public String getControlName() 151 { 152 return INFO_CONTROL_NAME_REJECT_UNINDEXED_SEARCH_REQUEST.get(); 153 } 154 155 156 157 /** 158 * {@inheritDoc} 159 */ 160 @Override() 161 public void toString(@NotNull final StringBuilder buffer) 162 { 163 buffer.append("RejectUnindexedSearchRequestControl(isCritical="); 164 buffer.append(isCritical()); 165 buffer.append(')'); 166 } 167}