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