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