Class CommissioningServerFailsafeContext

FailsafeContext implementation for EndpointInterface API.

Hierarchy (view full)

FailsafeContext
- CommissioningServerFailsafeContext

Constructors

constructor

new CommissioningServerFailsafeContext(rootEndpoint, options): CommissioningServerFailsafeContext
Parameters
- rootEndpoint: Endpoint
- options: Options
Returns CommissioningServerFailsafeContext
Overrides FailsafeContext.constructor
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:23

Accessors

associatedFabric

get associatedFabric(): undefined | Fabric
Returns undefined | Fabric
Inherited from FailsafeContext.associatedFabric
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:30

commissioned

get commissioned(): AsyncObservable<[], void>
Returns AsyncObservable<[], void>
Inherited from FailsafeContext.commissioned
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:29

construction

get construction(): Construction<FailsafeContext>
Returns Construction<FailsafeContext>
Inherited from FailsafeContext.construction
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:28

csrSessionId

get csrSessionId(): undefined | number
Returns undefined | number
Inherited from FailsafeContext.csrSessionId
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:31

fabricIndex

get fabricIndex(): undefined | FabricIndex
Returns undefined | FabricIndex
Inherited from FailsafeContext.fabricIndex
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:27

forUpdateNoc

get forUpdateNoc(): undefined | boolean
Returns undefined | boolean
Inherited from FailsafeContext.forUpdateNoc
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:32

hasRootCert

get hasRootCert(): boolean
Returns boolean
Inherited from FailsafeContext.hasRootCert
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:33

rootCert

get rootCert(): undefined | Uint8Array
Returns undefined | Uint8Array
Inherited from FailsafeContext.rootCert
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:34

Methods

addFabric

addFabric(fabric): Promise<FabricIndex>
Parameters
- fabric: Fabric
Returns Promise<FabricIndex>
Inherited from FailsafeContext.addFabric
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:38

buildFabric

buildFabric(nocData): Promise<Fabric>
Build a new Fabric object for a new fabric for the "AddNoc" case of the Operational Credentials cluster.
Parameters
- nocData: {
      adminVendorId: VendorId;
      caseAdminSubject: NodeId;
      icacValue: undefined | Uint8Array;
      ipkValue: Uint8Array;
      nocValue: Uint8Array;
  }
  - adminVendorId: VendorId
  - caseAdminSubject: NodeId
  - icacValue: undefined | Uint8Array
  - ipkValue: Uint8Array
  - nocValue: Uint8Array
Returns Promise<Fabric>
Inherited from FailsafeContext.buildFabric
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:55

buildUpdatedFabric

buildUpdatedFabric(nocValue, icacValue): Promise<Fabric>
Build a new Fabric object based on an existing fabric for the "UpdateNoc" case of the Operational Credentials cluster.
Parameters
- nocValue: Uint8Array
- icacValue: undefined | Uint8Array
Returns Promise<Fabric>
Inherited from FailsafeContext.buildUpdatedFabric
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:53

close

close(): Promise<void>
Returns Promise<void>
Inherited from FailsafeContext.close
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:46

completeCommission

completeCommission(): Promise<void>
Returns Promise<void>
Inherited from FailsafeContext.completeCommission
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:35

createCertificateSigningRequest

createCertificateSigningRequest(isForUpdateNoc, sessionId): Uint8Array
Handles a CSR from OperationalCredentials cluster and stores additional internal information for further validity checks.
Parameters
- isForUpdateNoc: boolean
- sessionId: number
Returns Uint8Array
Inherited from FailsafeContext.createCertificateSigningRequest
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:44

extend

extend(fabric, expiryLengthSeconds): Promise<void>
Parameters
- fabric: undefined | Fabric
- expiryLengthSeconds: number
Returns Promise<void>
Inherited from FailsafeContext.extend
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:26

getFailSafeContext

