UserImpl (Graylog 3.1.2 API)

java.lang.Object
- org.graylog2.database.PersistedImpl
- - org.graylog2.users.UserImpl

All Implemented Interfaces:

Persisted, User

Direct Known Subclasses:

UserImpl.LocalAdminUser
```
public class UserImpl
extends PersistedImpl
implements User
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserImpl.Factory

static class UserImpl.LocalAdminUser

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserImpl.Factory`
`static class`	`UserImpl.LocalAdminUser`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COLLECTION_NAME`
`static String`	`EMAIL`
`static String`	`EXTERNAL_USER`
`static String`	`FULL_NAME`
`static int`	`MAX_EMAIL_LENGTH`
`static int`	`MAX_FULL_NAME_LENGTH`
`static int`	`MAX_USERNAME_LENGTH`
`static String`	`PASSWORD`
`static String`	`PERMISSIONS`
`static String`	`PREFERENCES`
`static String`	`ROLES`
`static String`	`SESSION_TIMEOUT`
`static String`	`STARTPAGE`
`static String`	`TIMEZONE`
`static String`	`USERNAME`

Fields inherited from class org.graylog2.database.PersistedImpl
fields, id

Constructor Summary

Constructors
Modifier	Constructor and Description
	`UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory, Permissions permissions, Map<String,Object> fields)`
`protected`	`UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory, Permissions permissions, org.bson.types.ObjectId id, Map<String,Object> fields)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getEmail()` Returns the email address of the user.
`Map<String,Validator>`	`getEmbeddedValidations(String key)`
`String`	`getFullName()`
`String`	`getHashedPassword()`
`String`	`getName()`
`List<String>`	`getPermissions()`
`Map<String,Object>`	`getPreferences()`
`Set<String>`	`getRoleIds()`
`long`	`getSessionTimeoutMs()`
`Startpage`	`getStartpage()`
`org.joda.time.DateTimeZone`	`getTimeZone()`
`Map<String,Validator>`	`getValidations()`
`boolean`	`isExternalUser()`
`boolean`	`isLocalAdmin()`
`boolean`	`isReadOnly()`
`boolean`	`isUserPassword(String password)`
`void`	`setEmail(String email)`
`void`	`setExternal(boolean external)`
`void`	`setFullName(String fullname)`
`void`	`setHashedPassword(String hashedPassword)`
`void`	`setName(String username)`
`void`	`setPassword(String password)`
`void`	`setPermissions(List<String> permissions)`
`void`	`setPreferences(Map<String,Object> preferences)`
`void`	`setRoleIds(Set<String> roles)`
`void`	`setSessionTimeoutMs(long timeoutValue)`
`void`	`setStartpage(Startpage startpage)`
`void`	`setStartpage(String type, String id)`
`void`	`setTimeZone(org.joda.time.DateTimeZone timeZone)`
`void`	`setTimeZone(String timeZone)`

Methods inherited from class org.graylog2.database.PersistedImpl
asMap, equals, getFields, getId, getObjectId, hashCode, toString

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

Methods inherited from interface org.graylog2.plugin.database.Persisted
asMap, getFields, getId

- Field Detail
  - COLLECTION_NAME
```
public static final String COLLECTION_NAME
```
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final String USERNAME
```
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    See Also:
    
    Constant Field Values
  - EMAIL
```
public static final String EMAIL
```
    See Also:
    
    Constant Field Values
  - FULL_NAME
```
public static final String FULL_NAME
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS
```
public static final String PERMISSIONS
```
    See Also:
    
    Constant Field Values
  - PREFERENCES
```
public static final String PREFERENCES
```
    See Also:
    
    Constant Field Values
  - TIMEZONE
```
public static final String TIMEZONE
```
    See Also:
    
    Constant Field Values
  - EXTERNAL_USER
```
public static final String EXTERNAL_USER
```
    See Also:
    
    Constant Field Values
  - SESSION_TIMEOUT
```
public static final String SESSION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - STARTPAGE
```
public static final String STARTPAGE
```
    See Also:
    
    Constant Field Values
  - ROLES
```
public static final String ROLES
```
    See Also:
    
    Constant Field Values
  - MAX_USERNAME_LENGTH
```
public static final int MAX_USERNAME_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_EMAIL_LENGTH
```
public static final int MAX_EMAIL_LENGTH
```
    See Also:
    
    Constant Field Values
  - MAX_FULL_NAME_LENGTH
```
public static final int MAX_FULL_NAME_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserImpl
```
public UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory,
                Permissions permissions,
                Map<String,Object> fields)
```
  - UserImpl
```
protected UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory,
                   Permissions permissions,
                   org.bson.types.ObjectId id,
                   Map<String,Object> fields)
```
- Method Detail
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface User
  - getValidations
