core/gropius.service.architecture/ProjectService

ProjectService

@Service

class ProjectService(repository: ProjectRepository, val projectPermissionService: ProjectPermissionService, val componentVersionRepository: ComponentVersionRepository, val layoutService: LayoutService, val viewRepository: ViewRepository) : TrackableService<Project, ProjectRepository>

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

Parameters

repository

the associated repository used for CRUD functionality

projectPermissionService

used to create the initial permission for a created Project

componentVersionRepository

used to get ComponentVersions by id

layoutService

used to update the layout of a Project

viewRepository

used to save the Project

Constructors

constructor(repository: ProjectRepository, projectPermissionService: ProjectPermissionService, componentVersionRepository: ComponentVersionRepository, layoutService: LayoutService, viewRepository: ViewRepository)

Properties

artefactRepository

@Autowired

lateinit var artefactRepository: ArtefactRepository

Injected ArtefactRepository

authorizationChecker

@Autowired

lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

componentVersionRepository

private val componentVersionRepository: ComponentVersionRepository

gropiusUserRepository

@Autowired

lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

imsProjectService

@Autowired

lateinit var imsProjectService: IMSProjectService

Injected IMSProjectService

@Autowired

lateinit var issueService: IssueService

Injected IssueService

labelRepository

@Autowired

lateinit var labelRepository: LabelRepository

Injected LabelRepository

private val layoutService: LayoutService

@Autowired

lateinit var nodeRepository: NodeRepository

Injected NodeRepository

projectPermissionService

private val projectPermissionService: ProjectPermissionService

val repository: ProjectRepository

private val viewRepository: ViewRepository

Functions

addComponentVersionToProject

suspend fun addComponentVersionToProject(authorizationContext: GropiusAuthorizationContext, input: AddComponentVersionToProjectInput): Pair<Project, ComponentVersion>

Adds a ComponentVersion to a Project Checks the authorization status

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

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 createProject(authorizationContext: GropiusAuthorizationContext, input: CreateProjectInput): Project

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

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

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

removeComponentVersionFromProject

suspend fun removeComponentVersionFromProject(authorizationContext: GropiusAuthorizationContext, input: RemoveComponentVersionFromProjectInput): Project

Removes a ComponentVersion from a Project Checks the authorization status

updateNamedAffectedByIssue

fun updateNamedAffectedByIssue(node: NamedAffectedByIssue, input: UpdateNamedNodeInput)

Updates node based on input Updates name and description

suspend fun updateProject(authorizationContext: GropiusAuthorizationContext, input: UpdateProjectInput): Project

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

updateTrackable

fun updateTrackable(node: Trackable, input: UpdateTrackableInput)

Updates node based on input Calls updateNamedAffectedByIssue Updates repositoryURL