BasicUser (Application Security Blocks 2.1 API)

java.lang.Object
- org.genesys.blocks.model.EmptyModel
- - org.genesys.blocks.model.BasicModel
  - - org.genesys.blocks.model.VersionedModel
    - - org.genesys.blocks.model.AuditedVersionedModel
      - org.genesys.blocks.security.model.AclSid
        
        org.genesys.blocks.security.model.BasicUser<R>

Type Parameters:

R - the generic type

All Implemented Interfaces:

Serializable, Activatable, EntityId, org.springframework.data.domain.Persistable<Long>, org.springframework.security.core.userdetails.UserDetails
```
@MappedSuperclass
public abstract class BasicUser<R extends org.springframework.security.core.GrantedAuthority>
extends AclSid
implements org.springframework.security.core.userdetails.UserDetails
```
The Class BasicUser. When you extend this class, make sure you use:
```
@DiscriminatorValue(value = "1")
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BasicUser.AccountType
The Enum AccountType.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BasicUser.AccountType` The Enum AccountType.

Field Summary
- Fields inherited from class org.genesys.blocks.model.VersionedModel
  active

Constructor Summary

Constructors
Constructor and Description

BasicUser()
Instantiates a new basic user.

Constructors
Constructor and Description
`BasicUser()` Instantiates a new basic user.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Date`	`getAccountExpires()` Gets the account expires.
`BasicUser.AccountType`	`getAccountType()` Gets the account type.
`Collection<? extends org.springframework.security.core.GrantedAuthority>`	`getAuthorities()`
`String`	`getEmail()` Gets the email.
`String`	`getFullName()` Gets the full name.
`Date`	`getLastLogin()` Gets the last login.
`Date`	`getLockedUntil()` Gets the locked until.
`String`	`getPassword()`
`Date`	`getPasswordExpires()` Gets the password expires.
`Set<R>`	`getRoles()` Gets the roles.
`String`	`getShortName()` Gets the short name.
`String`	`getUsername()` `getUsername()` must return the name used by UserDetailService in the `UserDetailsService.loadUserByUsername(String)`
`String`	`getUuid()` Gets the uuid.
`boolean`	`isAccountLocked()` Checks if is account locked.
`boolean`	`isAccountNonExpired()`
`boolean`	`isAccountNonLocked()`
`boolean`	`isCredentialsNonExpired()`
`boolean`	`isEnabled()`
`void`	`setAccountExpires(Date accountExpires)` Sets the account expires.
`void`	`setAccountType(BasicUser.AccountType accountType)` Sets the account type.
`void`	`setEmail(String email)` Sets the email.
`void`	`setFullName(String fullName)` Sets the full name.
`void`	`setLastLogin(Date lastLogin)` Sets the last login.
`void`	`setLockedUntil(Date lockedUntil)` Sets the locked until.
`void`	`setPassword(String password)` Sets the password.
`void`	`setPasswordExpires(Date passwordExpires)` Sets the password expires.
`void`	`setRoles(Set<R> roles)` Sets the roles.
`void`	`setRuntimeAuthorities(Set<String> authorities)` Set additional authorities at runtime.
`void`	`setShortName(String shortName)` Sets the short name.
`void`	`setUuid(String uuid)` Sets the uuid.
`String`	`toString()`

Methods inherited from class org.genesys.blocks.security.model.AclSid
getAclEntries, getObjectIdentities, getSid, isPrincipal, setAclEntries, setObjectIdentities, setPrincipal, setSid

Methods inherited from class org.genesys.blocks.model.AuditedVersionedModel
getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, setCreatedBy, setCreatedDate, setLastModifiedBy, setLastModifiedDate

Methods inherited from class org.genesys.blocks.model.VersionedModel
equals, getVersion, hashCode, isActive, setActive, setVersion

Methods inherited from class org.genesys.blocks.model.BasicModel
getId, isNew, setId

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

- Constructor Detail
  - BasicUser
```
public BasicUser()
```
    Instantiates a new basic user.
- Method Detail
  - getEmail
```
public String getEmail()
```
    Gets the email.
    
    Returns:
    
    the email
  - setEmail
```
public void setEmail(String email)
```
    Sets the email.
    
    Parameters:
    
    email - the new email
  - getShortName
```
public String getShortName()
```
    Gets the short name.
    
    Returns:
    
    the short name
  - setShortName
```
public void setShortName(String shortName)
```
    Sets the short name.
    
    Parameters:
    
    shortName - the new short name
  - getFullName
```
public String getFullName()
```
    Gets the full name.
    
    Overrides:
    
    getFullName in class AclSid
    
    Returns:
    
    the full name
  - setFullName
```
public void setFullName(String fullName)
```
    Sets the full name.
    
    Parameters:
    
    fullName - the new full name
  - getAccountExpires
```
public Date getAccountExpires()
```
    Gets the account expires.
    
    Returns:
    
    the account expires
  - setAccountExpires
```
public void setAccountExpires(Date accountExpires)
```
    Sets the account expires.
    
    Parameters:
    
    accountExpires - the new account expires
  - getLockedUntil
```
public Date getLockedUntil()
```
    Gets the locked until.
    
    Returns:
    
    the locked until
  - setLockedUntil
```
public void setLockedUntil(Date lockedUntil)
```
    Sets the locked until.
    
    Parameters:
    
    lockedUntil - the new locked until
  - getPasswordExpires
```
public Date getPasswordExpires()
```
    Gets the password expires.
    
    Returns:
    
    the password expires
  - setPasswordExpires
```
public void setPasswordExpires(Date passwordExpires)
```
    Sets the password expires.
    
    Parameters:
    
    passwordExpires - the new password expires
  - setPassword
```
public void setPassword(String password)
```
    Sets the password.
    
    Parameters:
    
    password - the new password
  - getRoles
```
public Set<R> getRoles()
```
    Gets the roles.
    
    Returns:
    
    the roles
  - setRoles
```
public void setRoles(Set<R> roles)
```
    Sets the roles.
    
    Parameters:
    
    roles - the new roles
  - getUuid
```
public String getUuid()
```
    Gets the uuid.
    
    Returns:
    
    the uuid
  - setUuid
```
public void setUuid(String uuid)
```
    Sets the uuid.
    
    Parameters:
    
    uuid - the new uuid
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VersionedModel
  - getAuthorities
```
public Collection<? extends org.springframework.security.core.GrantedAuthority> getAuthorities()
```
    Specified by:
    
    getAuthorities in interface org.springframework.security.core.userdetails.UserDetails
  - getPassword
```
public String getPassword()
```
    Specified by:
    
    getPassword in interface org.springframework.security.core.userdetails.UserDetails
  - getUsername
```
public String getUsername()
```
    getUsername() must return the name used by UserDetailService in the UserDetailsService.loadUserByUsername(String)
    
    Specified by:
    
    getUsername in interface org.springframework.security.core.userdetails.UserDetails
    
    See Also:
    
    UserDetails.getUsername()
  - 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
  - isAccountLocked
```
public boolean isAccountLocked()
```
    Checks if is account locked.
    
    Returns:
    
    true, if is account locked
  - 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
  - getAccountType
```
public BasicUser.AccountType getAccountType()
```
    Gets the account type.
    
    Returns:
    
    the account type
  - setAccountType
```
public void setAccountType(BasicUser.AccountType accountType)
```
    Sets the account type.
    
    Parameters:
    
    accountType - the new account type
  - getLastLogin
```
public Date getLastLogin()
```
    Gets the last login.
    
    Returns:
    
    the last login
  - setLastLogin
```
public void setLastLogin(Date lastLogin)
```
    Sets the last login.
    
    Parameters:
    
    lastLogin - the new last login
  - setRuntimeAuthorities
```
public void setRuntimeAuthorities(Set<String> authorities)
```
    Set additional authorities at runtime.
    
    Parameters:
    
    authorities - the new runtime authorities

Class BasicUser<R extends org.springframework.security.core.GrantedAuthority>

Nested Class Summary

Field Summary

Fields inherited from class org.genesys.blocks.model.VersionedModel

Constructor Summary

Method Summary

Methods inherited from class org.genesys.blocks.security.model.AclSid

Methods inherited from class org.genesys.blocks.model.AuditedVersionedModel

Methods inherited from class org.genesys.blocks.model.VersionedModel

Methods inherited from class org.genesys.blocks.model.BasicModel

Methods inherited from class java.lang.Object

Constructor Detail

BasicUser

Method Detail

getEmail

setEmail

getShortName

setShortName

getFullName

setFullName

getAccountExpires

setAccountExpires

getLockedUntil

setLockedUntil

getPasswordExpires

setPasswordExpires

setPassword

getRoles

setRoles

getUuid

setUuid

toString

getAuthorities

getPassword

getUsername

isAccountNonExpired

isAccountNonLocked

isAccountLocked

isCredentialsNonExpired

isEnabled

getAccountType

setAccountType

getLastLogin

setLastLogin

setRuntimeAuthorities