Package org.graylog2.users

Class UserImpl

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	Description
static interface	UserImpl.Factory
static class	UserImpl.LocalAdminUser

Nested classes/interfaces inherited from interface org.graylog2.plugin.database.users.User

User.AccountStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCOUNT_STATUS
static final String	AUTH_SERVICE_ID
static final String	AUTH_SERVICE_UID
protected final ClusterConfigService	clusterConfigService
static final String	COLLECTION_NAME
static final String	EMAIL
static final String	EXTERNAL_USER
static final String	FIRST_NAME
static final String	FULL_NAME
static final String	FULL_NAME_FORMAT
static final String	GLOBAL_SESSION_TIMEOUT
static final String	LAST_NAME
static final int	MAX_EMAIL_LENGTH
static final int	MAX_FIRST_LAST_NAME_LENGTH
static final int	MAX_FULL_NAME_LENGTH
static final int	MAX_USERNAME_LENGTH
static final String	PASSWORD
static final String	PERMISSIONS
static final String	PREFERENCES
static final String	ROLES
static final String	SERVICE_ACCOUNT
static final String	SESSION_TIMEOUT
static final String	STARTPAGE
static final String	TIMEZONE
static final String	USERNAME

Fields inherited from class org.graylog2.database.PersistedImpl

fields, id

Constructor Summary

Constructors

Constructor	Description
UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory, Permissions permissions, ClusterConfigService clusterConfigService, Map<String,Object> fields)
UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory, Permissions permissions, ClusterConfigService clusterConfigService, org.bson.types.ObjectId id, Map<String,Object> fields)

Method Summary

Modifier and Type	Method	Description
User.AccountStatus	getAccountStatus()
String	getAuthServiceId()
String	getAuthServiceUid()
String	getEmail()	Returns the email address of the user.
Map<String,Validator>	getEmbeddedValidations(String key)
Optional<String>	getFirstName()
String	getFullName()
String	getHashedPassword()
Optional<String>	getLastName()
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()
Map<String,Validator>	getValidations()
boolean	isExternalUser()
boolean	isLocalAdmin()
boolean	isReadOnly()
boolean	isServiceAccount()
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	setFirstLastFullNames(String firstName, String lastName)	Set the first, last, and full user's name.
void	setFullName(String fullname)	Deprecated.
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	setServiceAccount(boolean isServiceAccount)
void	setSessionTimeoutMs(long timeoutValue)
void	setStartpage(String type, String id)
void	setStartpage(Startpage startpage)
void	setTimeZone(String timeZone)
void	setTimeZone(org.joda.time.DateTimeZone 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 Details

FULL_NAME_FORMAT

public static final String FULL_NAME_FORMAT

See Also:

• Constant Field Values

clusterConfigService

protected final ClusterConfigService clusterConfigService

COLLECTION_NAME

public static final String COLLECTION_NAME

See Also:

• Constant Field Values

AUTH_SERVICE_ID

public static final String AUTH_SERVICE_ID

See Also:

• Constant Field Values

AUTH_SERVICE_UID

public static final String AUTH_SERVICE_UID

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

FIRST_NAME

public static final String FIRST_NAME

See Also:

• Constant Field Values

LAST_NAME

public static final String LAST_NAME

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

GLOBAL_SESSION_TIMEOUT

public static final String GLOBAL_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

ACCOUNT_STATUS

public static final String ACCOUNT_STATUS

See Also:

• Constant Field Values

SERVICE_ACCOUNT

public static final String SERVICE_ACCOUNT

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_FIRST_LAST_NAME_LENGTH

public static final int MAX_FIRST_LAST_NAME_LENGTH

See Also:

• Constant Field Values

MAX_FULL_NAME_LENGTH

public static final int MAX_FULL_NAME_LENGTH

See Also:

• Constant Field Values

Constructor Details

UserImpl

public UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory,
 Permissions permissions,
 ClusterConfigService clusterConfigService,
 Map<String,Object> fields)

UserImpl

public UserImpl(PasswordAlgorithmFactory passwordAlgorithmFactory,
 Permissions permissions,
 ClusterConfigService clusterConfigService,
 org.bson.types.ObjectId id,
 Map<String,Object> fields)

Method Details

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

getFirstName

public Optional<String> getFirstName()

Specified by:

getFirstName in interface User

getLastName

public Optional<String> getLastName()

Specified by:

getLastName in interface User

getFullName

public String getFullName()

Specified by:

getFullName in interface User

setFirstLastFullNames

public void setFirstLastFullNames(String firstName,
 String lastName)

Set the first, last, and full user's name. The user's full name is composed by concatenating the first and last names together with a space between. For example "First Last".

Specified by:

setFirstLastFullNames in interface User

Parameters:

firstName - Required. The user's first name.

lastName - Required. The user's last name.

setFullName

@Deprecated
public void setFullName(String fullname)

Deprecated.

Set the user's full name. Starting in Graylog 4.1, use of this method is deprecated. Prefer use of the setFirstLastFullNames(String, String) method instead when possible. This way, both individual first and last names will be available when needed.

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

getObjectPermissions

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

Specified by:

getObjectPermissions 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

getAuthServiceId

@Nullable
public String getAuthServiceId()

Specified by:

getAuthServiceId in interface User

getAuthServiceUid

@Nullable
public String getAuthServiceUid()

Specified by:

getAuthServiceUid in interface User

setAuthServiceId

public void setAuthServiceId(@Nullable
 String authServiceId)

Specified by:

setAuthServiceId in interface User

setAuthServiceUid

public void setAuthServiceUid(@Nullable
 String authServiceUid)

Specified by:

setAuthServiceUid in interface User

setAccountStatus

public void setAccountStatus(User.AccountStatus status)

Specified by:

setAccountStatus in interface User

getAccountStatus

public User.AccountStatus getAccountStatus()

Specified by:

getAccountStatus in interface User

isServiceAccount

public boolean isServiceAccount()

Specified by:

isServiceAccount in interface User

setServiceAccount

public void setServiceAccount(boolean isServiceAccount)

Specified by:

setServiceAccount in interface User