```
public Map<String,Validator> getValidations()
```
    Specified by:
    
    getValidations in interface Persisted
  - getEmbeddedValidations
```
public Map<String,Validator> getEmbeddedValidations(String key)
```
    Specified by:
    
    getEmbeddedValidations in interface Persisted
  - getFullName
```
public String getFullName()
```
    Specified by:
    
    getFullName in interface User
  - setFullName
```
public void setFullName(String fullname)
```
    Specified by:
    
    setFullName in interface User
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface User
  - setName
```
public void setName(String username)
```
    Specified by:
    
    setName in interface User
  - getEmail
```
public String getEmail()
```
    Description copied from interface: User
    
    Returns the email address of the user. Depending on how the user has been created, it is possible that the returned string contains multiple email addresses separated by a "," character. (i.e. LDAP users)
    
    Specified by:
    
    getEmail in interface User
    
    Returns:
    
    the email address
  - setEmail
```
public void setEmail(String email)
```
    Specified by:
    
    setEmail in interface User
  - getPermissions
```
public List<String> getPermissions()
```
    Specified by:
    
    getPermissions in interface User
  - setPermissions
```
public void setPermissions(List<String> permissions)
```
    Specified by:
    
    setPermissions in interface User
  - getPreferences
```
public Map<String,Object> getPreferences()
```
    Specified by:
    
    getPreferences in interface User
  - setPreferences
```
public void setPreferences(Map<String,Object> preferences)
```
    Specified by:
    
    setPreferences in interface User
  - getStartpage
```
public Startpage getStartpage()
```
    Specified by:
    
    getStartpage in interface User
  - getSessionTimeoutMs
```
public long getSessionTimeoutMs()
```
    Specified by:
    
    getSessionTimeoutMs in interface User
  - setSessionTimeoutMs
```
public void setSessionTimeoutMs(long timeoutValue)
```
    Specified by:
    
    setSessionTimeoutMs in interface User
  - getHashedPassword
```
public String getHashedPassword()
```
    Specified by:
    
    getHashedPassword in interface User
  - setHashedPassword
```
public void setHashedPassword(String hashedPassword)
```
  - setPassword
```
public void setPassword(String password)
```
    Specified by:
    
    setPassword in interface User
  - isUserPassword
```
public boolean isUserPassword(String password)
```
    Specified by:
    
    isUserPassword in interface User
  - getTimeZone
```
public org.joda.time.DateTimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface User
  - setTimeZone
```
public void setTimeZone(String timeZone)
```
    Specified by:
    
    setTimeZone in interface User
  - setTimeZone
```
public void setTimeZone(org.joda.time.DateTimeZone timeZone)
```
    Specified by:
    
    setTimeZone in interface User
  - isExternalUser
```
public boolean isExternalUser()
```
    Specified by:
    
    isExternalUser in interface User
  - setExternal
```
public void setExternal(boolean external)
```
    Specified by:
    
    setExternal in interface User
  - isLocalAdmin
```
public boolean isLocalAdmin()
```
    Specified by:
    
    isLocalAdmin in interface User
  - getRoleIds
```
@Nonnull
public Set<String> getRoleIds()
```
    Specified by:
    
    getRoleIds in interface User
  - setRoleIds
```
public void setRoleIds(Set<String> roles)
```
    Specified by:
    
    setRoleIds in interface User
  - setStartpage
```
public void setStartpage(String type,
                         String id)
```
    Specified by:
    
    setStartpage in interface User
  - setStartpage
```
public void setStartpage(Startpage startpage)
```
    Specified by:
    
    setStartpage in interface User

Class UserImpl

Nested Class Summary

Field Summary

Fields inherited from class org.graylog2.database.PersistedImpl

Constructor Summary

Method Summary

Methods inherited from class org.graylog2.database.PersistedImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.graylog2.plugin.database.Persisted

Field Detail

COLLECTION_NAME

USERNAME

PASSWORD

EMAIL

FULL_NAME

PERMISSIONS

PREFERENCES

TIMEZONE

EXTERNAL_USER

SESSION_TIMEOUT

STARTPAGE

ROLES

MAX_USERNAME_LENGTH

MAX_EMAIL_LENGTH

MAX_FULL_NAME_LENGTH

Constructor Detail

UserImpl

UserImpl

Method Detail

isReadOnly

getValidations

getEmbeddedValidations

getFullName

setFullName

getName

setName

getEmail

setEmail

getPermissions

setPermissions

getPreferences

setPreferences

getStartpage

getSessionTimeoutMs

setSessionTimeoutMs

getHashedPassword

setHashedPassword

setPassword

isUserPassword

getTimeZone

setTimeZone

setTimeZone

isExternalUser

setExternal

isLocalAdmin

getRoleIds

setRoleIds

setStartpage

setStartpage