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