core/gropius.service.architecture/IMSService

IMSService

@Service

class IMSService(repository: IMSRepository, val imsPermissionService: IMSPermissionService, val imsTemplateRepository: IMSTemplateRepository, val templatedNodeService: TemplatedNodeService, val templateService: TemplateService) : NamedNodeService<IMS, IMSRepository>

Service for IMSs. Provides functions to create, update and delete

Parameters

repository

the associated repository used for CRUD functionality

imsPermissionService

used to create the initial permission for a created IMS

imsTemplateRepository

used to get IMSTemplates by id

templatedNodeService

service used to update templatedFields

Constructors

constructor(repository: IMSRepository, imsPermissionService: IMSPermissionService, imsTemplateRepository: IMSTemplateRepository, templatedNodeService: TemplatedNodeService, templateService: TemplateService)

Properties

authorizationChecker

@Autowired

lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

gropiusUserRepository

@Autowired

lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

imsPermissionService

private val imsPermissionService: IMSPermissionService

imsTemplateRepository

private val imsTemplateRepository: IMSTemplateRepository

val repository: IMSRepository

templatedNodeService

private val templatedNodeService: TemplatedNodeService

templateService

private val templateService: TemplateService

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

suspend fun createIMS(authorizationContext: GropiusAuthorizationContext, input: CreateIMSInput): IMS

Creates a new IMS based on the provided input Checks the authorization status

suspend fun deleteIMS(authorizationContext: GropiusAuthorizationContext, input: DeleteNodeInput)

Deletes a IMS by id Checks the authorization status

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

suspend fun getUser(authorizationContext: GropiusAuthorizationContext): GropiusUser

Gets a GropiusUser based on the userId from the authorizationContext

suspend fun updateIMS(authorizationContext: GropiusAuthorizationContext, input: UpdateIMSInput): IMS

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

updateNamedNode

fun updateNamedNode(node: NamedNode, input: UpdateNamedNodeInput)

Updates node based on input Updates name and description