CoinUser (OpenConext : selfservice 5.0.1 API)

java.lang.Object
- selfservice.domain.CoinUser

All Implemented Interfaces:

Serializable, org.springframework.security.core.userdetails.UserDetails
```
public class CoinUser
extends Object
implements org.springframework.security.core.userdetails.UserDetails
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CoinUser()

Constructors
Constructor and Description
`CoinUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(String key, List<String> value)`
`void`	`addAuthority(CoinAuthority grantedAuthority)`
`void`	`addInstitutionIdp(IdentityProvider idp)`
`Map<String,List<String>>`	`getAttributeMap()` Map of user attributes, key as String, value Object
`Collection<? extends org.springframework.security.core.GrantedAuthority>`	`getAuthorities()` Returns a collection that will contain `CoinAuthority`'s
`List<CoinAuthority.Authority>`	`getAuthorityEnums()`
`Optional<IdentityProvider>`	`getByEntityId(String entityId)`
`String`	`getDisplayName()` Display name, e.g.
`String`	`getEmail()`
`IdentityProvider`	`getIdp()` Identifier of the IdentityProvider the user has logged in with
`String`	`getInstitutionId()` Identifier of the institution the IdentityProvider of the user belongs to.
`List<IdentityProvider>`	`getInstitutionIdps()` List of `InstitutionIdentityProvider`'s of the institution for this users.
`String`	`getPassword()` It is not allowed to call this method
`String`	`getSchacHomeOrganization()`
`IdentityProvider`	`getSwitchedToIdp()`
`String`	`getUid()` Unique identifier of the user, e.g.
`String`	`getUsername()` Same value as `getUid()`
`boolean`	`hasAuthority(CoinAuthority grantedAuthority)`
`boolean`	`isAccountNonExpired()`
`boolean`	`isAccountNonLocked()`
`boolean`	`isCredentialsNonExpired()`
`boolean`	`isDashboardAdmin()`
`boolean`	`isDashboardViewer()`
`boolean`	`isEnabled()`
`boolean`	`isSuperUser()`
`void`	`removeAuthority(CoinAuthority grantedAuthority)`
`void`	`setAttributeMap(Map<String,List<String>> attributeMap)`
`void`	`setAuthorities(Set<CoinAuthority> grantedAuthorities)`
`void`	`setDisplayName(String displayName)`
`void`	`setEmail(String email)`
`void`	`setIdp(IdentityProvider idp)`
`void`	`setInstitutionId(String institutionId)`
`void`	`setSchacHomeOrganization(String schacHomeOrganization)`
`void`	`setSwitchedToIdp(IdentityProvider switchedToIdp)`
`void`	`setUid(String uid)`
`String`	`toString()`

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

- Constructor Detail
  - CoinUser
```
public CoinUser()
```
- Method Detail
  - getPassword
```
public String getPassword()
```
    It is not allowed to call this method
    
    Specified by:
    
    getPassword in interface org.springframework.security.core.userdetails.UserDetails
  - getUsername
```
public String getUsername()
```
    Same value as getUid()
    
    Specified by:
    
    getUsername in interface org.springframework.security.core.userdetails.UserDetails
  - isAccountNonExpired
```
public boolean isAccountNonExpired()
```
    Specified by:
    
    isAccountNonExpired in interface org.springframework.security.core.userdetails.UserDetails
  - isAccountNonLocked
```
public boolean isAccountNonLocked()
```
    Specified by:
    
    isAccountNonLocked in interface org.springframework.security.core.userdetails.UserDetails
  - isCredentialsNonExpired
```
public boolean isCredentialsNonExpired()
```
    Specified by:
    
    isCredentialsNonExpired in interface org.springframework.security.core.userdetails.UserDetails
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface org.springframework.security.core.userdetails.UserDetails
  - isSuperUser
```
public boolean isSuperUser()
```
  - isDashboardAdmin
```
public boolean isDashboardAdmin()
```
  - isDashboardViewer
```
public boolean isDashboardViewer()
```
  - getUid
```
public String getUid()
```
    Unique identifier of the user, e.g. urn:collab:person:org.example:john.doe
    
    Returns:
    
    unique identifier of the user
  - setUid
```
public void setUid(String uid)
```
  - getDisplayName
```
public String getDisplayName()
```
    Display name, e.g. 'John S. Doe Jr'
    
    Returns:
    
    display name of the user
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - getSchacHomeOrganization
```
public String getSchacHomeOrganization()
```
    Returns:
    
    schac home organization of the user
  - setSchacHomeOrganization
```
public void setSchacHomeOrganization(String schacHomeOrganization)
```
  - getEmail
```
public String getEmail()
```
    Returns:
    
    email address of the user
  - setEmail
```
public void setEmail(String email)
```
  - getAuthorities
```
public Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()
```
    Returns a collection that will contain CoinAuthority's
    
    Specified by:
    
    getAuthorities in interface org.springframework.security.core.userdetails.UserDetails
  - setAuthorities
```
public void setAuthorities(Set<CoinAuthority> grantedAuthorities)
```
  - addAuthority
```
public void addAuthority(CoinAuthority grantedAuthority)
```
  - removeAuthority
```
public void removeAuthority(CoinAuthority grantedAuthority)
```
  - hasAuthority
```
public boolean hasAuthority(CoinAuthority grantedAuthority)
```
  - getInstitutionIdps
```
public List<IdentityProvider> getInstitutionIdps()
```
    List of InstitutionIdentityProvider's of the institution for this users. Usually contains only the IdP the user logs in with.
    
    Returns:
    
    List of InstitutionIdentityProvider's
  - addInstitutionIdp
```
public void addInstitutionIdp(IdentityProvider idp)
```
  - getInstitutionId
```
public String getInstitutionId()
```
    Identifier of the institution the IdentityProvider of the user belongs to. Can be empty.
    
    Returns:
    
    Identifier of the institution the IdentityProvider of the user belongs to
  - setInstitutionId
```
public void setInstitutionId(String institutionId)
```
  - getIdp
```
public IdentityProvider getIdp()
```
    Identifier of the IdentityProvider the user has logged in with
    
    Returns:
    
    Identifier of the IdentityProvider the user has logged in with
  - setIdp
```
public void setIdp(IdentityProvider idp)
```
  - getSwitchedToIdp
```
public IdentityProvider getSwitchedToIdp()
```
  - setSwitchedToIdp
```
public void setSwitchedToIdp(IdentityProvider switchedToIdp)
```
  - getAttributeMap
```
public Map<String,List<String>> getAttributeMap()
```
    Map of user attributes, key as String, value Object
    
    Returns:
    
    Map of user attributes
  - setAttributeMap
```
public void setAttributeMap(Map<String,List<String>> attributeMap)
```
  - addAttribute
```
public void addAttribute(String key,
                         List<String> value)
```
  - getAuthorityEnums
```
public List<CoinAuthority.Authority> getAuthorityEnums()
```
  - getByEntityId
```
public Optional<IdentityProvider> getByEntityId(String entityId)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CoinUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoinUser

Method Detail

getPassword

getUsername

isAccountNonExpired

isAccountNonLocked

isCredentialsNonExpired

isEnabled

isSuperUser

isDashboardAdmin

isDashboardViewer

getUid

setUid

getDisplayName

setDisplayName

getSchacHomeOrganization

setSchacHomeOrganization

getEmail

setEmail

getAuthorities

setAuthorities

addAuthority

removeAuthority

hasAuthority

getInstitutionIdps

addInstitutionIdp

getInstitutionId

setInstitutionId

getIdp

setIdp

getSwitchedToIdp

setSwitchedToIdp

getAttributeMap

setAttributeMap

addAttribute

getAuthorityEnums

getByEntityId

toString