Class FailsafeContextAbstract

A "timed operation" is a command or sequence of commands that operate with a failsafe timer that will abort the operation if it does not complete within a specific window.

FailsafeContext maintains the failsafe timer and tracks information required to rollback state if the operation aborts.

Timed operations are exclusive for a node.

Constructors

constructor

Accessors

associatedFabric commissioned construction csrSessionId fabricIndex forUpdateNoc hasRootCert rootCert

Methods

addFabric buildFabric buildUpdatedFabric close completeCommission createCertificateSigningRequest extend getFailSafeContext getNextFabricIndex removePaseSession restoreBreadcrumb restoreFabric restoreNetworkState revokeFabric rollback setRootCert storeEndpointState updateFabric

Constructors

constructor

Accessors

associatedFabric

  • get associatedFabric(): undefined | Fabric

  • Returns undefined | Fabric

commissioned

construction

csrSessionId

  • get csrSessionId(): undefined | number

  • Returns undefined | number

fabricIndex

  • get fabricIndex(): undefined | FabricIndex

  • Returns undefined | FabricIndex

forUpdateNoc

  • get forUpdateNoc(): undefined | boolean

  • Returns undefined | boolean

hasRootCert

  • get hasRootCert(): boolean

  • Returns boolean

rootCert

  • get rootCert(): undefined | Uint8Array

  • Returns undefined | Uint8Array

Methods

addFabric

  • addFabric(fabric): Promise<FabricIndex>

  • Parameters

    Returns Promise<FabricIndex>

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>

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>

close

  • close(): Promise<void>

  • Returns Promise<void>

completeCommission

  • completeCommission(): Promise<void>

  • Returns Promise<void>

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

extend

  • extend(fabric, expiryLengthSeconds): Promise<void>

  • Parameters

    • fabric: undefined | Fabric
    • expiryLengthSeconds: number

    Returns Promise<void>

getFailSafeContext

getNextFabricIndex

  • getNextFabricIndex(): FabricIndex

  • Returns FabricIndex

removePaseSession

  • removePaseSession(): Promise<void>

  • Returns Promise<void>

AbstractrestoreBreadcrumb

  • restoreBreadcrumb(): Promise<void>

  • Returns Promise<void>

restoreFabric

  • restoreFabric(fabric): Promise<void>

  • Parameters

    Returns Promise<void>

AbstractrestoreNetworkState

  • restoreNetworkState(): Promise<void>

  • Restore Cluster data when the FailSafe context expired.

    Returns Promise<void>

AbstractrevokeFabric

  • revokeFabric(fabric): Promise<void>

  • Parameters

    Returns Promise<void>

Protectedrollback

  • rollback(): Promise<void>

  • Returns Promise<void>

setRootCert

  • setRootCert(rootCert): void

  • Handles adding a trusted root certificate from Operational Credentials cluster.

    Parameters

    • rootCert: Uint8Array

    Returns void

AbstractstoreEndpointState

  • storeEndpointState(): Promise<void>

  • Returns Promise<void>

updateFabric

  • updateFabric(fabric): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods