User (Graylog 2.2.1 API)

All Superinterfaces:

Persisted

All Known Implementing Classes:

UserImpl, UserImpl.LocalAdminUser
```
public interface User
extends Persisted
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getEmail()` Returns the email address of the user.
`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()`
`boolean`	`isExternalUser()`
`boolean`	`isLocalAdmin()`
`boolean`	`isReadOnly()`
`boolean`	`isUserPassword(String password)`
`void`	`setEmail(String email)`
`void`	`setExternal(boolean external)`
`void`	`setFullName(String fullname)`
`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 interface org.graylog2.plugin.database.Persisted
asMap, getEmbeddedValidations, getFields, getId, getValidations

Method Detail

isReadOnly
```
boolean isReadOnly()
```

getFullName
```
String getFullName()
```

getName
```
String getName()
```

setName
```
void setName(String username)
```

getEmail
```
String getEmail()
```
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)

Returns:

the email address

getPermissions
```
List<String> getPermissions()
```

getPreferences
```
Map<String,Object> getPreferences()
```

getStartpage
```
Startpage getStartpage()
```

getSessionTimeoutMs
```
long getSessionTimeoutMs()
```

setSessionTimeoutMs

void setSessionTimeoutMs(long timeoutValue)

setPermissions

void setPermissions(List<String> permissions)

setPreferences

void setPreferences(Map<String,Object> preferences)

setEmail
```
void setEmail(String email)
```

setFullName
```
void setFullName(String fullname)
```

getHashedPassword
```
String getHashedPassword()
```

setPassword
```
void setPassword(String password)
```

isUserPassword

boolean isUserPassword(String password)

getTimeZone

org.joda.time.DateTimeZone getTimeZone()

setTimeZone

void setTimeZone(org.joda.time.DateTimeZone timeZone)

setTimeZone
```
void setTimeZone(String timeZone)
```

isExternalUser
```
boolean isExternalUser()
```

setExternal
```
void setExternal(boolean external)
```

setStartpage

void setStartpage(String type,
                  String id)

setStartpage

void setStartpage(Startpage startpage)

isLocalAdmin
```
boolean isLocalAdmin()
```

getRoleIds
```
@Nonnull
Set<String> getRoleIds()
```

setRoleIds
```
void setRoleIds(Set<String> roles)
```

Interface User

Method Summary

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

Method Detail

isReadOnly

getFullName

getName

setName

getEmail

getPermissions

getPreferences

getStartpage

getSessionTimeoutMs

setSessionTimeoutMs

setPermissions

setPreferences

setEmail

setFullName

getHashedPassword

setPassword

isUserPassword

getTimeZone

setTimeZone

setTimeZone

isExternalUser

setExternal

setStartpage

setStartpage

isLocalAdmin

getRoleIds

setRoleIds