Package org.ldaptive.auth.ext

Class EDirectoryAuthenticationResponseHandler

  • All Implemented Interfaces:
    AuthenticationResponseHandler, Freezable
    public class EDirectoryAuthenticationResponseHandler
extends AbstractFreezable
implements AuthenticationResponseHandler
    Attempts to parse the authentication response and set the account state using data associated with eDirectory. The Authenticator should be configured to return 'passwordExpirationTime' and 'loginGraceRemaining' attributes, so they can be consumed by this handler. If this handler is assigned a warningPeriod, this handler will only emit warnings during that window before password expiration. Otherwise, a warning is always emitted if passwordExpirationTime is set.

    • Field Detail

      • ATTRIBUTES

        public static final String[] ATTRIBUTES
        Attributes needed to enforce password policy.

      • logger

        private final Logger logger
        Logger for this class.

      • expirationClock

        private final Clock expirationClock
        Clock to calculate current date for comparison with expiration time.

      • warningPeriod

        private Period warningPeriod
        Amount of time before expiration to produce a warning.

    • Constructor Detail

      • EDirectoryAuthenticationResponseHandler

        EDirectoryAuthenticationResponseHandler​(Clock clock)
        Creates a new edirectory authentication response handler.
        Parameters:
        clock - used to convert time before expiration to a datetime

      • EDirectoryAuthenticationResponseHandler

        public EDirectoryAuthenticationResponseHandler()
        Creates a new edirectory authentication response handler.

      • EDirectoryAuthenticationResponseHandler

        public EDirectoryAuthenticationResponseHandler​(Period warning)
        Creates a new edirectory authentication response handler.
        Parameters:
        warning - length of time before expiration that should produce a warning

    • Method Detail

      • getWarningPeriod

        public Period getWarningPeriod()
        Returns the amount of time before expiration to produce a warning.
        Returns:
        warning period

      • setWarningPeriod

        public void setWarningPeriod​(Period period)
        Sets the amount of time before expiration to produce a warning.
        Parameters:
        period - warning period