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 process the
055 * search even if it cannot use its defined indexes to identify matching entries
056 * efficiently.  This control will only have any effect if the requester has the
057 * unindexed-search-with-control privilege.  If the user does not have that
058 * privilege, then an unindexed search request will either be accepted or
059 * rejected based on whether that user has the unindexed-search privilege (and
060 * it doesn't make any sense for the same user to have both the unindexed-search
061 * and unindexed-search-with-control privileges).
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 * <BR>
073 * This request control has an OID of "1.3.6.1.4.1.30221.2.5.55", may have a
074 * criticality of either true or false, and does not take a value.
075 *
076 * @see  RejectUnindexedSearchRequestControl
077 */
078@NotMutable()
079@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
080public final class PermitUnindexedSearchRequestControl
081       extends Control
082{
083  /**
084   * The OID (1.3.6.1.4.1.30221.2.5.55) for the permit unindexed search request
085   * control.
086   */
087  @NotNull public static final String PERMIT_UNINDEXED_SEARCH_REQUEST_OID =
088       "1.3.6.1.4.1.30221.2.5.55";
089
090
091
092  /**
093   * The serial version UID for this serializable class.
094   */
095  private static final long serialVersionUID = 7192052212547454117L;
096
097
098
099  /**
100   * Creates a new permit unindexed search request control with a criticality of
101   * {@code false}.
102   */
103  public PermitUnindexedSearchRequestControl()
104  {
105    this(false);
106  }
107
108
109
110  /**
111   * Creates a new permit unindexed search request control with the specified
112   * criticality.
113   *
114   * @param  isCritical  Indicates whether the control should be considered
115   *                     critical.
116   */
117  public PermitUnindexedSearchRequestControl(final boolean isCritical)
118  {
119    super(PERMIT_UNINDEXED_SEARCH_REQUEST_OID, isCritical);
120  }
121
122
123
124  /**
125   * Creates a new permit unindexed search request control that is decoded from
126   * the provided generic control.
127   *
128   * @param  control  The generic control to be decoded as a permit unindexed
129   *                  search request control.
130   *
131   * @throws  LDAPException  If the provided control cannot be decoded as a
132   *                         permit unindexed search request control.
133   */
134  public PermitUnindexedSearchRequestControl(@NotNull final Control control)
135         throws LDAPException
136  {
137    super(control);
138
139    if (control.hasValue())
140    {
141      throw new LDAPException(ResultCode.DECODING_ERROR,
142           ERR_PERMIT_UNINDEXED_SEARCH_REQUEST_HAS_VALUE.get());
143    }
144  }
145
146
147
148  /**
149   * {@inheritDoc}
150   */
151  @Override()
152  @NotNull()
153  public String getControlName()
154  {
155    return INFO_CONTROL_NAME_PERMIT_UNINDEXED_SEARCH_REQUEST.get();
156  }
157
158
159
160  /**
161   * {@inheritDoc}
162   */
163  @Override()
164  public void toString(@NotNull final StringBuilder buffer)
165  {
166    buffer.append("PermitUnindexedSearchRequestControl(isCritical=");
167    buffer.append(isCritical());
168    buffer.append(')');
169  }
170}