Interface User
- All Superinterfaces:
Persisted
- All Known Implementing Classes:
UserImpl
,UserImpl.LocalAdminUser
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetEmail()
Returns the email address of the user.getName()
Set<org.apache.shiro.authz.Permission>
long
org.joda.time.DateTimeZone
boolean
boolean
boolean
boolean
boolean
isUserPassword
(String password) void
setAccountStatus
(User.AccountStatus status) void
setAuthServiceId
(String authServiceId) void
setAuthServiceUid
(String authServiceUid) void
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
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 interface org.graylog2.plugin.database.Persisted
asMap, getEmbeddedValidations, getFields, getId, getValidations
-
Method Details
-
isReadOnly
boolean isReadOnly() -
getAuthServiceId
-
getAuthServiceUid
-
getFirstName
-
getLastName
-
getFullName
String getFullName() -
getName
String getName() -
setName
-
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
-
getObjectPermissions
Set<org.apache.shiro.authz.Permission> getObjectPermissions() -
getPreferences
-
getStartpage
Startpage getStartpage() -
getSessionTimeoutMs
long getSessionTimeoutMs() -
setSessionTimeoutMs
void setSessionTimeoutMs(long timeoutValue) -
setPermissions
-
setPreferences
-
setAuthServiceId
-
setAuthServiceUid
-
setEmail
-
setFirstLastFullNames
Set the first, last, and full user's name. The full user's full name is composed by concatenating the first and last names together with a space between. For example "First Last".- Parameters:
firstName
- Required. The user's first name.lastName
- Required. The user's last name.
-
setFullName
Deprecated.Set the user's full name. Starting in Graylog 4.1, use of this method is deprecated. Prefer use of thesetFirstLastFullNames(String, String)
method instead when possible. This way, both individual first and last names will be available when needed. -
getHashedPassword
String getHashedPassword() -
setPassword
-
isUserPassword
-
getTimeZone
org.joda.time.DateTimeZone getTimeZone() -
setTimeZone
void setTimeZone(org.joda.time.DateTimeZone timeZone) -
setTimeZone
-
isExternalUser
boolean isExternalUser() -
setExternal
void setExternal(boolean external) -
setStartpage
-
setStartpage
-
isLocalAdmin
boolean isLocalAdmin() -
getRoleIds
-
setRoleIds
-
setAccountStatus
-
getAccountStatus
User.AccountStatus getAccountStatus() -
isServiceAccount
boolean isServiceAccount() -
setServiceAccount
void setServiceAccount(boolean isServiceAccount)
-