Interface PwMessage

  • All Known Implementing Classes:
    Session

    public interface PwMessage
    Interface is implemented by Session and prescribes methods used to return Fortress password messages to the caller.
    Author:
    Apache Directory Project
    • Method Detail

      • setUserId

        void setUserId​(String userId)
        Return the User.userId from entity.
        Parameters:
        userId - maps to uid attribute on inetOrgPerson object class.
      • getUserId

        String getUserId()
        Set the User.userId in entity.
        Returns:
        userId maps to uid attribute on inetOrgPerson object class.
      • setMsg

        void setMsg​(String message)
        Contains the message that corresponds to password. These messages map to GlobalPwMsgIds.pwMsgs
        Parameters:
        message -
      • setAuthenticated

        void setAuthenticated​(boolean isAuthenticated)
        If set to true the user's password check out good.
        Parameters:
        isAuthenticated -
      • isAuthenticated

        boolean isAuthenticated()
        If set to true the user's password check out good.
        Returns:
        param isAuthenticated
      • setWarning

        void setWarning​(Warning warning)
        Return the warning id that pertain to User's password. This attribute maps to values between 0 and 100 contained within here GlobalPwMsgIds
        Parameters:
        warning - contains warning id.
      • setWarnings

        void setWarnings​(List<Warning> warnings)
      • getWarnings

        List<Warning> getWarnings()
        Set the warning id that pertain to User's password. This attribute maps to values between 0 and 100 contained within here GlobalPwMsgIds
        Returns:
        warning contains warning id.
      • setErrorId

        void setErrorId​(int error)
        Set the error id that pertain to User's password. This attribute maps to values greater than or equal to 100 contained within here GlobalPwMsgIds
        Parameters:
        error - contains error id that maps to GlobalPwMsgIds.pwIds
      • getErrorId

        int getErrorId()
        Return the error id that pertain to User's password. This attribute maps to values greater than or equal to 100 contained within here GlobalPwMsgIds
        Returns:
        error contains error id that maps to GlobalPwMsgIds.pwIds
      • setGraceLogins

        void setGraceLogins​(int grace)
        Grace count indicates how many binds User can perform before password slips into expired state.
        Parameters:
        grace - integer containing number of binds allowed for user.
      • getGraceLogins

        int getGraceLogins()
        Get the grace count which indicates how many binds User can perform before password slips into expired state.
        Returns:
        grace integer containing number of binds allowed for user.
      • setExpirationSeconds

        void setExpirationSeconds​(int expire)
        The number of seconds until the User's password expires.
        Parameters:
        expire - value is computed by ldap server and contains the number of seconds until password will expire.
      • getExpirationSeconds

        int getExpirationSeconds()
        Get the number of seconds until the User's password expires.
        Returns:
        expire value is computed by ldap server and contains the number of seconds until password will expire.