getFailSafeContext(): FailsafeTimer
Returns FailsafeTimer
Inherited from FailsafeContext.getFailSafeContext
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:36

getNextFabricIndex

getNextFabricIndex(): FabricIndex
Returns FabricIndex
Inherited from FailsafeContext.getNextFabricIndex
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:37

removePaseSession

removePaseSession(): Promise<void>
Returns Promise<void>
Inherited from FailsafeContext.removePaseSession
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:45

restoreBreadcrumb

restoreBreadcrumb(): Promise<void>
Returns Promise<void>
Overrides FailsafeContext.restoreBreadcrumb
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:60

restoreFabric

restoreFabric(fabric): Promise<void>
Parameters
- fabric: Fabric
Returns Promise<void>
Overrides FailsafeContext.restoreFabric
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:36

restoreNetworkState

restoreNetworkState(): Promise<void>
Restore Cluster data when the FailSafe context expired.

Returns Promise<void>
Overrides FailsafeContext.restoreNetworkState
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:43

revokeFabric

revokeFabric(fabric): Promise<void>
Parameters
- fabric: Fabric
Returns Promise<void>
Overrides FailsafeContext.revokeFabric
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:47

`Protected`rollback

rollback(): Promise<void>
Returns Promise<void>
Inherited from FailsafeContext.rollback
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:62

setRootCert

setRootCert(rootCert): void
Handles adding a trusted root certificate from Operational Credentials cluster.
Parameters
- rootCert: Uint8Array
Returns void
Inherited from FailsafeContext.setRootCert
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:48

storeEndpointState

storeEndpointState(): Promise<void>
Returns Promise<void>
Overrides FailsafeContext.storeEndpointState
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:32

updateFabric

updateFabric(fabric): Promise<void>
Parameters
- fabric: Fabric
Returns Promise<void>
Inherited from FailsafeContext.updateFabric
- Defined in packages/protocol/dist/esm/common/FailsafeContext.d.ts:39

`Static`create

create(rootEndpoint, options): Promise<CommissioningServerFailsafeContext>
Parameters
- rootEndpoint: Endpoint
- options: Options
Returns Promise<CommissioningServerFailsafeContext>
- Defined in packages/matter.js/src/cluster/server/CommissioningServerFailsafeContext.ts:28

Class CommissioningServerFailsafeContext

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CommissioningServerFailsafeContext

Accessors

associatedFabric

Returns undefined | Fabric

commissioned

Returns AsyncObservable<[], void>

construction

Returns Construction<FailsafeContext>

csrSessionId

Returns undefined | number

fabricIndex

Returns undefined | FabricIndex

forUpdateNoc

Returns undefined | boolean

hasRootCert

Returns boolean

rootCert

Returns undefined | Uint8Array

Methods

addFabric

Parameters

Returns Promise<FabricIndex>

buildFabric

Parameters

adminVendorId: VendorId

caseAdminSubject: NodeId

icacValue: undefined | Uint8Array

ipkValue: Uint8Array

nocValue: Uint8Array

Returns Promise<Fabric>

buildUpdatedFabric

Parameters

Returns Promise<Fabric>

close

Returns Promise<void>

completeCommission

Returns Promise<void>

createCertificateSigningRequest

Parameters

Returns Uint8Array

extend

Parameters

Returns Promise<void>

getFailSafeContext

Returns FailsafeTimer

getNextFabricIndex

Returns FabricIndex

removePaseSession

Returns Promise<void>

restoreBreadcrumb

Returns Promise<void>

restoreFabric

Parameters

Returns Promise<void>

restoreNetworkState

Returns Promise<void>

revokeFabric

Parameters

Returns Promise<void>

Protectedrollback

Returns Promise<void>

setRootCert

Parameters

Returns void

storeEndpointState

Returns Promise<void>

updateFabric

Parameters

Returns Promise<void>

Staticcreate

Parameters

`Protected`rollback

`Static`create