core/gropius.service.architecture/ViewService

ViewService

@Service

class ViewService(repository: ViewRepository, val projectRepository: ProjectRepository, val layoutService: LayoutService, val nodeRepository: NodeRepository, val componentTemplateRepository: ComponentTemplateRepository) : NamedNodeService<View, ViewRepository>

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

Parameters

repository

the associated repository used for CRUD functionality

projectRepository

used to get Projects by id

layoutService

used to update the layout of a View

nodeRepository

used to save the View

componentTemplateRepository

used to get ComponentTemplates by id

Constructors

constructor(repository: ViewRepository, projectRepository: ProjectRepository, layoutService: LayoutService, nodeRepository: NodeRepository, componentTemplateRepository: ComponentTemplateRepository)

Properties

authorizationChecker

@Autowired

lateinit var authorizationChecker: AuthorizationChecker

Injected, used for the checkPermission function

componentTemplateRepository

private val componentTemplateRepository: ComponentTemplateRepository

gropiusUserRepository

@Autowired

lateinit var gropiusUserRepository: GropiusUserRepository

Injected, used to get a user based on a GropiusAuthorizationContext

private val layoutService: LayoutService

private val nodeRepository: NodeRepository

projectRepository

private val projectRepository: ProjectRepository

val repository: ViewRepository

Functions

suspend fun checkIsAdmin(authorizationContext: GropiusAuthorizationContext, errorMessage: String)

Checks if the user defined by authorizationContext is a global admin

checkManageViewsPermission

private suspend fun checkManageViewsPermission(project: Project, authorizationContext: GropiusAuthorizationContext)

Checks that the user has ProjectPermission.MANAGE_VIEWS on the provided project

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 createView(authorizationContext: GropiusAuthorizationContext, input: CreateViewInput): View

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

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

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

updateNamedNode

fun updateNamedNode(node: NamedNode, input: UpdateNamedNodeInput)

Updates node based on input Updates name and description

suspend fun updateView(authorizationContext: GropiusAuthorizationContext, input: UpdateViewInput): View

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