Summary: Methods | [Expand All]
@PublicApi public interface

LoginResult

com.atlassian.jira.bc.security.login.LoginResult
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A result object for login operations

Summary

Public Methods
Set<DeniedReason> getDeniedReasons()
Returns a Set of DenialReason objects, which can be used to determine the reason why a login request has been denied.
LoginInfo getLoginInfo()
LoginReason getReason()
If the login fails then this enum describes why
String getUserName()
boolean isOK()

Public Methods

public 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() != AUTHENTICATION_DENIED.

Returns
  • a Set of DenialReason

public LoginInfo getLoginInfo ()

Returns

public LoginReason getReason ()

If the login fails then this enum describes why

Returns

public String getUserName ()

Returns
  • the name of the user that the login was performed for or null if its not known

public boolean isOK ()

Returns