core/gropius.model.architecture/Component

Component

@DomainNode(topLevelQueryName = "components", searchQueryName = "searchComponents")

@Authorization(name = "READ", allowFromRelated = ["versions"])

@Authorization(name = "RELATE_FROM_COMPONENT", allow = [Rule(beanRef = "relatedToNodePermissionRule", options = ["ADMIN"])])

@Authorization(name = "ADD_TO_PROJECTS", allow = [Rule(beanRef = "relatedToNodePermissionRule", options = ["ADMIN"])])

class Component(name: String, description: String, repositoryURL: URI?, val templatedFields: MutableMap<String, String>) : Trackable, MutableTemplatedNode, NodeWithPermissions<ComponentPermission>

Entity which represents a software component, e.g. a library, a microservice, or a deployment platform, .... The type of software component is defined by the template. Can have issues, labels and artefacts as this is a Trackable. Defines InterfaceSpecifications, but visible/invisible InterfaceSpecificationVersions depend on the ComponentVersion. Can be affected by Issues. READ is granted via an associated ComponentPermission or if READ is granted on any Project including any ComponentVersion in `versions` of this Component.

Constructors

Component

constructor(name: String, description: String, repositoryURL: URI?, templatedFields: MutableMap<String, String>)

Types

Companion

object Companion

Properties

affectingIssues

@NodeRelationship(type = "AFFECTS", direction = Direction.INCOMING)

@FilterProperty

val affectingIssues: LazyLoadingDelegate<Issue, NodeSetPropertyDelegate.NodeSetProperty>

The issues which affect this entity

artefacts

@NodeRelationship(type = "ARTEFACT", direction = Direction.OUTGOING)

@FilterProperty

val artefacts: LazyLoadingDelegate<Artefact, NodeSetPropertyDelegate.NodeSetProperty>

Artefacts of this trackable, typically some kind of file.

description

@FilterProperty

@SearchProperty

open override var description: String

The description of this entity.

fieldCache

internal var fieldCache: MutableMap<String, Any?>

graphQLId

val graphQLId: ID

The unique id of this node

@Id

@GeneratedValue(generatorRef = "nodeIdGenerator")

internal var id: String?

interfaceSpecifications

@NodeRelationship(type = "COMPONENT", direction = Direction.INCOMING)

@FilterProperty

val interfaceSpecifications: LazyLoadingDelegate<InterfaceSpecification, NodeSetPropertyDelegate.NodeSetProperty>

List of interfaces this component specifies. Note that visible/invisible InterfaceSpecifications are defined by a specific version of this component

isPersisted

val isPersisted: Boolean

isSaved

internal var isSaved: Boolean

issues

@NodeRelationship(type = "ISSUE", direction = Direction.OUTGOING)

@FilterProperty

val issues: LazyLoadingDelegate<Issue, NodeSetPropertyDelegate.NodeSetProperty>

The set of Issues which are part of this Trackable. An Issue has to be part of a Trackable to use the Labels and Artefacts defined by the Trackable.

labels

@NodeRelationship(type = "LABEL", direction = Direction.OUTGOING)

@FilterProperty

val labels: LazyLoadingDelegate<Label, NodeSetPropertyDelegate.NodeSetProperty>

The set of Labels which can be added to issues of this trackable.

lazyLoadingContext

@ConvertWith(converter = LazyLoadingContextConverter::class)

internal var lazyLoadingContext: LazyLoadingContext?

name

@FilterProperty

@OrderProperty

@SearchProperty

open override var name: String

The name of this entity.

nodeVersion

@Version

private var nodeVersion: Long

Version used for optimistic locking

orderFields

internal var orderFields: MutableMap<String, Any?>?

permissions

@NodeRelationship(type = "NODE", direction = Direction.INCOMING)

@FilterProperty

open override val permissions: LazyLoadingDelegate<ComponentPermission, NodeSetPropertyDelegate.NodeSetProperty>

Permissions associated with the NodeWithPermissions

pinnedIssues

@NodeRelationship(type = "PINNED_ON", direction = Direction.INCOMING)

@FilterProperty

val pinnedIssues: LazyLoadingDelegate<Issue, NodeSetPropertyDelegate.NodeSetProperty>

Issues which are pinned to this trackable, subset of `issues`.

propertyLookup

internal val propertyLookup: MutableMap<String, PropertyDelegate<*>>

rawId

val rawId: String?

repositoryURL

@FilterProperty

var repositoryURL: URI?

If existing, the URL of the repository (e.g. a GitHub repository).

syncsTo

@NodeRelationship(type = "SYNCS_TO", direction = Direction.OUTGOING)

@FilterProperty

val syncsTo: LazyLoadingDelegate<IMSProject, NodeSetPropertyDelegate.NodeSetProperty>

IMSProjects this Trackable is synced to and from.

template

@NodeRelationship(type = "USED_IN", direction = Direction.INCOMING)

@FilterProperty

@OrderProperty

open override val template: LazyLoadingDelegate<ComponentTemplate, NodePropertyDelegate.NodeProperty>

Template associated with the TemplatedNode

templatedFields

open override val templatedFields: MutableMap<String, String>

The values for all templated fields. The schema is defined by the Template of this node

versions

@NodeRelationship(type = "VERSION", direction = Direction.OUTGOING)

@FilterProperty

val versions: LazyLoadingDelegate<ComponentVersion, NodeSetPropertyDelegate.NodeSetProperty>

Versions of this components.

Functions

equals

operator override fun equals(other: Any?): Boolean

getFromGraphQL

internal suspend fun getFromGraphQL(@Autowired nodeQueryParser: NodeQueryParser, dataFetchingEnvironment: DataFetchingEnvironment): Any?

getProperty

internal fun <T : PropertyDelegate<*>> getProperty(property: KProperty1<*, *>): T

graphQLKotlinDummyFunction

private fun graphQLKotlinDummyFunction()

Dummy function to avoid GraphQL kotlin optimization weirdness

hashCode

override fun hashCode(): Int

loadNodesOfRelationship

internal suspend fun <T : Node?> loadNodesOfRelationship(property: KProperty1<*, *>, loader: LazyLoadingSubqueryGenerator<T>.() -> Unit?)

NodeProperty

protected fun <T : Node?> NodeProperty(): PropertyDelegateProvider<Node, NodePropertyDelegate<T>>

NodeSetProperty

protected fun <T : Node> NodeSetProperty(): PropertyDelegateProvider<Node, NodeSetPropertyDelegate<T>>

registerQueryResult

internal fun registerQueryResult(entry: NodeQueryEntry<*>, queryResult: Any?)

templatedField

open fun templatedField(name: String, @Autowired objectMapper: ObjectMapper): JsonNode?

Value of a field defined by the template. Error if such a field is not defined.

templatedFields

open fun templatedFields(names: List<String>?, prefixMatching: Boolean?, @Autowired objectMapper: ObjectMapper): List<JSONField>

All templatedFields If `names` is provided, only those matching the name. If `prefixMatching` is true, matching is done by prefix, otherwise by full name.

toString

open override fun toString(): String

Component ​

Constructors

Types

Properties

Functions

Component