001/*
002 * Copyright 2015-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2015-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) 2015-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 for a request control that can be
054 * included in an add, modify, or password modify request.  Its presence in one
055 * of those requests will indicate that the server should provide a response
056 * control with information about the password quality requirements that are in
057 * effect for the operation and information about whether the password included
058 * in the request satisfies each of those requirements.
059 * <BR>
060 * <BLOCKQUOTE>
061 *   <B>NOTE:</B>  This class, and other classes within the
062 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
063 *   supported for use against Ping Identity, UnboundID, and
064 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
065 *   for proprietary functionality or for external specifications that are not
066 *   considered stable or mature enough to be guaranteed to work in an
067 *   interoperable way with other types of LDAP servers.
068 * </BLOCKQUOTE>
069 * <BR>
070 * This request control has an OID of 1.3.6.1.4.1.30221.2.5.40, and it is
071 * recommended that the criticality be {@code false}.  It does not have a value.
072 */
073@NotMutable()
074@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
075public final class PasswordValidationDetailsRequestControl
076       extends Control
077{
078 /**
079  * The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details
080  * request control.
081  */
082 @NotNull public static final String PASSWORD_VALIDATION_DETAILS_REQUEST_OID =
083      "1.3.6.1.4.1.30221.2.5.40";
084
085
086
087 /**
088  * The serial version UID for this serializable class.
089  */
090 private static final long serialVersionUID = -956099348044171899L;
091
092
093
094  /**
095   * Creates a new password validation details request control with
096   * a criticality of {@code false}.
097   */
098  public PasswordValidationDetailsRequestControl()
099  {
100    this(false);
101  }
102
103
104
105  /**
106   * Creates a new password validation details request control with the
107   * specified criticality.
108   *
109   * @param  isCritical  Indicates whether this control should be considered
110   *                     critical.
111   */
112  public PasswordValidationDetailsRequestControl(final boolean isCritical)
113  {
114    super(PASSWORD_VALIDATION_DETAILS_REQUEST_OID, isCritical, null);
115  }
116
117
118
119  /**
120   * Creates a new password validation details request control which is decoded
121   * from the provided generic control.
122   *
123   * @param  control  The generic control to be decoded as a password validation
124   *                  details request control.
125   *
126   * @throws  LDAPException  If the provided control cannot be decoded as a
127   *                         password validation details request control.
128   */
129  public PasswordValidationDetailsRequestControl(
130              @NotNull 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_PW_VALIDATION_REQUEST_HAS_VALUE.get());
139    }
140  }
141
142
143
144  /**
145   * {@inheritDoc}
146   */
147  @Override()
148  @NotNull()
149  public String getControlName()
150  {
151    return INFO_CONTROL_NAME_PW_VALIDATION_REQUEST.get();
152  }
153
154
155
156  /**
157   * {@inheritDoc}
158   */
159  @Override()
160  public void toString(@NotNull final StringBuilder buffer)
161  {
162    buffer.append("PasswordValidationDetailsRequestControl(isCritical=");
163    buffer.append(isCritical());
164    buffer.append(')');
165  }
166}