PasswordPolicyControl (spring-security-docs-manual 5.5.2 API)

java.lang.Object
- org.springframework.security.ldap.ppolicy.PasswordPolicyControl

All Implemented Interfaces:

java.io.Serializable, javax.naming.ldap.Control

Direct Known Subclasses:

PasswordPolicyResponseControl
```
public class PasswordPolicyControl
extends java.lang.Object
implements javax.naming.ldap.Control
```
A Password Policy request control.
Based on the information in the corresponding internet draft on LDAP password policy

See Also:

PasswordPolicyResponseControl, Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String OID
OID of the Password Policy Control
- Fields inherited from interface javax.naming.ldap.Control
  CRITICAL, NONCRITICAL

Constructor Summary

Constructors
Constructor Description

PasswordPolicyControl()
Creates a non-critical (request) control.

PasswordPolicyControl(boolean critical)
Creates a (request) control.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`getEncodedValue()`	Retrieves the ASN.1 BER encoded value of the LDAP control.
`java.lang.String`	`getID()`	Returns the OID of the Password Policy Control ("1.3.6.1.4.1.42.2.27.8.5.1").
`boolean`	`isCritical()`	Returns whether the control is critical for the client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OID
```
public static final java.lang.String OID
```
    OID of the Password Policy Control
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PasswordPolicyControl
```
public PasswordPolicyControl()
```
    Creates a non-critical (request) control.
  - PasswordPolicyControl
```
public PasswordPolicyControl(boolean critical)
```
    Creates a (request) control.
    
    Parameters:
    
    critical - indicates whether the control is critical for the client
- Method Detail
  - getEncodedValue
```
public byte[] getEncodedValue()
```
    Retrieves the ASN.1 BER encoded value of the LDAP control. The request value for this control is always empty.
    
    Specified by:
    
    getEncodedValue in interface javax.naming.ldap.Control
    
    Returns:
    
    always null
  - getID
```
public java.lang.String getID()
```
    Returns the OID of the Password Policy Control ("1.3.6.1.4.1.42.2.27.8.5.1").
    
    Specified by:
    
    getID in interface javax.naming.ldap.Control
  - isCritical
```
public boolean isCritical()
```
    Returns whether the control is critical for the client.
    
    Specified by:
    
    isCritical in interface javax.naming.ldap.Control