public class

PasswordPolicyResponseControl

extends PasswordPolicyControl
java.lang.Object
   ↳ org.springframework.security.ldap.ppolicy.PasswordPolicyControl
     ↳ org.springframework.security.ldap.ppolicy.PasswordPolicyResponseControl

Class Overview

Represents the response control received when a PasswordPolicyControl is used when binding to a directory. Currently tested with the OpenLDAP 2.3.19 implementation of the LDAP Password Policy Draft. It extends the request control with the control specific data. This is accomplished by the properties timeBeforeExpiration, graceLoginsRemaining.

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.security.ldap.ppolicy.PasswordPolicyControl
From interface javax.naming.ldap.Control
Public Constructors
PasswordPolicyResponseControl(byte[] encodedValue)
Decodes the Ber encoded control data.
Public Methods
byte[] getEncodedValue()
Returns the unchanged value of the response control.
PasswordPolicyErrorStatus getErrorStatus()
int getGraceLoginsRemaining()
Returns the graceLoginsRemaining.
int getTimeBeforeExpiration()
Returns the timeBeforeExpiration.
boolean hasError()
Checks whether an error is present.
boolean hasWarning()
Checks whether a warning is present.
boolean isChangeAfterReset()
boolean isExpired()
boolean isLocked()
Determines whether an account locked error has been returned.
boolean isUsingGraceLogins()
String toString()
Create a textual representation containing error and warning messages, if any are present.
[Expand]
Inherited Methods
From class org.springframework.security.ldap.ppolicy.PasswordPolicyControl
From class java.lang.Object
From interface javax.naming.ldap.Control

Public Constructors

public PasswordPolicyResponseControl (byte[] encodedValue)

Decodes the Ber encoded control data. The ASN.1 value of the control data is:

    PasswordPolicyResponseValue ::= SEQUENCE {       warning [0] CHOICE {
           timeBeforeExpiration [0] INTEGER (0 .. maxInt),
           graceAuthNsRemaining [1] INTEGER (0 .. maxInt) } OPTIONAL,       error   [1] ENUMERATED {
           passwordExpired             (0),          accountLocked               (1),
           changeAfterReset            (2),          passwordModNotAllowed       (3),
           mustSupplyOldPassword       (4),          insufficientPasswordQuality (5),
           passwordTooShort            (6),          passwordTooYoung            (7),
           passwordInHistory           (8) } OPTIONAL }

Public Methods

public byte[] getEncodedValue ()

Returns the unchanged value of the response control. Returns the unchanged value of the response control as byte array.

Returns
  • always null

public PasswordPolicyErrorStatus getErrorStatus ()

public int getGraceLoginsRemaining ()

Returns the graceLoginsRemaining.

Returns
  • Returns the graceLoginsRemaining.

public int getTimeBeforeExpiration ()

Returns the timeBeforeExpiration.

Returns
  • Returns the time before expiration in seconds

public boolean hasError ()

Checks whether an error is present.

Returns
  • true, if an error is present

public boolean hasWarning ()

Checks whether a warning is present.

Returns
  • true, if a warning is present

public boolean isChangeAfterReset ()

public boolean isExpired ()

public boolean isLocked ()

Determines whether an account locked error has been returned.

Returns
  • true if the account is locked.

public boolean isUsingGraceLogins ()

public String toString ()

Create a textual representation containing error and warning messages, if any are present.

Returns
  • error and warning messages