001/*
002 * Copyright 2008-2020 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2008-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) 2015-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 a request control which may be used to request the server
053 * ID of the server that actually processed the associated request.  It may be
054 * used for requests sent directly to a Directory Server, but it is more useful
055 * when the request will pass through a Directory Proxy Server instance because
056 * the corresponding {@link GetServerIDResponseControl} will provide the server
057 * ID of the backend server used to process the request.  This server ID may be
058 * used in a {@link RouteToServerRequestControl} instance to request that
059 * subsequent operations be processed by the same server.  See the documentation
060 * for the {@code RouteToServerRequestControl} for an example that demonstrates
061 * this.
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 control does not have a value.  The criticality may be either
074 * {@code true} or {@code false}.
075 */
076@NotMutable()
077@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
078public final class GetServerIDRequestControl
079       extends Control
080{
081  /**
082   * The OID (1.3.6.1.4.1.30221.2.5.14) for the get server ID request control.
083   */
084  public static final String GET_SERVER_ID_REQUEST_OID =
085       "1.3.6.1.4.1.30221.2.5.14";
086
087
088  /**
089   * The serial version UID for this serializable class.
090   */
091  private static final long serialVersionUID = -6015835755174298354L;
092
093
094
095  /**
096   * Creates a new get server ID request control.  It will not be marked
097   * critical.
098   */
099  public GetServerIDRequestControl()
100  {
101    this(false);
102  }
103
104
105
106  /**
107   * Creates a new get server ID request control with the specified
108   * criticality.
109   *
110   * @param  isCritical  Indicates whether this control should be marked
111   *                     critical.
112   */
113  public GetServerIDRequestControl(final boolean isCritical)
114  {
115    super(GET_SERVER_ID_REQUEST_OID, isCritical,  null);
116  }
117
118
119
120  /**
121   * Creates a new get server ID request control which is decoded from the
122   * provided generic control.
123   *
124   * @param  control  The generic control to be decoded as a get server ID
125   *                  request control.
126   *
127   * @throws  LDAPException  If the provided control cannot be decoded as a get
128   *                         server ID request control.
129   */
130  public GetServerIDRequestControl(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_GET_SERVER_ID_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_GET_SERVER_ID_REQUEST.get();
151  }
152
153
154
155  /**
156   * {@inheritDoc}
157   */
158  @Override()
159  public void toString(final StringBuilder buffer)
160  {
161    buffer.append("GetServerIDRequestControl(isCritical=");
162    buffer.append(isCritical());
163    buffer.append(')');
164  }
165}