core/gropius.service.architecture/ComponentService

ComponentService

@Service

class ComponentService(repository: ComponentRepository, val templatedNodeService: TemplatedNodeService, val componentTemplateRepository: ComponentTemplateRepository, val componentPermissionService: ComponentPermissionService, val interfaceSpecificationService: InterfaceSpecificationService, val componentVersionService: ComponentVersionService, val intraComponentDependencySpecificationTypeRepository: IntraComponentDependencySpecificationTypeRepository, val templateService: TemplateService) : TrackableService<Component, ComponentRepository>

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

Parameters

repository

the associated repository used for CRUD functionality

templatedNodeService

service used to update templatedFields

componentTemplateRepository

used to get ComponentTemplate

componentPermissionService

used to create the initial permission for a created Component

interfaceSpecificationService

used to create InterfaceSpecifications

componentVersionService

used to create ComponentVersions

intraComponentDependencySpecificationTypeRepository

used to get IntraComponentDependencySpecificationTypes

Constructors

ComponentService

constructor(repository: ComponentRepository, templatedNodeService: TemplatedNodeService, componentTemplateRepository: ComponentTemplateRepository, componentPermissionService: ComponentPermissionService, interfaceSpecificationService: InterfaceSpecificationService, componentVersionService: ComponentVersionService, intraComponentDependencySpecificationTypeRepository: IntraComponentDependencySpecificationTypeRepository, templateService: TemplateService)

Properties

artefactRepository

@Autowired

lateinit var artefactRepository: ArtefactRepository

Injected ArtefactRepository

authorizationChecker

@Autowired

lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

componentPermissionService

private val componentPermissionService: ComponentPermissionService

componentTemplateRepository

private val componentTemplateRepository: ComponentTemplateRepository

componentVersionService

private val componentVersionService: ComponentVersionService

gropiusUserRepository

@Autowired

lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

imsProjectService

@Autowired

lateinit var imsProjectService: IMSProjectService

Injected IMSProjectService

interfaceSpecificationService

private val interfaceSpecificationService: InterfaceSpecificationService

intraComponentDependencySpecificationTypeRepository

private val intraComponentDependencySpecificationTypeRepository: IntraComponentDependencySpecificationTypeRepository

@Autowired

lateinit var issueService: IssueService

Injected IssueService

labelRepository

@Autowired

lateinit var labelRepository: LabelRepository

Injected LabelRepository

@Autowired

lateinit var nodeRepository: NodeRepository

Injected NodeRepository

val repository: ComponentRepository

templatedNodeService

private val templatedNodeService: TemplatedNodeService

templateService

private val templateService: TemplateService

Functions

beforeDeleteTrackable

suspend fun beforeDeleteTrackable(node: Trackable)

Must be called before node is deleted via the repository Deletes all Artefacts Deletes Labels and Issues, if only present on this Trackable

bulkCreateComponent

suspend fun bulkCreateComponent(authorizationContext: GropiusAuthorizationContext, input: BulkCreateComponentInput): List<Component>

Creates multiple new Components based on the provided input Checks the authorization status

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

checkTypeCompatibility

private suspend fun checkTypeCompatibility(template: ComponentTemplate, type: IntraComponentDependencySpecificationType)

Checks if the IntraComponentDependencySpecificationTypes are compatible with the new template

createComponent

suspend fun createComponent(authorizationContext: GropiusAuthorizationContext, input: CreateComponentInput): Component

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

createComponentInternal

private suspend fun createComponentInternal(input: CreateComponentInput, user: GropiusUser): Component

Creates a new Component based on the provided input Does not check the authorization status

deleteComponent

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

Deletes a Component 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

updateComponent

suspend fun updateComponent(authorizationContext: GropiusAuthorizationContext, input: UpdateComponentInput): Component

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

updateComponentTemplate

private suspend fun updateComponentTemplate(input: UpdateComponentInput, component: Component, updateContext: NodeBatchUpdateContext)

Updates the template of a Component, if a new is defined Does not check the authorization status

updateIntraComponentDependencySpecificationsAfterTemplateUpdate

private suspend fun updateIntraComponentDependencySpecificationsAfterTemplateUpdate(component: Component, typeMapping: Map<IntraComponentDependencySpecificationType, IntraComponentDependencySpecificationType?>, updateContext: NodeBatchUpdateContext)

Updates the IntraComponentDependencySpecificationTypes where the old type is incompatible with the new template based on typeMapping and removes types with no replacement Adds the updated nodes to updateContext

updateNamedAffectedByIssue

fun updateNamedAffectedByIssue(node: NamedAffectedByIssue, input: UpdateNamedNodeInput)

Updates node based on input Updates name and description

updateTrackable

fun updateTrackable(node: Trackable, input: UpdateTrackableInput)

Updates node based on input Calls updateNamedAffectedByIssue Updates repositoryURL