Package com.atlassian.jira.bc.security.login

Interface LoginResult

All Known Implementing Classes:
LoginResultImpl
@PublicApi public interface LoginResult
A result object for login operations
Since:
v4.0.1

  • Method Details

    • isOK

      boolean isOK()
      Returns:
      true if all is OK. In this case getReason() will equals LoginReason.OK

    • getUserName

      String getUserName()
      Returns:
      the name of the user that the login was performed for or null if its not known

    • getReason

      LoginReason getReason()
      If the login fails then this enum describes why
      Returns:
      the LoginReason

    • getDeniedReasons

      Set<DeniedReason> getDeniedReasons()
      Returns a Set of DenialReason objects, which can be used to determine the reason why a login request has been denied. This method returns an empty set when getReason() != LoginReason.AUTHENTICATION_DENIED.
      Returns:
      a Set of DenialReason

    • getLoginInfo

      LoginInfo getLoginInfo()
      Returns:
      The LoginInfo associated with the user or null if the getUserName() returns null.