feat(core-api): plugin async initializer method

Signed-off-by: TonyRowntree <33454202+TonyRowntree@users.noreply.github.com>
hyperledger · Jun 26, 2021 · 9678c2e · 9678c2e
1 parent 63f5ff6
commit 9678c2e
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 0 deletions.
diff --git a/packages/cactus-core-api/src/main/typescript/plugin/i-cactus-plugin.ts b/packages/cactus-core-api/src/main/typescript/plugin/i-cactus-plugin.ts
@@ -68,6 +68,8 @@ export interface ICactusPlugin {
    * Hyperledger Besu deployment)
    */
   getPackageName(): string;
+
+  onPluginInit(): Promise<unknown>;
 }
 
 export function isICactusPlugin(x: unknown): x is ICactusPlugin {

diff --git a/packages/cactus-plugin-consortium-manual/src/main/typescript/plugin-consortium-manual.ts b/packages/cactus-plugin-consortium-manual/src/main/typescript/plugin-consortium-manual.ts
@@ -91,6 +91,10 @@ export class PluginConsortiumManual
     return this.instanceId;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public getPrometheusExporter(): PrometheusExporter {
     return this.prometheusExporter;
   }

diff --git a/packages/cactus-plugin-htlc-eth-besu-erc20/src/main/typescript/plugin-htlc-eth-besu-erc20.ts b/packages/cactus-plugin-htlc-eth-besu-erc20/src/main/typescript/plugin-htlc-eth-besu-erc20.ts
@@ -74,6 +74,10 @@ export class PluginHtlcEthBesuErc20
     return;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public getInstanceId(): string {
     return this.instanceId;
   }

diff --git a/packages/cactus-plugin-htlc-eth-besu/src/main/typescript/plugin-htlc-eth-besu.ts b/packages/cactus-plugin-htlc-eth-besu/src/main/typescript/plugin-htlc-eth-besu.ts
@@ -83,6 +83,10 @@ export class PluginHtlcEthBesu implements ICactusPlugin, IPluginWebService {
     return "@hyperledger/cactus-plugin-htlc-eth-besu";
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   async registerWebServices(app: Express): Promise<IWebServiceEndpoint[]> {
     const webServices = await this.getOrCreateWebServices();
     webServices.forEach((ws) => ws.registerExpress(app));

diff --git a/packages/cactus-plugin-keychain-memory/src/main/typescript/plugin-keychain-memory.ts b/packages/cactus-plugin-keychain-memory/src/main/typescript/plugin-keychain-memory.ts
@@ -112,6 +112,10 @@ export class PluginKeychainMemory {
     return `@hyperledger/cactus-plugin-keychain-memory`;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   async get<T>(key: string): Promise<T> {
     return this.backend.get(key) as T;
   }

diff --git a/packages/cactus-plugin-keychain-vault/src/main/typescript/plugin-keychain-vault.ts b/packages/cactus-plugin-keychain-vault/src/main/typescript/plugin-keychain-vault.ts
@@ -194,6 +194,10 @@ export class PluginKeychainVault implements ICactusPlugin, IPluginWebService {
     return `@hyperledger/cactus-plugin-keychain-vault`;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   async rotateEncryptionKeys(): Promise<void> {
     throw new Error("Method not implemented.");
   }

diff --git a/...s/cactus-plugin-ledger-connector-besu/src/main/typescript/plugin-ledger-connector-besu.ts b/...s/cactus-plugin-ledger-connector-besu/src/main/typescript/plugin-ledger-connector-besu.ts
@@ -155,6 +155,10 @@ export class PluginLedgerConnectorBesu
     return this.instanceId;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public getHttpServer(): Optional<Server | SecureServer> {
     return Optional.ofNullable(this.httpServer);
   }

diff --git a/...cactus-plugin-ledger-connector-corda/src/main/typescript/plugin-ledger-connector-corda.ts b/...cactus-plugin-ledger-connector-corda/src/main/typescript/plugin-ledger-connector-corda.ts
@@ -108,6 +108,10 @@ export class PluginLedgerConnectorCorda
     return "@hyperledger/cactus-plugin-ledger-connector-corda";
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public deployContract(): Promise<any> {
     throw new Error("Method not implemented.");
   }

diff --git a/...ctus-plugin-ledger-connector-fabric/src/main/typescript/plugin-ledger-connector-fabric.ts b/...ctus-plugin-ledger-connector-fabric/src/main/typescript/plugin-ledger-connector-fabric.ts
@@ -198,6 +198,10 @@ export class PluginLedgerConnectorFabric
     return Optional.empty();
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public async getConsensusAlgorithmFamily(): Promise<
     ConsensusAlgorithmFamily
   > {

diff --git a/...ctus-plugin-ledger-connector-quorum/src/main/typescript/plugin-ledger-connector-quorum.ts b/...ctus-plugin-ledger-connector-quorum/src/main/typescript/plugin-ledger-connector-quorum.ts
@@ -149,6 +149,10 @@ export class PluginLedgerConnectorQuorum
     }
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   async registerWebServices(app: Express): Promise<IWebServiceEndpoint[]> {
     const webServices = await this.getOrCreateWebServices();
     await Promise.all(webServices.map((ws) => ws.registerExpress(app)));

diff --git a/...s/cactus-plugin-ledger-connector-xdai/src/main/typescript/plugin-ledger-connector-xdai.ts b/...s/cactus-plugin-ledger-connector-xdai/src/main/typescript/plugin-ledger-connector-xdai.ts
@@ -140,6 +140,10 @@ export class PluginLedgerConnectorXdai
     return this.instanceId;
   }
 
+  public async onPluginInit(): Promise<unknown> {
+    return;
+  }
+
   public getHttpServer(): Optional<Server | SecureServer> {
     return Optional.ofNullable(this.httpServer);
   }