UserServiceImpl (Graylog 4.1.1 API)

java.lang.Object
- org.graylog2.database.PersistedServiceImpl
- - org.graylog2.users.UserServiceImpl

All Implemented Interfaces:

PersistedService, UserService

Direct Known Subclasses:

UserManagementServiceImpl
```
public class UserServiceImpl
extends PersistedServiceImpl
implements UserService
```

Field Summary
- Fields inherited from class org.graylog2.database.PersistedServiceImpl
  mongoConnection

Constructor Summary

Constructors
Constructor and Description
`UserServiceImpl(MongoConnection mongoConnection, Configuration configuration, RoleService roleService, AccessTokenService accessTokenService, UserImpl.Factory userFactory, InMemoryRolePermissionResolver inMemoryRolePermissionResolver, com.google.common.eventbus.EventBus serverEventBus, GRNRegistry grnRegistry, PermissionAndRoleResolver permissionAndRoleResolver)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`long`	`count()`
`User`	`create()`
`int`	`delete(String username)`
`int`	`deleteById(String userId)`
`void`	`dissociateAllUsersFromRole(Role role)`
`User`	`getAdminUser()` Deprecated.
`List<GRNPermission>`	`getGRNPermissionsForUser(User user)`
`List<org.apache.shiro.authz.Permission>`	`getPermissionsForUser(User user)`
`Set<String>`	`getRoleNames(User user)`
`Optional<User>`	`getRootUser()` Get the root user.
`Set<String>`	`getUserPermissionsFromRoles(User user)`
`List<org.apache.shiro.authz.permission.WildcardPermission>`	`getWildcardPermissionsForUser(User user)`
`static Map<String,Object>`	`initialUserFields()`
`User`	`load(String username)`
`List<User>`	`loadAll()`
`List<User>`	`loadAllForAuthServiceBackend(String authServiceBackendId)`
`Collection<User>`	`loadAllForRole(Role role)`
`Optional<User>`	`loadByAuthServiceUidOrUsername(String authServiceUid, String username)` Tries to find a user for the given authentication service UID or username.
`User`	`loadById(String id)`
`List<User>`	`loadByIds(Collection<String> ids)`
`<T extends Persisted> String`	`save(T model)`

Methods inherited from class org.graylog2.database.PersistedServiceImpl
collection, collection, count, count, cursorToList, destroy, destroy, destroyAll, destroyAll, destroyAll, embed, findOne, findOne, findOne, findOne, get, get, get, query, query, query, query, query, removeEmbedded, removeEmbedded, saveWithoutValidation, totalCount, totalCount, validate, validate, validate

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

Methods inherited from interface org.graylog2.plugin.database.PersistedService
destroy, destroyAll, saveWithoutValidation, validate, validate, validate

Constructor Detail

UserServiceImpl

@Inject
public UserServiceImpl(MongoConnection mongoConnection,
                               Configuration configuration,
                               RoleService roleService,
                               AccessTokenService accessTokenService,
                               UserImpl.Factory userFactory,
                               InMemoryRolePermissionResolver inMemoryRolePermissionResolver,
                               com.google.common.eventbus.EventBus serverEventBus,
                               GRNRegistry grnRegistry,
                               PermissionAndRoleResolver permissionAndRoleResolver)

Method Detail
- loadById
```
@Nullable
public User loadById(String id)
```
  Specified by:
  
  loadById in interface UserService
- loadByIds
```
public List<User> loadByIds(Collection<String> ids)
```
  Specified by:
  
  loadByIds in interface UserService
- load
```
@Nullable
public User load(String username)
```
  Specified by:
  
  load in interface UserService
- loadByAuthServiceUidOrUsername
```
public Optional<User> loadByAuthServiceUidOrUsername(String authServiceUid,
                                                     String username)
```
  Description copied from interface: UserService
  
  Tries to find a user for the given authentication service UID or username. (in that order)
  
  Specified by:
  
  loadByAuthServiceUidOrUsername in interface UserService
  
  Parameters:
  
  authServiceUid - the authentication service UID (tried first)
  
  username - the username (tried second)
  
  Returns:
  
  the user or an empty option if no user can be found
- delete
```
public int delete(String username)
```
  Specified by:
  
  delete in interface UserService
- deleteById
```
public int deleteById(String userId)
```
  Specified by:
  
  deleteById in interface UserService
- create
```
public User create()
```
  Specified by:
  
  create in interface UserService
- initialUserFields
```
public static Map<String,Object> initialUserFields()
```
- loadAll
```
public List<User> loadAll()
```
  Specified by:
  
  loadAll in interface UserService
- save
```
public <T extends Persisted> String save(T model)
                                  throws ValidationException
```
  Specified by:
  
  save in interface PersistedService
  
  Overrides:
  
  save in class PersistedServiceImpl
  
  Throws:
  
  ValidationException
- getAdminUser
```
@Deprecated
public User getAdminUser()
```
  Deprecated.
  
  Specified by:
  
  getAdminUser in interface UserService
- getRootUser
```
public Optional<User> getRootUser()
```
  Description copied from interface: UserService
  
  Get the root user. The root user might not be present in all environments and there shouldn't really be a need to explicitly refer to the root user. But if you really need it, here you go.
  
  Specified by:
  
  getRootUser in interface UserService
  
  Returns:
  
  The root user, if present. An empty optional otherwise.
- count
```
public long count()
```
  Specified by:
  
  count in interface UserService
- loadAllForAuthServiceBackend
```
public List<User> loadAllForAuthServiceBackend(String authServiceBackendId)
```
  Specified by:
  
  loadAllForAuthServiceBackend in interface UserService
- loadAllForRole
```
public Collection<User> loadAllForRole(Role role)
```
  Specified by:
  
  loadAllForRole in interface UserService
- getRoleNames
```
public Set<String> getRoleNames(User user)
```
  Specified by:
  
  getRoleNames in interface UserService
- getPermissionsForUser
```
public List<org.apache.shiro.authz.Permission> getPermissionsForUser(User user)
```
  Specified by:
  
  getPermissionsForUser in interface UserService
- getWildcardPermissionsForUser
```
public List<org.apache.shiro.authz.permission.WildcardPermission> getWildcardPermissionsForUser(User user)
```
  Specified by:
  
  getWildcardPermissionsForUser in interface UserService
- getGRNPermissionsForUser
```
public List<GRNPermission> getGRNPermissionsForUser(User user)
```
  Specified by:
  
  getGRNPermissionsForUser in interface UserService
- getUserPermissionsFromRoles
```
public Set<String> getUserPermissionsFromRoles(User user)
```
  Specified by:
  
  getUserPermissionsFromRoles in interface UserService
- dissociateAllUsersFromRole
```
public void dissociateAllUsersFromRole(Role role)
```
  Specified by:
  
  dissociateAllUsersFromRole in interface UserService

Class UserServiceImpl

Field Summary

Fields inherited from class org.graylog2.database.PersistedServiceImpl

Constructor Summary

Method Summary

Methods inherited from class org.graylog2.database.PersistedServiceImpl

Methods inherited from class java.lang.Object

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

Constructor Detail

UserServiceImpl

Method Detail

loadById

loadByIds

load

loadByAuthServiceUidOrUsername

delete

deleteById

create

initialUserFields

loadAll

save

getAdminUser

getRootUser

count

loadAllForAuthServiceBackend

loadAllForRole

getRoleNames

getPermissionsForUser

getWildcardPermissionsForUser

getGRNPermissionsForUser

getUserPermissionsFromRoles

dissociateAllUsersFromRole