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 of a request control that can be 054 * included in a bind request to indicate that the server should include a 055 * control in the bind response with information about any password policy state 056 * notices, warnings, and/or errors for the user. 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 * This control has an OID of 1.3.6.1.4.1.30221.2.5.46 and no value. It must 069 * only be used in a bind request that also includes the 070 * {@link RetainIdentityRequestControl}, and the authentication identify of the 071 * connection prior to sending the bind request must have the 072 * permit-get-password-policy-state-issues privilege. 073 */ 074@NotMutable() 075@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 076public final class GetPasswordPolicyStateIssuesRequestControl 077 extends Control 078{ 079 /** 080 * The OID (1.3.6.1.4.1.30221.2.5.46) for the get password policy state issues 081 * request control. 082 */ 083 @NotNull public static final String 084 GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID = 085 "1.3.6.1.4.1.30221.2.5.46"; 086 087 088 089 /** 090 * The serial version UID for this serializable class. 091 */ 092 private static final long serialVersionUID = 5423754545363349200L; 093 094 095 096 /** 097 * Creates a new instance of this control. It will not be considered 098 * critical. 099 */ 100 public GetPasswordPolicyStateIssuesRequestControl() 101 { 102 this(false); 103 } 104 105 106 107 /** 108 * Creates a new instance of this control with the specified criticality. 109 * 110 * @param isCritical Indicates whether the control should be considered 111 * critical. 112 */ 113 public GetPasswordPolicyStateIssuesRequestControl(final boolean isCritical) 114 { 115 super(GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID, isCritical); 116 } 117 118 119 120 /** 121 * Creates a new instance of this control that is decoded from the provided 122 * generic control. 123 * 124 * @param control The control to decode as a get password policy state 125 * issues request control. 126 * 127 * @throws LDAPException If a problem is encountered while attempting to 128 * decode the provided control as a get password 129 * policy state issues request control. 130 */ 131 public GetPasswordPolicyStateIssuesRequestControl( 132 @NotNull final Control control) 133 throws LDAPException 134 { 135 super(control); 136 137 if (control.hasValue()) 138 { 139 throw new LDAPException(ResultCode.DECODING_ERROR, 140 ERR_GET_PWP_STATE_ISSUES_REQUEST_HAS_VALUE.get()); 141 } 142 } 143 144 145 146 /** 147 * {@inheritDoc} 148 */ 149 @Override() 150 @NotNull() 151 public String getControlName() 152 { 153 return INFO_CONTROL_NAME_GET_PWP_STATE_ISSUES_REQUEST.get(); 154 } 155 156 157 158 /** 159 * {@inheritDoc} 160 */ 161 @Override() 162 public void toString(@NotNull final StringBuilder buffer) 163 { 164 buffer.append("GetPasswordPolicyStateIssuesRequestControl(isCritical="); 165 buffer.append(isCritical()); 166 buffer.append(')'); 167 } 168}