AppianUserDetails (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.security.auth.AppianUserDetails

All Implemented Interfaces:

com.appiancorp.security.auth.SecurityContext, com.appiancorp.suiteapi.security.auth.UserDetailsAndSecurityContext, java.io.Serializable, java.security.Principal, org.springframework.security.core.userdetails.UserDetails
```
public class AppianUserDetails
extends java.lang.Object
implements com.appiancorp.suiteapi.security.auth.UserDetailsAndSecurityContext
```
Implements the Spring UserDetails interface and holds Appian-specific data about a user.
Use AppianUserDetailsService to get an instance of this class.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`AppianUserDetails(java.lang.String username, com.appiancorp.security.auth.GroupMembershipInfoProvider groupMembershipInfoProvider)` Constructor to use when you only have the username since calling to retrieve a UserProfile object is comparatively expensive.
`AppianUserDetails(UserProfile userProfile, com.appiancorp.security.auth.GroupMembershipInfoProvider groupMembershipInfoProvider, PasswordStatus passwordStatus)`
`AppianUserDetails(UserProfile userProfile, PasswordStatus passwordStatus, java.util.Set<java.lang.String> roles)` Deprecated. Use `AppianUserDetailsService`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearEncryptedSamlAssertion()` Clear cached saml assertion once we are done consuming it.
`boolean`	`equals(java.lang.Object obj)` Returns `true` if the given object is an instance of `AppianUserDetails` and has the same `username` as this object.
`com.appiancorp.security.auth.AppianLoginContext`	`getAppianLoginContext()` Returns SSO specific login context that is used internally.
`java.util.Collection<org.springframework.security.core.GrantedAuthority>`	`getAuthorities()` Returns this user's roles.
`java.lang.String`	`getEncryptedSamlAssertion()` Holds encrypted saml assertion used to authenticate user when they logged in via saml.
`java.lang.String`	`getGrantorName()`
`java.util.Set<java.lang.String>`	`getGrantorRoles()`
`java.util.Set<com.appiancorp.type.refs.GroupRef>`	`getMemberGroupRefs()` Returns the Appian data source `GroupRef`s for the groups where the user is a member.
`java.util.Set<java.lang.String>`	`getMemberGroupUuids()` Returns the UUIDs of the groups where the user is a member.
`java.lang.String`	`getName()`
`java.util.Locale`	`getOverrideLocale()`
`java.lang.String`	`getPassword()`
`PasswordStatus`	`getPasswordStatus()`
`java.util.Set<java.lang.String>`	`getRoles()` Returns the user's roles.
`char[]`	`getScsKey()` Returns the key used to encrypt and decrypt values stored in the secure credentials store for this user.
`java.lang.String`	`getUsername()`
`UserProfile`	`getUserProfile()`
`com.appiancorp.type.refs.UserRef`	`getUserRef()` Returns the Appian data source `UserRef` for the user of these Credentials.
`java.lang.String`	`getUserUuid()`
`void`	`hashAndSetScsKey(char[] scsKeyPlainText)` Hashes and sets the key used to encrypt and decrypt values stored in the secure credentials store for this user.
`int`	`hashCode()` Returns the hash code of the `username`.
`boolean`	`isAccountNonExpired()` Returns true.
`boolean`	`isAccountNonLocked()` Returns true.
`boolean`	`isAdsSuperUser()`
`boolean`	`isAuthenticatedByAppianInternalProvider()`
`boolean`	`isCredentialsNonExpired()` Returns true.
`boolean`	`isEnabled()` Returns true.
`boolean`	`isLoggedInThroughSaml()`
`boolean`	`isSysAdmin()`
`boolean`	`isUserRefNull()`
`void`	`setAppianLoginContext(com.appiancorp.security.auth.AppianLoginContext appianLoginContext)` This is meant to be set only by the internal Appian authentication provider.
`void`	`setAuthenticatedByAppianInternalProvider(boolean value)` This is meant to be set only by the internal Appian authentication provider.
`void`	`setAuthorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities)` Deprecated. The authorities are calculated from the user's group memebrship and it is no longer necessary to set authorities explicitly.
`void`	`setEncryptedSamlAssertion(java.lang.String encryptedAssertion)` This is meant to be set only by the SamlAuthenticationWrapper.
`void`	`setIsAdsSuperUser(boolean isAdsSuperUser)`
`void`	`setLoggedInThroughSaml(boolean loggedInThroughSaml)` This is meant to be set only by the internal Appian authentication provider.
`void`	`setOverrideLocale(java.util.Locale overrideLocale)`
`void`	`setPasswordStatus(PasswordStatus passwordStatus)`
`void`	`setScsKey(char[] scsKey)` Sets the key used to encrypt and decrypt values stored in the secure credentials store for this user.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.security.Principal
implies

- Constructor Detail
  - AppianUserDetails
```
@Deprecated
public AppianUserDetails(UserProfile userProfile,
                                     PasswordStatus passwordStatus,
                                     java.util.Set<java.lang.String> roles)
