com.unboundid.ldap.sdk.unboundidds.controls.GetPasswordPolicyStateIssuesRequestControl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
The newest version!
/*
* Copyright 2015-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2015-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2015-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.sdk.unboundidds.controls;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.JSONControlDecodeHelper;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.json.JSONField;
import com.unboundid.util.json.JSONObject;
import static com.unboundid.ldap.sdk.unboundidds.controls.ControlMessages.*;
/**
* This class provides an implementation of a request control that can be
* included in a bind request to indicate that the server should include a
* control in the bind response with information about any password policy state
* notices, warnings, and/or errors for the user.
*
*
* NOTE: This class, and other classes within the
* {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
* supported for use against Ping Identity, UnboundID, and
* Nokia/Alcatel-Lucent 8661 server products. These classes provide support
* for proprietary functionality or for external specifications that are not
* considered stable or mature enough to be guaranteed to work in an
* interoperable way with other types of LDAP servers.
*
*
* This control has an OID of 1.3.6.1.4.1.30221.2.5.46 and no value. It must
* only be used in a bind request that also includes the
* {@link RetainIdentityRequestControl}, and the authentication identify of the
* connection prior to sending the bind request must have the
* permit-get-password-policy-state-issues privilege.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class GetPasswordPolicyStateIssuesRequestControl
extends Control
{
/**
* The OID (1.3.6.1.4.1.30221.2.5.46) for the get password policy state issues
* request control.
*/
@NotNull public static final String
GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID =
"1.3.6.1.4.1.30221.2.5.46";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 5423754545363349200L;
/**
* Creates a new instance of this control. It will not be considered
* critical.
*/
public GetPasswordPolicyStateIssuesRequestControl()
{
this(false);
}
/**
* Creates a new instance of this control with the specified criticality.
*
* @param isCritical Indicates whether the control should be considered
* critical.
*/
public GetPasswordPolicyStateIssuesRequestControl(final boolean isCritical)
{
super(GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID, isCritical);
}
/**
* Creates a new instance of this control that is decoded from the provided
* generic control.
*
* @param control The control to decode as a get password policy state
* issues request control.
*
* @throws LDAPException If a problem is encountered while attempting to
* decode the provided control as a get password
* policy state issues request control.
*/
public GetPasswordPolicyStateIssuesRequestControl(
@NotNull final Control control)
throws LDAPException
{
super(control);
if (control.hasValue())
{
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_GET_PWP_STATE_ISSUES_REQUEST_HAS_VALUE.get());
}
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getControlName()
{
return INFO_CONTROL_NAME_GET_PWP_STATE_ISSUES_REQUEST.get();
}
/**
* Retrieves a representation of this get password policy state issues request
* control as a JSON object. The JSON object uses the following fields (note
* that since this control does not have a value, neither the
* {@code value-base64} nor {@code value-json} fields may be present):
*
* -
* {@code oid} -- A mandatory string field whose value is the object
* identifier for this control. For the get password policy state issues
* request control, the OID is "1.3.6.1.4.1.30221.2.5.46".
*
* -
* {@code control-name} -- An optional string field whose value is a
* human-readable name for this control. This field is only intended for
* descriptive purposes, and when decoding a control, the {@code oid}
* field should be used to identify the type of control.
*
* -
* {@code criticality} -- A mandatory Boolean field used to indicate
* whether this control is considered critical.
*
*
*
* @return A JSON object that contains a representation of this control.
*/
@Override()
@NotNull()
public JSONObject toJSONControl()
{
return new JSONObject(
new JSONField(JSONControlDecodeHelper.JSON_FIELD_OID,
GET_PASSWORD_POLICY_STATE_ISSUES_REQUEST_OID),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CONTROL_NAME,
INFO_CONTROL_NAME_GET_PWP_STATE_ISSUES_REQUEST.get()),
new JSONField(JSONControlDecodeHelper.JSON_FIELD_CRITICALITY,
isCritical()));
}
/**
* Attempts to decode the provided object as a JSON representation of a get
* password policy state issues request control.
*
* @param controlObject The JSON object to be decoded. It must not be
* {@code null}.
* @param strict Indicates whether to use strict mode when decoding
* the provided JSON object. If this is {@code true},
* then this method will throw an exception if the
* provided JSON object contains any unrecognized
* fields. If this is {@code false}, then unrecognized
* fields will be ignored.
*
* @return The get password policy state issues request control that was
* decoded from the provided JSON object.
*
* @throws LDAPException If the provided JSON object cannot be parsed as a
* valid get password policy state issues request
* control.
*/
@NotNull()
public static GetPasswordPolicyStateIssuesRequestControl decodeJSONControl(
@NotNull final JSONObject controlObject,
final boolean strict)
throws LDAPException
{
final JSONControlDecodeHelper jsonControl = new JSONControlDecodeHelper(
controlObject, strict, false, false);
return new GetPasswordPolicyStateIssuesRequestControl(
jsonControl.getCriticality());
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("GetPasswordPolicyStateIssuesRequestControl(isCritical=");
buffer.append(isCritical());
buffer.append(')');
}
}