@PublicApi public final class

LoginProperties

extends Object
java.lang.Object
   ↳ com.atlassian.jira.bc.security.login.LoginProperties

@PublicApi

This class 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

Represents all the properties necessary to render the login form or gadget.

Summary

Nested Classes
class LoginProperties.Builder  
Public Methods
static LoginProperties.Builder builder()
String getContactAdminLink()
boolean getLoginFailedByPermissions()
boolean isAllowCookies()
boolean isCaptchaFailure()
boolean isCommunicationError()
boolean isElevatedSecurityCheckShown()
boolean isExternalPasswordManagement()
Returns true if JIRA is not able to manage user passwords, i.e.
boolean isExternalUserManagement()
boolean isLoginError()
boolean isLoginSucceeded()
boolean isPublicMode()
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static LoginProperties.Builder builder ()

public String getContactAdminLink ()

public boolean getLoginFailedByPermissions ()

public boolean isAllowCookies ()

public boolean isCaptchaFailure ()

public boolean isCommunicationError ()

public boolean isElevatedSecurityCheckShown ()

public boolean isExternalPasswordManagement ()

Returns true if JIRA is not able to manage user passwords, i.e. if there are no user directories which allow updates to user passwords; false if otherwise.

Returns
  • true if JIRA is not able to manage user passwords, i.e. if there are no user directories which allow updates to user passwords; false if otherwise.

public boolean isExternalUserManagement ()

public boolean isLoginError ()

public boolean isLoginSucceeded ()

public boolean isPublicMode ()