@Service
class ArtefactService(repository: ArtefactRepository, val templatedNodeService: TemplatedNodeService, val trackableRepository: TrackableRepository, val artefactTemplateRepository: ArtefactTemplateRepository, val issueService: IssueService, val templateService: TemplateService) : AuditedNodeService<Artefact, ArtefactRepository>

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

Parameters

repository

the associated repository used for CRUD functionality

templatedNodeService

service used to update templatedFields

trackableRepository

used to get Trackables by id

artefactTemplateRepository

used to get ArtefactTemplate

issueService

used to remove Artefacts from Issues

Constructors

Link copied to clipboard
constructor(repository: ArtefactRepository, templatedNodeService: TemplatedNodeService, trackableRepository: TrackableRepository, artefactTemplateRepository: ArtefactTemplateRepository, issueService: IssueService, templateService: TemplateService)

Properties

Link copied to clipboard
Link copied to clipboard
@Autowired
lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

Link copied to clipboard
@Autowired
lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

Link copied to clipboard
private val issueService: IssueService
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
suspend fun checkIsAdmin(authorizationContext: GropiusAuthorizationContext, errorMessage: String)

Checks if the user defined by authorizationContext is a global admin

Link copied to clipboard
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

Link copied to clipboard
suspend fun createArtefact(authorizationContext: GropiusAuthorizationContext, input: CreateArtefactInput): Artefact

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

Link copied to clipboard
suspend fun createdAuditedNode(node: AuditedNode, createdBy: User)

Updates node after it was created without an Input Should be called after the node was constructed Sets AuditedNode.createdBy and AuditedNode.lastModifiedBy

Link copied to clipboard
suspend fun deleteArtefact(authorizationContext: GropiusAuthorizationContext, input: DeleteNodeInput)

Deletes an Artefact by id Checks the authorization status

Link copied to clipboard
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

Link copied to clipboard
suspend fun getUser(authorizationContext: GropiusAuthorizationContext): GropiusUser

Gets a GropiusUser based on the userId from the authorizationContext

Link copied to clipboard
suspend fun updateArtefact(authorizationContext: GropiusAuthorizationContext, input: UpdateArtefactInput): Artefact

Updates an Artefact based on the provided input Checks the authorization status

Link copied to clipboard
suspend fun updateAuditedNode(node: AuditedNode, lastModifiedBy: User, lastModifiedAt: OffsetDateTime)

Updates node after it was updated without an UpdateNodeInput Sets AuditedNode.lastModifiedBy and AuditedNode.lastModifiedAt