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