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 a request control which may be used to request the server
054 * ID of the server that actually processed the associated request.  It may be
055 * used for requests sent directly to a Directory Server, but it is more useful
056 * when the request will pass through a Directory Proxy Server instance because
057 * the corresponding {@link GetServerIDResponseControl} will provide the server
058 * ID of the backend server used to process the request.  This server ID may be
059 * used in a {@link RouteToServerRequestControl} instance to request that
060 * subsequent operations be processed by the same server.  See the documentation
061 * for the {@code RouteToServerRequestControl} for an example that demonstrates
062 * this.
063 * <BR>
064 * <BLOCKQUOTE>
065 *   <B>NOTE:</B>  This class, and other classes within the
066 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
067 *   supported for use against Ping Identity, UnboundID, and
068 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
069 *   for proprietary functionality or for external specifications that are not
070 *   considered stable or mature enough to be guaranteed to work in an
071 *   interoperable way with other types of LDAP servers.
072 * </BLOCKQUOTE>
073 * <BR>
074 * This control does not have a value.  The criticality may be either
075 * {@code true} or {@code false}.
076 */
077@NotMutable()
078@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
079public final class GetServerIDRequestControl
080       extends Control
081{
082  /**
083   * The OID (1.3.6.1.4.1.30221.2.5.14) for the get server ID request control.
084   */
085  @NotNull public static final String GET_SERVER_ID_REQUEST_OID =
086       "1.3.6.1.4.1.30221.2.5.14";
087
088
089  /**
090   * The serial version UID for this serializable class.
091   */
092  private static final long serialVersionUID = -6015835755174298354L;
093
094
095
096  /**
097   * Creates a new get server ID request control.  It will not be marked
098   * critical.
099   */
100  public GetServerIDRequestControl()
101  {
102    this(false);
103  }
104
105
106
107  /**
108   * Creates a new get server ID request control with the specified
109   * criticality.
110   *
111   * @param  isCritical  Indicates whether this control should be marked
112   *                     critical.
113   */
114  public GetServerIDRequestControl(final boolean isCritical)
115  {
116    super(GET_SERVER_ID_REQUEST_OID, isCritical,  null);
117  }
118
119
120
121  /**
122   * Creates a new get server ID request control which is decoded from the
123   * provided generic control.
124   *
125   * @param  control  The generic control to be decoded as a get server ID
126   *                  request control.
127   *
128   * @throws  LDAPException  If the provided control cannot be decoded as a get
129   *                         server ID request control.
130   */
131  public GetServerIDRequestControl(@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_GET_SERVER_ID_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_GET_SERVER_ID_REQUEST.get();
153  }
154
155
156
157  /**
158   * {@inheritDoc}
159   */
160  @Override()
161  public void toString(@NotNull final StringBuilder buffer)
162  {
163    buffer.append("GetServerIDRequestControl(isCritical=");
164    buffer.append(isCritical());
165    buffer.append(')');
166  }
167}