Package com.atlassian.crowd.model.authentication

Class UserAuthenticationContext

java.lang.Object

com.atlassian.crowd.model.authentication.AuthenticationContext

com.atlassian.crowd.model.authentication.UserAuthenticationContext

All Implemented Interfaces:

Serializable

public class UserAuthenticationContext
extends AuthenticationContext
implements Serializable

The UserAuthenticationContext is used to authenticate users.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UserAuthenticationContext()
UserAuthenticationContext(String name, PasswordCredential credential, ValidationFactor[] validationFactors, String application)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getApplication()	Gets the application name the authentication request is for.
int	hashCode()
boolean	isLocalCrowdWebAppAuthentication()
boolean	isPostAuthenticationUpdatesRequired()	Returns whether updates like publishing authenticated events, setting user authentication attributes etc.
void	setApplication(String application)	Sets the application name the authentication request is for.
void	setLocalCrowdWebAppAuthentication(boolean localCrowdWebAppAuthentication)
void	setPostAuthenticationUpdatesRequired(boolean postAuthenticationUpdatesRequired)	Sets whether updates like publishing authenticated events, setting user authentication attributes etc.
String	toString()
UserAuthenticationContext	withName(String name)

Methods inherited from class com.atlassian.crowd.model.authentication.AuthenticationContext

getCredential, getName, getValidationFactors, setCredential, setName, setValidationFactors

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserAuthenticationContext

public UserAuthenticationContext()

UserAuthenticationContext

public UserAuthenticationContext(String name,
 @Nullable
 PasswordCredential credential,
 ValidationFactor[] validationFactors,
 String application)

Method Details

getApplication

public String getApplication()

Gets the application name the authentication request is for.

Returns:

The application name.

setApplication

public void setApplication(String application)

Sets the application name the authentication request is for.

Parameters:

application - The application name.

isLocalCrowdWebAppAuthentication

public boolean isLocalCrowdWebAppAuthentication()

Returns:

true, if it's Crowd itself authenticating a user in `crowd` app. False, if it's an external client (i.e. REST API client).

setLocalCrowdWebAppAuthentication

public void setLocalCrowdWebAppAuthentication(boolean localCrowdWebAppAuthentication)

isPostAuthenticationUpdatesRequired

public boolean isPostAuthenticationUpdatesRequired()

Returns whether updates like publishing authenticated events, setting user authentication attributes etc. are required after a successful authentication.

Returns:

true if updates are required, false otherwise

Since:

6.2.0

setPostAuthenticationUpdatesRequired

public void setPostAuthenticationUpdatesRequired(boolean postAuthenticationUpdatesRequired)

Sets whether updates like publishing authenticated events, setting user authentication attributes etc. are required after a successful authentication. For two-step verification, this should be set to false while doing credential verification.

Parameters:

postAuthenticationUpdatesRequired - true if updates are required, false otherwise

Since:

6.2.0

equals

public boolean equals(Object o)

Overrides:

equals in class AuthenticationContext

hashCode

public int hashCode()

Overrides:

hashCode in class AuthenticationContext

toString

public String toString()

Overrides:

toString in class AuthenticationContext

withName

public UserAuthenticationContext withName(String name)

Returns:

a new UserAuthenticationContext that is a copy of this one with the username replaced with the provided value