Package com.appiancorp.suiteapi.security.auth

Class AppianUserDetailsService

java.lang.Object

com.appiancorp.suiteapi.security.auth.AppianUserDetailsService

All Implemented Interfaces:

org.springframework.security.core.userdetails.UserDetailsService

public class AppianUserDetailsService
extends Object
implements org.springframework.security.core.userdetails.UserDetailsService

Retrieves the user data from UserProfileService and returns an instance of AppianUserDetails.

Constructor Summary

Constructors

Constructor	Description
AppianUserDetailsService()	Creates a new configured instance by calling AppianUserDetailsService(boolean) and passing true.
AppianUserDetailsService(boolean applyPasswordManagement)	Creates a new configured instance.

Method Summary

Modifier and Type	Method	Description
static PasswordStatus	calculatePasswordStatus(UserProfile user)	Calculates the password status using the Password Management feature configurations and the user metadata User.isTemporaryPassword() and User.getPasswordModified().
AppianUserDetails	getUserDetails(UserProfile user)	Creates a new AppianUserDetails instance populated using the given Appian user metadata.
AppianUserDetails	getUserDetails(UserProfile user, Set<String> userRoles)	Deprecated. Use getUserDetails(UserProfile) instead.
AppianUserDetails	getUserDetailsLazy(String username)	Creates a new AppianUserDetails instance populated using the given username.
boolean	isApplyPasswordManagement()	Deprecated. use isApplyPasswordManagement(String)
protected boolean	isApplyPasswordManagement(String username)	Override this method to dynamically specify whether password management should be applied for a given user.
AppianUserDetails	loadUserByUsername(String username)	Retrieves the Appian user metadata using UserProfileService and creates a new AppianUserDetails instance using getUserDetails(UserProfile).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AppianUserDetailsService

public AppianUserDetailsService()

Creates a new configured instance by calling AppianUserDetailsService(boolean) and passing true.

AppianUserDetailsService

public AppianUserDetailsService(boolean applyPasswordManagement)

Creates a new configured instance.

Parameters:

applyPasswordManagement - If set to true, the password status of the AppianUserDetails bean returned by loadUserByUsername(String) will be calculated using calculatePasswordStatus(UserProfile). If set to false, the password status will always be set to PasswordStatus.NORMAL.

Method Details

isApplyPasswordManagement

@Deprecated
public boolean isApplyPasswordManagement()

Deprecated.

use isApplyPasswordManagement(String)

isApplyPasswordManagement

protected boolean isApplyPasswordManagement(String username)

Override this method to dynamically specify whether password management should be applied for a given user. For example, a user could have password management enabled/disabled, depending on their group membership.

Parameters:

username - The user for which to return whether password management should be applied.

Returns:

true if password management should be applied for the given user.

loadUserByUsername

public AppianUserDetails loadUserByUsername(String username)
                                     throws org.springframework.security.core.userdetails.UsernameNotFoundException

Retrieves the Appian user metadata using UserProfileService and creates a new AppianUserDetails instance using getUserDetails(UserProfile).

Specified by:

loadUserByUsername in interface org.springframework.security.core.userdetails.UserDetailsService

Throws:

org.springframework.security.core.userdetails.UsernameNotFoundException

getUserDetails

public AppianUserDetails getUserDetails(UserProfile user)

Creates a new AppianUserDetails instance populated using the given Appian user metadata. If isApplyPasswordManagement() is set to true, sets the password status using calculatePasswordStatus(UserProfile). Otherwise, sets the password status to PasswordStatus.NORMAL.

Parameters:

user - The Appian user metadata.

Returns:

The user details.

getUserDetailsLazy

public AppianUserDetails getUserDetailsLazy(String username)

Creates a new AppianUserDetails instance populated using the given username. The returned user details bean is "lazy" -- the Appian user metadata and the password status for the user are not loaded until the first call to these getters. Use this method when you only have a username since retrieving a UserProfile object is comparatively expensive.

Parameters:

username - The username.

Returns:

The user details.

getUserDetails

@Deprecated
public AppianUserDetails getUserDetails(UserProfile user,
 Set<String> userRoles)

Deprecated.

Use getUserDetails(UserProfile) instead.

Creates a new AppianUserDetails instance populated using the given Appian user metadata. If isApplyPasswordManagement() is set to true, sets the password status using calculatePasswordStatus(UserProfile). Otherwise, sets the password status to PasswordStatus.NORMAL.

Parameters:

user - The Appian user metadata.

userRoles - The roles of the user.

Returns:

The user details.

calculatePasswordStatus

public static PasswordStatus calculatePasswordStatus(UserProfile user)

Calculates the password status using the Password Management feature configurations and the user metadata User.isTemporaryPassword() and User.getPasswordModified().

Parameters:

user - The Appian user metadata.

Returns:

The password status for the given user.