org.graylog2.shared.users

Interface UserService

All Superinterfaces:

PersistedService

All Known Subinterfaces:

UserManagementService

All Known Implementing Classes:

UserManagementServiceImpl, UserServiceImpl

public interface UserService
extends PersistedService

Method Summary

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. If you really need the root user, use getRootUser() instead.
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)
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)

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

destroy, destroyAll, save, saveWithoutValidation, validate, validate, validate

Method Detail

load

@Nullable
User load(String username)

loadById

@Nullable
User loadById(String id)

loadByIds

List<User> loadByIds(Collection<String> ids)

loadByAuthServiceUidOrUsername

Optional<User> loadByAuthServiceUidOrUsername(String authServiceUid,
                                              String username)

Tries to find a user for the given authentication service UID or username. (in that order)

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

int delete(String username)

deleteById

int deleteById(String userId)

create

User create()

loadAll

List<User> loadAll()

getAdminUser

@Deprecated
User getAdminUser()

Deprecated. If you really need the root user, use getRootUser() instead.

getRootUser

Optional<User> getRootUser()

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.

Returns:

The root user, if present. An empty optional otherwise.

count

long count()

loadAllForAuthServiceBackend

List<User> loadAllForAuthServiceBackend(String authServiceBackendId)

loadAllForRole

Collection<User> loadAllForRole(Role role)

getRoleNames

Set<String> getRoleNames(User user)

getPermissionsForUser

List<org.apache.shiro.authz.Permission> getPermissionsForUser(User user)

getWildcardPermissionsForUser

List<org.apache.shiro.authz.permission.WildcardPermission> getWildcardPermissionsForUser(User user)

getGRNPermissionsForUser

List<GRNPermission> getGRNPermissionsForUser(User user)

getUserPermissionsFromRoles

Set<String> getUserPermissionsFromRoles(User user)

dissociateAllUsersFromRole

void dissociateAllUsersFromRole(Role role)