001/* 002 * Copyright 2015-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2015-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 an implementation for a request control that can be 053 * included in an add, modify, or password modify request. Its presence in one 054 * of those requests will indicate that the server should provide a response 055 * control with information about the password quality requirements that are in 056 * effect for the operation and information about whether the password included 057 * in the request satisfies each of those requirements. 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 * This request control has an OID of 1.3.6.1.4.1.30221.2.5.40, and it is 070 * recommended that the criticality be {@code false}. It does not have a value. 071 */ 072@NotMutable() 073@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 074public final class PasswordValidationDetailsRequestControl 075 extends Control 076{ 077 /** 078 * The OID (1.3.6.1.4.1.30221.2.5.40) for the password validation details 079 * request control. 080 */ 081 public static final String PASSWORD_VALIDATION_DETAILS_REQUEST_OID = 082 "1.3.6.1.4.1.30221.2.5.40"; 083 084 085 086 /** 087 * The serial version UID for this serializable class. 088 */ 089 private static final long serialVersionUID = -956099348044171899L; 090 091 092 093 /** 094 * Creates a new password validation details request control with 095 * a criticality of {@code false}. 096 */ 097 public PasswordValidationDetailsRequestControl() 098 { 099 this(false); 100 } 101 102 103 104 /** 105 * Creates a new password validation details request control with the 106 * specified criticality. 107 * 108 * @param isCritical Indicates whether this control should be considered 109 * critical. 110 */ 111 public PasswordValidationDetailsRequestControl(final boolean isCritical) 112 { 113 super(PASSWORD_VALIDATION_DETAILS_REQUEST_OID, isCritical, null); 114 } 115 116 117 118 /** 119 * Creates a new password validation details request control which is decoded 120 * from the provided generic control. 121 * 122 * @param control The generic control to be decoded as a password validation 123 * details request control. 124 * 125 * @throws LDAPException If the provided control cannot be decoded as a 126 * password validation details request control. 127 */ 128 public PasswordValidationDetailsRequestControl(final Control control) 129 throws LDAPException 130 { 131 super(control); 132 133 if (control.hasValue()) 134 { 135 throw new LDAPException(ResultCode.DECODING_ERROR, 136 ERR_PW_VALIDATION_REQUEST_HAS_VALUE.get()); 137 } 138 } 139 140 141 142 /** 143 * {@inheritDoc} 144 */ 145 @Override() 146 public String getControlName() 147 { 148 return INFO_CONTROL_NAME_PW_VALIDATION_REQUEST.get(); 149 } 150 151 152 153 /** 154 * {@inheritDoc} 155 */ 156 @Override() 157 public void toString(final StringBuilder buffer) 158 { 159 buffer.append("PasswordValidationDetailsRequestControl(isCritical="); 160 buffer.append(isCritical()); 161 buffer.append(')'); 162 } 163}