001/*
002 * Copyright 2008-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-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) 2008-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 the virtual attributes only request
054 * control, which may be included in a search request to indicate that only
055 * virtual attributes should be included in matching entries.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 * <BR>
067 * This control is not based on any public standard, but was first introduced in
068 * the Netscape/iPlanet Directory Server.  It is also supported in the Sun Java
069 * System Directory Server, OpenDS, and the Ping Identity, UnboundID, and
070 * Nokia/Alcatel-Lucent 8661 Directory Server.  It does not have a value.
071 * <BR><BR>
072 * <H2>Example</H2>
073 * The following example demonstrates the use of the virtual attributes only
074 * request control:
075 * <PRE>
076 * SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
077 *      SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe"));
078 *
079 * searchRequest.addControl(new VirtualAttributesOnlyRequestControl());
080 * SearchResult searchResult = connection.search(searchRequest);
081 * </PRE>
082 */
083@NotMutable()
084@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
085public final class VirtualAttributesOnlyRequestControl
086       extends Control
087{
088  /**
089   * The OID (2.16.840.1.113730.3.4.19) for the virtual attributes only request
090   * control.
091   */
092  @NotNull public static final String VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID =
093       "2.16.840.1.113730.3.4.19";
094
095
096
097  /**
098   * The serial version UID for this serializable class.
099   */
100  private static final long serialVersionUID = 1509094615426408618L;
101
102
103
104  /**
105   * Creates a new virtual attributes only request control.  It will not be
106   * marked critical.
107   */
108  public VirtualAttributesOnlyRequestControl()
109  {
110    this(false);
111  }
112
113
114
115  /**
116   * Creates a new virtual attributes only request control with the specified
117   * criticality.
118   *
119   * @param  isCritical  Indicates whether this control should be marked
120   *                     critical.
121   */
122  public VirtualAttributesOnlyRequestControl(final boolean isCritical)
123  {
124    super(VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID, isCritical, null);
125  }
126
127
128
129  /**
130   * Creates a new virtual attributes only request control which is decoded from
131   * the provided generic control.
132   *
133   * @param  control  The generic control to be decoded as a virtual attributes
134   *                  only request control.
135   *
136   * @throws  LDAPException  If the provided control cannot be decoded as a
137   *                         virtual attributes only request control.
138   */
139  public VirtualAttributesOnlyRequestControl(@NotNull final Control control)
140         throws LDAPException
141  {
142    super(control);
143
144    if (control.hasValue())
145    {
146      throw new LDAPException(ResultCode.DECODING_ERROR,
147                              ERR_VIRTUAL_ATTRS_ONLY_REQUEST_HAS_VALUE.get());
148    }
149  }
150
151
152
153  /**
154   * {@inheritDoc}
155   */
156  @Override()
157  @NotNull()
158  public String getControlName()
159  {
160    return INFO_CONTROL_NAME_VIRTUAL_ATTRS_ONLY_REQUEST.get();
161  }
162
163
164
165  /**
166   * {@inheritDoc}
167   */
168  @Override()
169  public void toString(@NotNull final StringBuilder buffer)
170  {
171    buffer.append("VirtualAttributesOnlyRequestControl(isCritical=");
172    buffer.append(isCritical());
173    buffer.append(')');
174  }
175}