UserEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.entities.UserEntity

@Entity
public class UserEntity
extends Object

Constructor Summary

Constructors
Constructor and Description

UserEntity()

Constructors
Constructor and Description
`UserEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getActive()`
`String`	`getActiveWidgetLayouts()`
`List<UserAuthenticationEntity>`	`getAuthenticationEntities()`
`Integer`	`getConsecutiveFailures()` Returns the number of consecutive authentication failures since the last successful login.
`long`	`getCreateTime()`
`String`	`getDisplayName()` Returns the display name for this user.
`String`	`getLocalUsername()` Gets the local username for this user.
`Set<MemberEntity>`	`getMemberEntities()`
`PrincipalEntity`	`getPrincipal()` Get the admin principal entity.
`Integer`	`getUserId()`
`String`	`getUserName()`
`Long`	`getVersion()` Returns the version number of the relevant data stored in the database.
`int`	`hashCode()`
`void`	`incrementConsecutiveFailures()` Increments the number of consecutive authentication failures since the last successful login.
`protected void`	`onCreate()` Ensure the create time is set properly when the record is created.
`void`	`setActive(Boolean active)`
`void`	`setActiveWidgetLayouts(String activeWidgetLayouts)`
`void`	`setAuthenticationEntities(List<UserAuthenticationEntity> authenticationEntities)`
`void`	`setConsecutiveFailures(Integer consecutiveFailures)` Sets the number of consecutive authentication failures since the last successful login.
`void`	`setCreateTime(long createTime)`
`void`	`setDisplayName(String displayName)` Sets the display name for this user.
`void`	`setLocalUsername(String localUsername)` Sets the local username for this user.
`void`	`setMemberEntities(Set<MemberEntity> memberEntities)`
`void`	`setPrincipal(PrincipalEntity principal)` Set the admin principal entity.
`void`	`setUserId(Integer userId)`
`void`	`setUserName(String userName)`
`void`	`setVersion(Long version)` Sets the version number of the relevant data stored in the database.

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

- Constructor Detail
  - UserEntity
```
public UserEntity()
```
- Method Detail
  - getUserId
```
public Integer getUserId()
```
  - setUserId
```
public void setUserId(Integer userId)
```
  - getUserName
```
public String getUserName()
```
  - setUserName
```
public void setUserName(String userName)
```
  - getConsecutiveFailures
```
public Integer getConsecutiveFailures()
```
    Returns the number of consecutive authentication failures since the last successful login.
    This value may be used to throttle authentication attempts or lock out users. It is expected that this value is reset to 0 when a successful authentication attempt was made.
    
    Returns:
    
    the number of consecutive authentication failures since the last successful login
  - setConsecutiveFailures
```
public void setConsecutiveFailures(Integer consecutiveFailures)
```
    Sets the number of consecutive authentication failures since the last successful login.
    This value may be used to throttle authentication attempts or lock out users. It is expected that this value is reset to 0 when a successful authentication attempt was made.
    For each failed authentication attempt, incrementConsecutiveFailures() should be called rather than explicitly setting an incremented value.
    
    Parameters:
    
    consecutiveFailures - a number of consecutive authentication failures since the last successful login
  - incrementConsecutiveFailures
```
public void incrementConsecutiveFailures()
```
    Increments the number of consecutive authentication failures since the last successful login.
    This value may be used to throttle authentication attempts or lock out users. It is expected that this value is reset to 0 when a successful authentication attempt was made.
    TODO: Ensure that this value is consistent when updating concurrently
  - getDisplayName
```
public String getDisplayName()
```
    Returns the display name for this user.
    This value may be used in user interfaces rather than the username to show who it logged in. If empty, it is expected that the user's userName value would be used instead.
    
    Returns:
    
    the user's display name
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the display name for this user.
    This value may be used in user interfaces rather than the username to show who it logged in. If empty, it is expected that the user's userName value would be used instead.
    
    Parameters:
    
    displayName - the user's display name
  - getLocalUsername
```
public String getLocalUsername()
```
    Gets the local username for this user.
    This value is intended to be used when accessing services via Ambari Views. If empty, it is expected that the user's userName value would be used instead.
    
    Returns:
    
    the user's local username
  - setLocalUsername
```
public void setLocalUsername(String localUsername)
```
    Sets the local username for this user.
    This value is intended to be used when accessing services via Ambari Views. If empty, it is expected that the user's userName value would be used instead.
    
    Parameters:
    
    localUsername - the user's local username
  - getCreateTime
```
public long getCreateTime()
```
  - setCreateTime
```
public void setCreateTime(long createTime)
```
  - getVersion
```
public Long getVersion()
```
    Returns the version number of the relevant data stored in the database.
    This is used to help ensure that collisions updatin the relevant data in the database are handled properly via Optimistic locking.
    
    Returns:
    
    a version number
  - setVersion
```
public void setVersion(Long version)
```
    Sets the version number of the relevant data stored in the database.
    This is used to help ensure that collisions updatin the relevant data in the database are handled properly via Optimistic locking. It is recommended that this value is not manually updated, else issues may occur when persisting the data.
    
    Parameters:
    
    version - a version number
  - getMemberEntities
```
public Set<MemberEntity> getMemberEntities()
```
  - setMemberEntities
```
public void setMemberEntities(Set<MemberEntity> memberEntities)
```
  - getActive
```
public Boolean getActive()
```
  - setActive
```
public void setActive(Boolean active)
```
  - getPrincipal
```
public PrincipalEntity getPrincipal()
```
    Get the admin principal entity.
    
    Returns:
    
    the principal entity
  - setPrincipal
```
public void setPrincipal(PrincipalEntity principal)
```
    Set the admin principal entity.
    
    Parameters:
    
    principal - the principal entity
  - getActiveWidgetLayouts
```
public String getActiveWidgetLayouts()
```
  - setActiveWidgetLayouts
```
public void setActiveWidgetLayouts(String activeWidgetLayouts)
```
  - getAuthenticationEntities
```
public List<UserAuthenticationEntity> getAuthenticationEntities()
```
  - setAuthenticationEntities
```
public void setAuthenticationEntities(List<UserAuthenticationEntity> authenticationEntities)
```
  - onCreate
```
protected void onCreate()
```
    Ensure the create time is set properly when the record is created.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class UserEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserEntity

Method Detail

getUserId

setUserId

getUserName

setUserName

getConsecutiveFailures

setConsecutiveFailures

incrementConsecutiveFailures

getDisplayName

setDisplayName

getLocalUsername

setLocalUsername

getCreateTime

setCreateTime

getVersion

setVersion

getMemberEntities

setMemberEntities

getActive

setActive

getPrincipal

setPrincipal

getActiveWidgetLayouts

setActiveWidgetLayouts

getAuthenticationEntities

setAuthenticationEntities

onCreate

equals

hashCode