org.graylog2.plugin.database.users

Interface User

All Superinterfaces:

Persisted

All Known Implementing Classes:

UserImpl, UserImpl.LocalAdminUser

public interface User
extends Persisted

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	User.AccountStatus

Method Summary

Modifier and Type	Method and Description
User.AccountStatus	getAccountStatus()
String	getAuthServiceId()
String	getAuthServiceUid()
String	getEmail() Returns the email address of the user.
String	getFullName()
String	getHashedPassword()
String	getName()
Set<org.apache.shiro.authz.Permission>	getObjectPermissions()
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	setAccountStatus(User.AccountStatus status)
void	setAuthServiceId(String authServiceId)
void	setAuthServiceUid(String authServiceUid)
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()

getAuthServiceId

@Nullable
String getAuthServiceId()

getAuthServiceUid

@Nullable
String getAuthServiceUid()

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()

getObjectPermissions

Set<org.apache.shiro.authz.Permission> getObjectPermissions()

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)

setAuthServiceId

void setAuthServiceId(@Nullable
                      String authServiceId)

setAuthServiceUid

void setAuthServiceUid(@Nullable
                       String authServiceUid)

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)

setAccountStatus

void setAccountStatus(User.AccountStatus status)

getAccountStatus

User.AccountStatus getAccountStatus()