```
    Deprecated. Use AppianUserDetailsService.
  - AppianUserDetails
```
public AppianUserDetails(UserProfile userProfile,
                         com.appiancorp.security.auth.GroupMembershipInfoProvider groupMembershipInfoProvider,
                         PasswordStatus passwordStatus)
```
  - AppianUserDetails
```
public AppianUserDetails(java.lang.String username,
                         com.appiancorp.security.auth.GroupMembershipInfoProvider groupMembershipInfoProvider)
```
    Constructor to use when you only have the username since calling to retrieve a UserProfile object is comparatively expensive.
- Method Detail
  - getUserProfile
```
public UserProfile getUserProfile()
```
  - getUserUuid
```
public java.lang.String getUserUuid()
```
    Specified by:
    
    getUserUuid in interface com.appiancorp.security.auth.SecurityContext
  - setOverrideLocale
```
public void setOverrideLocale(java.util.Locale overrideLocale)
```
  - getOverrideLocale
```
public java.util.Locale getOverrideLocale()
```
    Specified by:
    
    getOverrideLocale in interface com.appiancorp.security.auth.SecurityContext
  - setIsAdsSuperUser
```
public void setIsAdsSuperUser(boolean isAdsSuperUser)
```
  - isAdsSuperUser
```
public boolean isAdsSuperUser()
```
    Specified by:
    
    isAdsSuperUser in interface com.appiancorp.security.auth.SecurityContext
  - getPasswordStatus
```
public PasswordStatus getPasswordStatus()
```
  - setPasswordStatus
```
public void setPasswordStatus(PasswordStatus passwordStatus)
```
  - getScsKey
```
public char[] getScsKey()
```
    Returns the key used to encrypt and decrypt values stored in the secure credentials store for this user. This key is used by the system automatically and should not be used for any other purposes.
    
    Returns:
    
    the key
  - setScsKey
```
public void setScsKey(char[] scsKey)
```
    Sets the key used to encrypt and decrypt values stored in the secure credentials store for this user. This key is set by the system automatically.
    
    Parameters:
    
    scsKey - the key that will be used to encrypt and decrypt values
  - hashAndSetScsKey
```
public void hashAndSetScsKey(char[] scsKeyPlainText)
```
    Hashes and sets the key used to encrypt and decrypt values stored in the secure credentials store for this user. This key is set by the system automatically.
    
    Parameters:
    
    scsKeyPlainText - the plain text of the key that will be used to encrypt and decrypt values
  - getUsername
```
public java.lang.String getUsername()
```
    Specified by:
    
    getUsername in interface org.springframework.security.core.userdetails.UserDetails
  - getPassword
```
public java.lang.String getPassword()
```
    Specified by:
    
    getPassword in interface org.springframework.security.core.userdetails.UserDetails
  - isAccountNonExpired
```
public boolean isAccountNonExpired()
```
    Returns true.
    
    Specified by:
    
    isAccountNonExpired in interface org.springframework.security.core.userdetails.UserDetails
  - isAccountNonLocked
```
public boolean isAccountNonLocked()
```
    Returns true.
    
    Specified by:
    
    isAccountNonLocked in interface org.springframework.security.core.userdetails.UserDetails
  - isCredentialsNonExpired
```
public boolean isCredentialsNonExpired()
```
    Returns true.
    
    Specified by:
    
    isCredentialsNonExpired in interface org.springframework.security.core.userdetails.UserDetails
  - isEnabled
```
public boolean isEnabled()
```
    Returns true.
    
    Specified by:
    
    isEnabled in interface org.springframework.security.core.userdetails.UserDetails
  - getAuthorities
```
public java.util.Collection<org.springframework.security.core.GrantedAuthority> getAuthorities()
```
    Returns this user's roles.
    
    Specified by:
    
    getAuthorities in interface org.springframework.security.core.userdetails.UserDetails
  - setAuthorities
```
@Deprecated
public void setAuthorities(java.util.Collection<org.springframework.security.core.GrantedAuthority> authorities)
```
    Deprecated. The authorities are calculated from the user's group memebrship and it is no longer necessary to set authorities explicitly.
    
    Parameters:
    
    authorities -
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface java.security.Principal
  - getUserRef
```
public com.appiancorp.type.refs.UserRef getUserRef()
```
    Returns the Appian data source UserRef for the user of these Credentials.
    
    Specified by:
    
    getUserRef in interface com.appiancorp.security.auth.SecurityContext
  - isUserRefNull
```
public boolean isUserRefNull()
```
    Specified by:
    
    isUserRefNull in interface com.appiancorp.security.auth.SecurityContext
  - getMemberGroupUuids
```
public java.util.Set<java.lang.String> getMemberGroupUuids()
```
    Returns the UUIDs of the groups where the user is a member.
    
    Specified by:
    
    getMemberGroupUuids in interface com.appiancorp.security.auth.SecurityContext
  - getMemberGroupRefs
```
public java.util.Set<com.appiancorp.type.refs.GroupRef> getMemberGroupRefs()
```
    Returns the Appian data source GroupRefs for the groups where the user is a member.
    
    Specified by:
    
    getMemberGroupRefs in interface com.appiancorp.security.auth.SecurityContext
  - getRoles
```
public java.util.Set<java.lang.String> getRoles()
```
    Returns the user's roles.
    
    Specified by:
    
    getRoles in interface com.appiancorp.security.auth.SecurityContext
  - isSysAdmin
```
public boolean isSysAdmin()
```
    Specified by:
    
    isSysAdmin in interface com.appiancorp.security.auth.SecurityContext
  - getGrantorName
```
public java.lang.String getGrantorName()
```
    Specified by:
    
    getGrantorName in interface com.appiancorp.security.auth.SecurityContext
  - getGrantorRoles
```
public java.util.Set<java.lang.String> getGrantorRoles()
```
    Specified by:
    
    getGrantorRoles in interface com.appiancorp.security.auth.SecurityContext
  - isAuthenticatedByAppianInternalProvider
```
public boolean isAuthenticatedByAppianInternalProvider()
```
    Specified by:
    
    isAuthenticatedByAppianInternalProvider in interface com.appiancorp.security.auth.SecurityContext
    
    Returns:
    
    true if Appian's internal authentication provider authenticated the user. If multiple authentication providers are chained, this will return true if Appian's internal provider was reached and successfully authenticated the user, regardless of the response of other providers.
  - setAuthenticatedByAppianInternalProvider
```
public void setAuthenticatedByAppianInternalProvider(boolean value)
```
    This is meant to be set only by the internal Appian authentication provider.
  - isLoggedInThroughSaml
```
public boolean isLoggedInThroughSaml()
```
    Specified by:
    
    isLoggedInThroughSaml in interface com.appiancorp.security.auth.SecurityContext
    
    Returns:
    
    true if Appian's internal SAML authentication provider authenticated the user. If multiple authentication providers are chained, this will return true if Appian's internal provider was reached and successfully authenticated the user, regardless of the response of other providers.
  - setLoggedInThroughSaml
```
public void setLoggedInThroughSaml(boolean loggedInThroughSaml)
```
    This is meant to be set only by the internal Appian authentication provider.
  - getAppianLoginContext
```
public com.appiancorp.security.auth.AppianLoginContext getAppianLoginContext()
```
    Returns SSO specific login context that is used internally.
    
    Specified by:
    
    getAppianLoginContext in interface com.appiancorp.security.auth.SecurityContext
  - setAppianLoginContext
```
public void setAppianLoginContext(com.appiancorp.security.auth.AppianLoginContext appianLoginContext)
```
    This is meant to be set only by the internal Appian authentication provider.
  - getEncryptedSamlAssertion
```
public java.lang.String getEncryptedSamlAssertion()
```
    Holds encrypted saml assertion used to authenticate user when they logged in via saml. It is empty by default and will be cleared by OAuthSamlAuthGrantLoginSuccessListener once it has been consumed.
    
    Returns:
    
    encrypted saml assertion or empty string if not set
  - setEncryptedSamlAssertion
```
public void setEncryptedSamlAssertion(java.lang.String encryptedAssertion)
```
    This is meant to be set only by the SamlAuthenticationWrapper. Used by OAuth Saml based Auth type Http Connected Systems. If null input is provided it will normalized to an empty string.
    
    Parameters:
    
    encryptedAssertion -
  - clearEncryptedSamlAssertion
```
public void clearEncryptedSamlAssertion()
```
    Clear cached saml assertion once we are done consuming it. We should not hold on it for longer than required period.
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface java.security.Principal
    
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Returns the hash code of the username.
    
    Specified by:
    
    hashCode in interface java.security.Principal
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Returns true if the given object is an instance of AppianUserDetails and has the same username as this object.
    
    Specified by:
    
    equals in interface java.security.Principal
    
    Overrides:
    
    equals in class java.lang.Object

Class AppianUserDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.security.Principal

Constructor Detail

AppianUserDetails

AppianUserDetails

AppianUserDetails

Method Detail

getUserProfile

getUserUuid

setOverrideLocale

getOverrideLocale

setIsAdsSuperUser

isAdsSuperUser

getPasswordStatus

setPasswordStatus

getScsKey

setScsKey

hashAndSetScsKey

getUsername

getPassword

isAccountNonExpired

isAccountNonLocked

isCredentialsNonExpired

isEnabled

getAuthorities

setAuthorities

getName

getUserRef

isUserRefNull

getMemberGroupUuids

getMemberGroupRefs

getRoles

isSysAdmin

getGrantorName

getGrantorRoles

isAuthenticatedByAppianInternalProvider

setAuthenticatedByAppianInternalProvider

isLoggedInThroughSaml

setLoggedInThroughSaml

getAppianLoginContext

setAppianLoginContext

getEncryptedSamlAssertion

setEncryptedSamlAssertion

clearEncryptedSamlAssertion

toString

hashCode

equals