core/gropius.service.user/GropiusUserService

GropiusUserService

@Service

class GropiusUserService(repository: GropiusUserRepository, val gropiusCoreConfigurationProperties: GropiusCoreConfigurationProperties) : NodeService<GropiusUser, GropiusUserRepository>

Service for GropiusUsers. Provides functions to create and update

Parameters

repository

the associated repository used for CRUD functionality

gropiusCoreConfigurationProperties

the configuration properties

Constructors

GropiusUserService

constructor(repository: GropiusUserRepository, gropiusCoreConfigurationProperties: GropiusCoreConfigurationProperties)

Properties

authorizationChecker

@Autowired

lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

gropiusCoreConfigurationProperties

private val gropiusCoreConfigurationProperties: GropiusCoreConfigurationProperties

gropiusUserRepository

@Autowired

lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

val repository: GropiusUserRepository

Functions

suspend fun checkIsAdmin(authorizationContext: GropiusAuthorizationContext, errorMessage: String)

Checks if the user defined by authorizationContext is a global admin

checkPermission

suspend fun checkPermission(node: Node, permission: Permission, errorMessage: String)

Checks if the permission is granted on node If checkPermission on the permission.context is false, no permission is evaluated Does not handle the case that the user is an admin

createGropiusUser

suspend fun createGropiusUser(input: CreateGropiusUserInput): GropiusUser

Creates a new GropiusUser based on the provided input Does not check the authorization status Checks that no GropiusUser with the same username exists This MUST NOT be exposed via the public API

evaluatePermission

suspend fun evaluatePermission(node: Node, permission: Permission): Boolean

Evaluates if the permission is granted on node If checkPermission on the permission.context is false, no permission is evaluated Does not handle the case that the user is an admin

findGropiusUserByUsername

suspend fun findGropiusUserByUsername(username: String): GropiusUser

Finds a GropiusUser by username No authorization status check necessary

findGropiusUserIds

suspend fun findGropiusUserIds(): List<ID>

Find the ids of all GropiusUsers

suspend fun getUser(authorizationContext: GropiusAuthorizationContext): GropiusUser

Gets a GropiusUser based on the userId from the authorizationContext

updateGropiusUser

suspend fun updateGropiusUser(authorizationContext: GropiusAuthorizationContext, input: UpdateGropiusUserInput): GropiusUser

Updates a GropiusUser based on the provided input Checks the authorization status

suspend fun validateAvatar(avatar: URI)

Validates that a URI can be used as avatar for a GropiusUser