core/gropius.service.template/AbstractTemplateService

AbstractTemplateService

abstract class AbstractTemplateService<T : Template<*, T>, R : GropiusRepository<T, String>>(repository: R) : BaseTemplateService<T, R>

Base class for services for subclasses of Template

Parameters

repository

the associated repository used for CRUD functionality

Type Parameters

T

the type of Node this service is used for

R

Repository type associated with T

Inheritors

AbstractRelationPartnerTemplateService

ArtefactTemplateService

IssueTemplateService

RelationTemplateService

Constructors

AbstractTemplateService

constructor(repository: R)

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

@Autowired

private lateinit var jsonNodeMapper: JsonNodeMapper

Injected JsonNodeMapper

val repository: R

Functions

checkCreateTemplatePermission

suspend fun checkCreateTemplatePermission(authorizationContext: GropiusAuthorizationContext)

Checks for CAN_CREATE_TEMPLATE permission on the user provided via authorizationContext

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

createdBaseTemplate

fun createdBaseTemplate(template: T, input: CreateBaseTemplateInput, extendedTemplates: Collection<T>)

Updates template based on input Sets templateFieldSpecifications based on input, and the templateFieldSpecification of extendedTemplates

createdTemplate

suspend fun createdTemplate(template: T, input: CreateTemplateInput)

Updates template based on input Sets extends and templateFieldSpecifications

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

findAllByIdWithExtending

suspend fun <T : Template<*, out T>, R : GropiusRepository<T, String>> BaseTemplateService<T, R>.findAllByIdWithExtending(ids: Collection<ID>): Set<T>

Returns all templates which extend the template with the provided ids Includes the template with the provided ids, and indirect extending templates.

suspend fun getUser(authorizationContext: GropiusAuthorizationContext): GropiusUser

Gets a GropiusUser based on the userId from the authorizationContext

updateNamedNode

fun updateNamedNode(node: NamedNode, input: UpdateNamedNodeInput)

Updates node based on input Updates name and description