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 of a request control that can be 053 * included in a bind request to indicate that the server should include a 054 * control in the bind response with information about any password policy state 055 * notices, warnings, and/or errors for the user. 056 * <BR> 057 * <BLOCKQUOTE> 058 * <B>NOTE:</B> This class, and other classes within the 059 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 060 * supported for use against Ping Identity, UnboundID, and 061 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 062 * for proprietary functionality or for external specifications that are not 063 * considered stable or mature enough to be guaranteed to work in an 064 * interoperable way with other types of LDAP servers. 065 * </BLOCKQUOTE> 066 * <BR> 067 * This control has an OID of 1.3.6.1.4.1.30221.2.5.46 and no value. It must 068 * only be used in a bind request that also includes the 069 * {@link RetainIdentityRequestControl}, and the authentication identify of the 070 * connection prior to sending the bind request must have the 071 * permit-get-password-policy-state-issues privilege. 072 */ 073@NotMutable() 074@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 075public final class GetPasswordPolicyStateIssuesRequestControl 076 extends Control 077{ 078 /** 079 * The OID (1.3.6.1.4.1.30221.2.5.46) for the get password policy state issues 080 * request control. 081 */ 082 public static final String GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID = 083 "1.3.6.1.4.1.30221.2.5.46"; 084 085 086 087 /** 088 * The serial version UID for this serializable class. 089 */ 090 private static final long serialVersionUID = 5423754545363349200L; 091 092 093 094 /** 095 * Creates a new instance of this control. It will not be considered 096 * critical. 097 */ 098 public GetPasswordPolicyStateIssuesRequestControl() 099 { 100 this(false); 101 } 102 103 104 105 /** 106 * Creates a new instance of this control with the specified criticality. 107 * 108 * @param isCritical Indicates whether the control should be considered 109 * critical. 110 */ 111 public GetPasswordPolicyStateIssuesRequestControl(final boolean isCritical) 112 { 113 super(GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID, isCritical); 114 } 115 116 117 118 /** 119 * Creates a new instance of this control that is decoded from the provided 120 * generic control. 121 * 122 * @param control The control to decode as a get password policy state 123 * issues request control. 124 * 125 * @throws LDAPException If a problem is encountered while attempting to 126 * decode the provided control as a get password 127 * policy state issues request control. 128 */ 129 public GetPasswordPolicyStateIssuesRequestControl(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_GET_PWP_STATE_ISSUES_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_GET_PWP_STATE_ISSUES_REQUEST.get(); 150 } 151 152 153 154 /** 155 * {@inheritDoc} 156 */ 157 @Override() 158 public void toString(final StringBuilder buffer) 159 { 160 buffer.append("GetPasswordPolicyStateIssuesRequestControl(isCritical="); 161 buffer.append(isCritical()); 162 buffer.append(')'); 163 } 164}