Service: access

Method settings

Retrieve settings for example for client configuration.

graph TD

Method publicKey

Retrieve public key of this instance.

graph TD

Method refresh

Allows to refresh JWT of a metering token (extend time to expiration)

Calls:

• access.verifySelf()
• access.createConcentratorJWT()
• access.createMeterJWT()

graph TD
   access.refresh --> access.verifySelf
   access.refresh --> access.createConcentratorJWT
   access.refresh --> access.createMeterJWT

Method createMeterActivationCode

Creates pre shared activation code for given meter

Calls:

• clientactivation.find()
• clientactivation.remove()
• access.randomString()
• clientactivation.insert()
• access.createMeterJWT()

graph TD
   access.createMeterActivationCode --> clientactivation.find
   access.createMeterActivationCode --> clientactivation.remove
   access.createMeterActivationCode --> access.randomString
   access.createMeterActivationCode --> clientactivation.insert
   access.createMeterActivationCode --> access.createMeterJWT

Method createMeterJWT

Create Token to authorize external reading updates of meter

Called by:

• access.refresh()
• access.createMeterActivationCode()
• access.activation()

graph TD
   access.refresh --> access.createMeterJWT
   access.createMeterActivationCode --> access.createMeterJWT
   access.activation --> access.createMeterJWT

Method demo

Create Token to authorize with demo user

graph TD

Method createReadingJWT

Create Token to verify reading updates of this instance.

Called by:

• metering.updateReading()

graph TD
   metering.updateReading --> access.createReadingJWT

Method createConcentratorJWT

Create wildcard Token to authorize external reading updates of meter

Called by:

• access.refresh()

graph TD
   access.refresh --> access.createConcentratorJWT

Method randomString

Creates a random String of given length.

Called by:

• access.createMeterActivationCode()
• access.activation()
• audit.requestApproval()
• contract.add()
• nextcloud.createAssetShare()

graph TD
   access.createMeterActivationCode --> access.randomString
   access.activation --> access.randomString
   audit.requestApproval --> access.randomString
   contract.add --> access.randomString
   nextcloud.createAssetShare --> access.randomString

Method activation

Provides update token for automated meter readings.

Calls:

• clientactivation.find()
• clientactivation.remove()
• access.randomString()
• clientactivation.insert()
• access.createMeterJWT()

graph TD
   access.activation --> clientactivation.find
   access.activation --> clientactivation.remove
   access.activation --> access.randomString
   access.activation --> clientactivation.insert
   access.activation --> access.createMeterJWT

Method createTariffJWT

Create Token to verify tariff labels of this instance.

Called by:

• tariff.prices()

graph TD
   tariff.prices --> access.createTariffJWT

Method createClearingJWT

Create Token to verify clearings of this instance.

Called by:

• clearing.commit()

graph TD
   clearing.commit --> access.createClearingJWT

Method createInvoiceJWT

Create Token to verify invoices of this instance.

Called by:

• debit.closeBilling()

graph TD
   debit.closeBilling --> access.createInvoiceJWT

Method verifySelf

Verify signing token is this instance.

Called by:

• access.refresh()
• metering.updateReading()

graph TD
   access.refresh --> access.verifySelf
   metering.updateReading --> access.verifySelf

Method updateAssetMeta

Update client specific asset meta data. Use dot notation for nested fields (sub documents)

Calls:

• asset.upsert()

graph TD
   access.updateAssetMeta --> asset.upsert

Method sharedFolder

Calls:

• nextcloud.createAssetShare()
• asset.get()

graph TD
   access.sharedFolder --> nextcloud.createAssetShare
   access.sharedFolder --> asset.get

Method getAssetMeta

Retrieve Metadata of client specific asset.

Calls:

• asset.get()
• asset.get()
• asset.get()

graph TD
   access.getAssetMeta --> asset.get
   access.getAssetMeta --> asset.get
   access.getAssetMeta --> asset.get