Class BehavioursInstanceManager

Behaviours Instance Manager service provides high-level API for retrieving, storing, validating and updating Behaviours configurations.

Hierarchy

BehavioursInstanceManager

Index

Constructors

constructor

new BehavioursInstanceManager(behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[], g: GraphTraversalSource<GraphTraversal>): BehavioursInstanceManager
Parameters
- behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]
- g: GraphTraversalSource<GraphTraversal>
Returns BehavioursInstanceManager
- Defined in src/behaviours/BehavioursInstanceManager.ts:39

Properties

`Private` `Readonly` _instanceConfigs

_instanceConfigs: {
[tenantId: string]: Promise<TenantBehavioursConfigs> | undefined;
} = {}

Type declaration

[tenantId: string]: Promise<TenantBehavioursConfigs> | undefined

`Protected` `Readonly` behaviours

behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]

`Protected` `Readonly` g

g: GraphTraversalSource<GraphTraversal>

Methods

addBehaviourInstance

addBehaviourInstance(tenantId: string, entityType: string, config: InstanceConfig<string>): Promise<void>
Stores new instance of the Behaviour.

Note this method does NOT perform access checks!
Parameters
- tenantId: string
  
  The tenant ID from request.
- entityType: string
  
  The entity type. Note that it may be either real schema item type (e.g. vertex label) OR a virtual content type, depending on the way Behaviours are attached.
- config: InstanceConfig<string>
  
  The behaviour configuration, including behaviour type.
Returns Promise<void>
- Defined in src/behaviours/BehavioursInstanceManager.ts:220

getBehaviourByName

getBehaviourByName<TName>(name: TName, required: false): undefined | BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>
Retrieves a Behaviour service by its name.
Type Parameters
- TName extends string
Parameters
- name: TName
  
  The behaviour machine name.
- required: false
  
  Whether the Behaviour is required. An instance of BehaviourInstanceConfigError would be thrown is required is true but no such behaviour exists.
Returns undefined | BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>
- Defined in src/behaviours/BehavioursInstanceManager.ts:122
getBehaviourByName<TName>(name: TName, required?: true): BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>
Type Parameters
- TName extends string
Parameters
- name: TName
- Optional required: true
Returns BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>
- Defined in src/behaviours/BehavioursInstanceManager.ts:126

getInstanceConfig

getInstanceConfig<TName>(tenantId: string, entityType: string, machineName: TName, required?: false): Promise<null | InstanceConfig<TName>>
Retrieves Behaviour instance config.
Type Parameters
- TName extends string
Parameters
- tenantId: string
  
  The tenant ID from request.
- entityType: string
  
  The entity type. Note that it may be either real schema item type (e.g. vertex label) OR a virtual content type, depending on the way Behaviours are attached.
- machineName: TName
  
  The behaviour machine name.
- Optional required: false
  
  Whether the config is required; used to overload the method.
Returns Promise<null | InstanceConfig<TName>>
- Defined in src/behaviours/BehavioursInstanceManager.ts:171
getInstanceConfig<TName>(tenantId: string, entityType: string, machineName: TName, required: true): Promise<InstanceConfig<TName>>
Type Parameters
- TName extends string
Parameters
- tenantId: string
- entityType: string
- machineName: TName
- required: true
Returns Promise<InstanceConfig<TName>>
- Defined in src/behaviours/BehavioursInstanceManager.ts:177

listBehavioursInstances

listBehavioursInstances(tenantId: string, entityType: string): Promise<BehavioursConfigsByName>
Lists all enabled Behaviours instances for a specific tenant and entity type.
Parameters
- tenantId: string
  
  The tenant ID from request.
- entityType: string
  
  The entity type. Note that it may be either real schema item type (e.g. vertex label) OR a virtual content type, depending on the way Behaviours are attached.
Returns Promise<BehavioursConfigsByName>
- Defined in src/behaviours/BehavioursInstanceManager.ts:153

`Private` reloadInstances

reloadInstances(tenantId: string): void
Reloads Behaviours instances list at runtime.
Parameters
- tenantId: string
Returns void
- Defined in src/behaviours/BehavioursInstanceManager.ts:108

removeBehaviourInstance

removeBehaviourInstance(tenantId: string, entityType: string, machineName: string): Promise<void>
Removes Behaviour instance.

Note this method does NOT perform access checks!
Parameters
- tenantId: string
  
  The tenant ID from request.
- entityType: string
  
  The entity type. Note that it may be either real schema item type (e.g. vertex label) OR a virtual content type, depending on the way Behaviours are attached.
- machineName: string
  
  The behaviour machine name.
Returns Promise<void>
- Defined in src/behaviours/BehavioursInstanceManager.ts:261

tenantInstances

tenantInstances(tenantId: string): Promise<TenantBehavioursConfigs>
Retrieves Behaviours instances configurations for a specific tenant.
Parameters
- tenantId: string
  
  The tenant ID.
Returns Promise<TenantBehavioursConfigs>
- Defined in src/behaviours/BehavioursInstanceManager.ts:56

`Private` validateInstanceConfig

validateInstanceConfig(config: InstanceConfig<string>): void
Validates Behaviour instance configuration.
Parameters
- config: InstanceConfig<string>
  
  The configuration object built from user input.
Returns void
- Defined in src/behaviours/BehavioursInstanceManager.ts:288

Class BehavioursInstanceManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

behaviours: BehaviourBase<string, KosmosConfig<string>, InstanceConfig<string>>[]

g: GraphTraversalSource<GraphTraversal>

Returns BehavioursInstanceManager

Properties

Private Readonly _instanceConfigs

Type declaration

[tenantId: string]: Promise<TenantBehavioursConfigs> | undefined

Protected Readonly behaviours

Protected Readonly g

Methods

addBehaviourInstance

Parameters

tenantId: string

entityType: string

config: InstanceConfig<string>

Returns Promise<void>

getBehaviourByName

Type Parameters

TName extends string

Parameters

name: TName

required: false

Returns undefined | BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>

Type Parameters

TName extends string

Parameters

name: TName

Optional required: true

Returns BehaviourBase<TName, KosmosConfig<TName>, InstanceConfig<TName>>

getInstanceConfig

Type Parameters

TName extends string

Parameters

tenantId: string

entityType: string

machineName: TName

Optional required: false

Returns Promise<null | InstanceConfig<TName>>

Type Parameters

TName extends string

Parameters

tenantId: string

entityType: string

machineName: TName

required: true

Returns Promise<InstanceConfig<TName>>

listBehavioursInstances

Parameters

tenantId: string

entityType: string

Returns Promise<BehavioursConfigsByName>

Private reloadInstances

Parameters

tenantId: string

Returns void

removeBehaviourInstance

Parameters

tenantId: string

entityType: string

machineName: string

Returns Promise<void>

tenantInstances

Parameters

tenantId: string

Returns Promise<TenantBehavioursConfigs>

Private validateInstanceConfig

Parameters

config: InstanceConfig<string>

Returns void

Settings

Member Visibility

`Private` `Readonly` _instanceConfigs

`Protected` `Readonly` behaviours

`Protected` `Readonly` g

`Optional` required: true

`Optional` required: false

`Private` reloadInstances

`Private` validateInstanceConfig