@itentialopensource/adapter-checkpoint_management 0.5.0 → 0.7.0

package/adapterBase.js

@@ -11,14 +11,18 @@
 /* eslint prefer-destructuring: warn */
 
 /* Required libraries.  */
-const fs = require('fs-extra');
 const path = require('path');
-const jsonQuery = require('json-query');
-const EventEmitterCl = require('events').EventEmitter;
 const { execSync } = require('child_process');
+const { spawnSync } = require('child_process');
+const EventEmitterCl = require('events').EventEmitter;
+const fs = require('fs-extra');
+const jsonQuery = require('json-query');
+
+const sampleProperties = require(`${__dirname}/sampleProperties.json`).properties;
 
 /* The schema validator */
 const AjvCl = require('ajv');
+const { Test } = require('mocha');
 
 /* Fetch in the other needed components for the this Adaptor */
 const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
@@ -27,8 +31,10 @@ const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHan
 const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
 const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
 const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
+const taskMover = require(path.join(__dirname, 'utils/taskMover'));
 
 let propUtil = null;
+let choosepath = null;
 
 /*
  * INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
@@ -101,7 +107,7 @@ function updateSchema(entityPath, configFile, changes) {
 /*
  * INTERNAL FUNCTION: update the mock data file
  */
-function updateMock(mockPath, configFile, changes) {
+function updateMock(mockPath, configFile, changes, replace) {
   // if the mock file does not exist - create it
   const mockFile = path.join(mockPath, `/${configFile}`);
   if (!fs.existsSync(mockFile)) {
@@ -113,7 +119,11 @@ function updateMock(mockPath, configFile, changes) {
   let mock = require(path.resolve(mockPath, configFile));
 
   // merge the changes into the mock file
-  mock = propUtil.mergeProperties(changes, mock);
+  if (replace === true) {
+    mock = changes;
+  } else {
+    mock = propUtil.mergeProperties(changes, mock);
+  }
 
   fs.writeFileSync(mockFile, JSON.stringify(mock, null, 2));
   return null;
@@ -145,27 +155,6 @@ function updatePackage(changes) {
   return null;
 }
 
-/*
- * INTERNAL FUNCTION: get data from source(s) - nested
- */
-function getDataFromSources(loopField, sources) {
-  let fieldValue = loopField;
-
-  // go through the sources to find the field
-  for (let s = 0; s < sources.length; s += 1) {
-    // find the field value using jsonquery
-    const nestedValue = jsonQuery(loopField, { data: sources[s] }).value;
-
-    // if we found in source - set and no need to check other sources
-    if (nestedValue) {
-      fieldValue = nestedValue;
-      break;
-    }
-  }
-
-  return fieldValue;
-}
-
 /* GENERAL ADAPTER FUNCTIONS THESE SHOULD NOT BE DIRECTLY MODIFIED */
 /* IF YOU NEED MODIFICATIONS, REDEFINE THEM IN adapter.js!!! */
 class AdapterBase extends EventEmitterCl {
@@ -255,7 +244,7 @@ class AdapterBase extends EventEmitterCl {
       this.allProps = this.propUtilInst.mergeProperties(properties, defProps);
 
       // validate the entity against the schema
-      const ajvInst = new AjvCl();
+      const ajvInst = new AjvCl({ strictSchema: false, allowUnionTypes: true });
       const validate = ajvInst.compile(propertiesSchema);
       const result = validate(this.allProps);
 
@@ -379,9 +368,15 @@ class AdapterBase extends EventEmitterCl {
           this.emit('OFFLINE', { id: this.id });
           this.emit('DEGRADED', { id: this.id });
           this.healthy = false;
-          log.error(`${origin}: HEALTH CHECK - Error ${error}`);
-        } else {
+          if (typeof error === 'object') {
+            log.error(`${origin}: HEALTH CHECK - Error ${JSON.stringify(error)}`);
+          } else {
+            log.error(`${origin}: HEALTH CHECK - Error ${error}`);
+          }
+        } else if (typeof error === 'object') {
           // still log but set the level to trace
+          log.trace(`${origin}: HEALTH CHECK - Still Errors ${JSON.stringify(error)}`);
+        } else {
           log.trace(`${origin}: HEALTH CHECK - Still Errors ${error}`);
         }
 
@@ -427,6 +422,40 @@ class AdapterBase extends EventEmitterCl {
     return myfunctions;
   }
 
+  /**
+   * iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
+   * @param {array} ignoreThese - additional methods to ignore (optional)
+   *
+   * @function iapGetAdapterWorkflowFunctions
+   */
+  iapGetAdapterWorkflowFunctions(ignoreThese) {
+    const myfunctions = this.getAllFunctions();
+    const wffunctions = [];
+
+    // remove the functions that should not be in a Workflow
+    for (let m = 0; m < myfunctions.length; m += 1) {
+      if (myfunctions[m] === 'checkActionFiles') {
+        // got to the second tier (adapterBase)
+        break;
+      }
+      if (!(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
+        let found = false;
+        if (ignoreThese && Array.isArray(ignoreThese)) {
+          for (let i = 0; i < ignoreThese.length; i += 1) {
+            if (myfunctions[m].toUpperCase() === ignoreThese[i].toUpperCase()) {
+              found = true;
+            }
+          }
+        }
+        if (!found) {
+          wffunctions.push(myfunctions[m]);
+        }
+      }
+    }
+
+    return wffunctions;
+  }
+
   /**
    * checkActionFiles is used to update the validation of the action files.
    *
@@ -482,40 +511,6 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.encryptProperty(property, technique, callback);
   }
 
-  /**
-   * iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
-   * @param {array} ignoreThese - additional methods to ignore (optional)
-   *
-   * @function iapGetAdapterWorkflowFunctions
-   */
-  iapGetAdapterWorkflowFunctions(ignoreThese) {
-    const myfunctions = this.getAllFunctions();
-    const wffunctions = [];
-
-    // remove the functions that should not be in a Workflow
-    for (let m = 0; m < myfunctions.length; m += 1) {
-      if (myfunctions[m] === 'addEntityCache') {
-        // got to the second tier (adapterBase)
-        break;
-      }
-      if (!(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
-        let found = false;
-        if (ignoreThese && Array.isArray(ignoreThese)) {
-          for (let i = 0; i < ignoreThese.length; i += 1) {
-            if (myfunctions[m].toUpperCase() === ignoreThese[i].toUpperCase()) {
-              found = true;
-            }
-          }
-        }
-        if (!found) {
-          wffunctions.push(myfunctions[m]);
-        }
-      }
-    }
-
-    return wffunctions;
-  }
-
   /**
    * iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
    * allows customers to make changes to adapter configuration without having to be on the
@@ -527,16 +522,17 @@ class AdapterBase extends EventEmitterCl {
    * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
    * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
    * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
+   * @param {boolean} replace - true to replace entire mock data, false to merge/append (optional)
    * @param {Callback} callback - The results of the call
    */
-  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback) {
     const meth = 'adapterBase-iapUpdateAdapterConfiguration';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
     // verify the parameters are valid
     if (changes === undefined || changes === null || typeof changes !== 'object'
-        || Object.keys(changes).length === 0) {
+      || Object.keys(changes).length === 0) {
       const result = {
         response: 'No configuration updates to make'
       };
@@ -621,8 +617,14 @@ class AdapterBase extends EventEmitterCl {
       if (!fs.existsSync(mpath)) {
         fs.mkdirSync(mpath);
       }
+      // this means we are changing a mock data file so replace is required
+      if (replace === undefined || replace === null || replace === '') {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['replace'], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const mres = updateMock(mpath, configFile, changes, replace);
 
-      const mres = updateMock(mpath, configFile, changes);
       if (mres) {
         const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
@@ -639,6 +641,86 @@ class AdapterBase extends EventEmitterCl {
     return callback(null, errorObj);
   }
 
+  /**
+   * @summary Suspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   * @function iapSuspendAdapter
+   */
+  iapSuspendAdapter(mode, callback) {
+    const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
+    if (this.suspended) {
+      throw new Error(`${origin}: Adapter is already suspended`);
+    }
+    try {
+      this.suspended = true;
+      this.suspendMode = mode;
+      if (this.suspendMode === 'pause') {
+        const props = JSON.parse(JSON.stringify(this.initProps));
+        // To suspend adapter, enable throttling and set concurrent max to 0
+        props.throttle.throttle_enabled = true;
+        props.throttle.concurrent_max = 0;
+        this.refreshProperties(props);
+      }
+      return callback({ suspended: true });
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary Unsuspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   *
+   * @function iapUnsuspendAdapter
+   */
+  iapUnsuspendAdapter(callback) {
+    const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
+    if (!this.suspended) {
+      throw new Error(`${origin}: Adapter is not suspended`);
+    }
+    if (this.suspendMode === 'pause') {
+      const props = JSON.parse(JSON.stringify(this.initProps));
+      // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
+      props.throttle.throttle_enabled = true;
+      props.throttle.concurrent_max = 1;
+      this.refreshProperties(props);
+      setTimeout(() => {
+        this.getQueue((q, error) => {
+          // console.log("Items in queue: " + String(q.length))
+          if (q.length === 0) {
+            // if queue is empty, return to initial properties state
+            this.refreshProperties(this.initProps);
+            this.suspended = false;
+            return callback({ suspended: false });
+          }
+          // recursive call to check queue again every second
+          return this.iapUnsuspendAdapter(callback);
+        });
+      }, 1000);
+    } else {
+      this.suspended = false;
+      callback({ suspend: false });
+    }
+  }
+
+  /**
+   * iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
+   *
+   * @function iapGetAdapterQueue
+   * @param {Callback} callback - a callback function to return the result (Queue) or the error
+   */
+  iapGetAdapterQueue(callback) {
+    const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getQueue(callback);
+  }
+
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES ADAPTER SCRIPTS               */
+  /*                                                */
+  /* ********************************************** */
   /**
    * See if the API path provided is found in this adapter
    *
@@ -659,6 +741,10 @@ class AdapterBase extends EventEmitterCl {
       return callback(null, result);
     }
 
+    if (typeof this.allProps.choosepath === 'string') {
+      choosepath = this.allProps.choosepath;
+    }
+
     // make sure the entities directory exists
     const entitydir = path.join(__dirname, 'entities');
     if (!fs.statSync(entitydir).isDirectory()) {
@@ -683,7 +769,25 @@ class AdapterBase extends EventEmitterCl {
 
           // go through all of the actions set the appropriate info in the newActions
           for (let a = 0; a < actions.actions.length; a += 1) {
-            if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
+            if (actions.actions[a].entitypath && typeof actions.actions[a].entitypath === 'object') {
+              const entityKeys = Object.keys(actions.actions[a].entitypath);
+              if (entityKeys.length > 0) {
+                for (let entityKey = 0; entityKey < entityKeys.length; entityKey += 1) {
+                  if (choosepath && entityKeys[entityKey] === choosepath && actions.actions[a].entitypath[entityKeys[entityKey]].indexOf(apiPath) >= 0) {
+                    log.info(`  Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
+                    log.info(`          method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath[entityKeys[entityKey]]}`);
+                    const fitem = {
+                      entity: entities[e],
+                      action: actions.actions[a].name,
+                      method: actions.actions[a].method,
+                      path: actions.actions[a].entitypath[entityKeys[entityKey]]
+                    };
+                    fitems.push(fitem);
+                    break;
+                  }
+                }
+              }
+            } else if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
               log.info(`  Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
               log.info(`          method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath}`);
               const fitem = {
@@ -722,81 +826,6 @@ class AdapterBase extends EventEmitterCl {
     return callback(result, null);
   }
 
-  /**
-   * @summary Suspends the adapter
-   * @param {Callback} callback - The adapater suspension status
-   * @function iapSuspendAdapter
-   */
-  iapSuspendAdapter(mode, callback) {
-    const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
-    if (this.suspended) {
-      throw new Error(`${origin}: Adapter is already suspended`);
-    }
-    try {
-      this.suspended = true;
-      this.suspendMode = mode;
-      if (this.suspendMode === 'pause') {
-        const props = JSON.parse(JSON.stringify(this.initProps));
-        // To suspend adapter, enable throttling and set concurrent max to 0
-        props.throttle.throttle_enabled = true;
-        props.throttle.concurrent_max = 0;
-        this.refreshProperties(props);
-      }
-      return callback({ suspended: true });
-    } catch (error) {
-      return callback(null, error);
-    }
-  }
-
-  /**
-   * @summary Unsuspends the adapter
-   * @param {Callback} callback - The adapater suspension status
-   *
-   * @function iapUnsuspendAdapter
-   */
-  iapUnsuspendAdapter(callback) {
-    const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
-    if (!this.suspended) {
-      throw new Error(`${origin}: Adapter is not suspended`);
-    }
-    if (this.suspendMode === 'pause') {
-      const props = JSON.parse(JSON.stringify(this.initProps));
-      // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
-      props.throttle.throttle_enabled = true;
-      props.throttle.concurrent_max = 1;
-      this.refreshProperties(props);
-      setTimeout(() => {
-        this.getQueue((q, error) => {
-          // console.log("Items in queue: " + String(q.length))
-          if (q.length === 0) {
-            // if queue is empty, return to initial properties state
-            this.refreshProperties(this.initProps);
-            this.suspended = false;
-            return callback({ suspended: false });
-          }
-          // recursive call to check queue again every second
-          return this.iapUnsuspendAdapter(callback);
-        });
-      }, 1000);
-    } else {
-      this.suspended = false;
-      callback({ suspend: false });
-    }
-  }
-
-  /**
-   * iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
-   *
-   * @function iapGetAdapterQueue
-   * @param {Callback} callback - a callback function to return the result (Queue) or the error
-   */
-  iapGetAdapterQueue(callback) {
-    const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
-    log.trace(origin);
-
-    return this.requestHandlerInst.getQueue(callback);
-  }
-
   /**
    * @summary runs troubleshoot scripts for adapter
    *
@@ -831,7 +860,7 @@ class AdapterBase extends EventEmitterCl {
       if (result) {
         return callback(result);
       }
-      return callback(null, result);
+      return callback(null, 'Healthcheck failed');
     } catch (error) {
       return callback(null, error);
     }
@@ -846,8 +875,7 @@ class AdapterBase extends EventEmitterCl {
    */
   async iapRunAdapterConnectivity(callback) {
     try {
-      const { serviceItem } = await tbUtils.getAdapterConfig();
-      const { host } = serviceItem.properties.properties;
+      const { host } = this.allProps;
       const result = tbUtils.runConnectivity(host, false);
       if (result.failCount > 0) {
         return callback(null, result);
@@ -899,156 +927,89 @@ class AdapterBase extends EventEmitterCl {
   }
 
   /**
-   * @summary take the entities and add them to the cache
-   *
-   * @function addEntityCache
-   * @param {String} entityType - the type of the entities
-   * @param {Array} data - the list of entities
-   * @param {String} key - unique key for the entities
+   * @function iapDeactivateTasks
    *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
+   * @param {Array} tasks - List of tasks to deactivate
+   * @param {Callback} callback
    */
-  addEntityCache(entityType, entities, key, callback) {
-    const meth = 'adapterBase-addEntityCache';
+  iapDeactivateTasks(tasks, callback) {
+    const meth = 'adapterBase-iapDeactivateTasks';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
-
-    // list containing the items to add to the cache
-    const entityIds = [];
-
-    if (entities && Object.hasOwnProperty.call(entities, 'response')
-        && Array.isArray(entities.response)) {
-      for (let e = 0; e < entities.response.length; e += 1) {
-        entityIds.push(entities.response[e][key]);
-      }
+    let data;
+    try {
+      data = taskMover.deactivateTasks(__dirname, tasks);
+    } catch (ex) {
+      taskMover.rollbackChanges(__dirname);
+      taskMover.deleteBackups(__dirname);
+      return callback(null, ex);
     }
-
-    // add the entities to the cache
-    return this.requestHandlerInst.addEntityCache(entityType, entityIds, (loaded, error) => {
-      if (error) {
-        return callback(null, error);
-      }
-      if (!loaded) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Entity Cache Not Loading', [entityType], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        return callback(null, errorObj);
-      }
-
-      return callback(loaded);
-    });
-  }
+    taskMover.deleteBackups(__dirname);
+    return callback(data, null);
+  }
 
   /**
-   * @summary sees if the entity is in the entity list or not
-   *
-   * @function entityInList
-   * @param {String/Array} entityId - the specific entity we are looking for
-   * @param {Array} data - the list of entities
+   * @function iapActivateTasks
    *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
+   * @param {Array} tasks - List of tasks to deactivate
+   * @param {Callback} callback
    */
-  entityInList(entityId, data) {
-    const origin = `${this.id}-adapterBase-entityInList`;
+  iapActivateTasks(tasks, callback) {
+    const meth = 'adapterBase-iapActivateTasks';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
-
-    // need to check on the entities that were passed in
-    if (Array.isArray(entityId)) {
-      const resEntity = [];
-
-      for (let e = 0; e < entityId.length; e += 1) {
-        if (data.includes(entityId[e])) {
-          resEntity.push(true);
-        } else {
-          resEntity.push(false);
-        }
-      }
-
-      return resEntity;
+    let data;
+    try {
+      data = taskMover.activateTasks(__dirname, tasks);
+    } catch (ex) {
+      taskMover.rollbackChanges(__dirname);
+      taskMover.deleteBackups(__dirname);
+      return callback(null, ex);
     }
-
-    // does the entity list include the specific entity
-    return [data.includes(entityId)];
+    taskMover.deleteBackups(__dirname);
+    return callback(data, null);
   }
 
+  /* ********************************************** */
+  /*                                                */
+  /*            EXPOSES CACHE CALLS                 */
+  /*                                                */
+  /* ********************************************** */
   /**
-   * @summary prepare results for verify capability so they are true/false
+   * @summary Populate the cache for the given entities
    *
-   * @function capabilityResults
-   * @param {Array} results - the results from the capability check
-   *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
+   * @function iapPopulateEntityCache
+   * @param {String/Array of Strings} entityType - the entity type(s) to populate
+   * @param {Callback} callback - whether the cache was updated or not for each entity type
+   * @returns return of the callback
    */
-  capabilityResults(results, callback) {
-    const meth = 'adapterBase-capabilityResults';
-    const origin = `${this.id}-${meth}`;
+  iapPopulateEntityCache(entityTypes, callback) {
+    const origin = `${this.myid}-adapterBase-iapPopulateEntityCache`;
     log.trace(origin);
-    let locResults = results;
 
-    if (locResults && locResults[0] === 'needupdate') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Entity Cache Not Loading', ['unknown'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      this.repeatCacheCount += 1;
-      return callback(null, errorObj);
-    }
-
-    // if an error occured, return the error
-    if (locResults && locResults[0] === 'error') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Error Verifying Entity Cache', null, null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // go through the response and change to true/false
-    if (locResults) {
-      // if not an array, just convert the return
-      if (!Array.isArray(locResults)) {
-        if (locResults === 'found') {
-          locResults = [true];
-        } else {
-          locResults = [false];
-        }
-      } else {
-        const temp = [];
-
-        // go through each element in the array to convert
-        for (let r = 0; r < locResults.length; r += 1) {
-          if (locResults[r] === 'found') {
-            temp.push(true);
-          } else {
-            temp.push(false);
-          }
-        }
-        locResults = temp;
-      }
-    }
-
-    // return the results
-    return callback(locResults);
+    return this.requestHandlerInst.populateEntityCache(entityTypes, callback);
   }
 
   /**
-   * @summary Provides a way for the adapter to tell north bound integrations
-   * all of the capabilities for the current adapter
+   * @summary Retrieves data from cache for specified entity type
    *
-   * @function getAllCapabilities
-   *
-   * @return {Array} - containing the entities and the actions available on each entity
+   * @function iapRetrieveEntitiesCache
+   * @param {String} entityType - entity of which to retrieve
+   * @param {Object} options - settings of which data to return and how to return it
+   * @param {Callback} callback - the data if it was retrieved
    */
-  getAllCapabilities() {
-    const origin = `${this.id}-adapterBase-getAllCapabilities`;
+  iapRetrieveEntitiesCache(entityType, options, callback) {
+    const origin = `${this.myid}-adapterBase-iapRetrieveEntitiesCache`;
     log.trace(origin);
 
-    // validate the capabilities for the adapter
-    try {
-      return this.requestHandlerInst.getAllCapabilities();
-    } catch (e) {
-      return [];
-    }
+    return this.requestHandlerInst.retrieveEntitiesCache(entityType, options, callback);
   }
 
+  /* ********************************************** */
+  /*                                                */
+  /*           EXPOSES BROKER CALLS                 */
+  /*                                                */
+  /* ********************************************** */
   /**
    * @summary Determines if this adapter supports any in a list of entities
    *
@@ -1060,716 +1021,322 @@ class AdapterBase extends EventEmitterCl {
    *                              value is true or false
    */
   hasEntities(entityType, entityList, callback) {
-    const origin = `${this.id}-adapter-hasEntities`;
+    const origin = `${this.id}-adapterBase-hasEntities`;
     log.trace(origin);
 
-    switch (entityType) {
-      case 'Device':
-        return this.hasDevices(entityList, callback);
-      default:
-        return callback(null, `${this.id} does not support entity ${entityType}`);
-    }
+    return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
   }
 
   /**
-   * @summary Helper method for hasEntities for the specific device case
+   * @summary Get Appliance that match the deviceName
    *
-   * @param {Array} deviceList - array of unique device identifiers
-   * @param {Callback} callback - A map where the device is the key and the
-   *                              value is true or false
+   * @function getDevice
+   * @param {String} deviceName - the deviceName to find (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
    */
-  hasDevices(deviceList, callback) {
-    const origin = `${this.id}-adapter-hasDevices`;
+  getDevice(deviceName, callback) {
+    const origin = `${this.id}-adapterBase-getDevice`;
     log.trace(origin);
 
-    const findings = deviceList.reduce((map, device) => {
-      // eslint-disable-next-line no-param-reassign
-      map[device] = false;
-      log.debug(`In reduce: ${JSON.stringify(map)}`);
-      return map;
-    }, {});
-    const apiCalls = deviceList.map((device) => new Promise((resolve) => {
-      this.getDevice(device, (result, error) => {
-        if (error) {
-          log.debug(`In map error: ${JSON.stringify(device)}`);
-          return resolve({ name: device, found: false });
-        }
-        log.debug(`In map: ${JSON.stringify(device)}`);
-        return resolve({ name: device, found: true });
-      });
-    }));
-    Promise.all(apiCalls).then((results) => {
-      results.forEach((device) => {
-        findings[device.name] = device.found;
-      });
-      log.debug(`FINDINGS: ${JSON.stringify(findings)}`);
-      return callback(findings);
-    }).catch((errors) => {
-      log.error('Unable to do device lookup.');
-      return callback(null, { code: 503, message: 'Unable to do device lookup.', error: errors });
-    });
+    return this.requestHandlerInst.getDevice(deviceName, callback);
   }
 
   /**
-   * @summary Make one of the needed Broker calls - could be one of many
+   * @summary Get Appliances that match the filter
    *
-   * @function iapMakeBrokerCall
-   * @param {string} brokCall - the name of the broker call (required)
-   * @param {object} callProps - the proeprties for the broker call (required)
-   * @param {object} devResp - the device details to extract needed inputs (required)
-   * @param {string} filterName - any filter to search on (required)
+   * @function getDevicesFiltered
+   * @param {Object} options - the data to use to filter the appliances (optional)
    *
-   * @param {getCallback} callback - a callback function to return the result of the call
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
    */
-  iapMakeBrokerCall(brokCall, callProps, devResp, filterName, callback) {
-    const meth = 'adapterBase-iapMakeBrokerCall';
-    const origin = `${this.id}-${meth}`;
+  getDevicesFiltered(options, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFiltered`;
     log.trace(origin);
 
-    try {
-      let uriPath = '';
-      let uriMethod = 'GET';
-      let callQuery = {};
-      let callBody = {};
-      let callHeaders = {};
-      let handleFail = 'fail';
-      let ostypePrefix = '';
-      let statusValue = 'true';
-      if (callProps.path) {
-        uriPath = `${callProps.path}`;
-
-        // make any necessary changes to the path
-        if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-          const rqKeys = Object.keys(callProps.requestFields);
-
-          // get the field from the provided device
-          for (let rq = 0; rq < rqKeys.length; rq += 1) {
-            const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-            // put the value into the path - if it has been specified in the path
-            uriPath = uriPath.replace(`{${rqKeys[rq]}}`, fieldValue);
-          }
-        }
-      }
-      if (callProps.method) {
-        uriMethod = callProps.method;
-      }
-      if (callProps.query) {
-        callQuery = callProps.query;
-
-        // go through the query params to check for variable values
-        const cpKeys = Object.keys(callQuery);
-        for (let cp = 0; cp < cpKeys.length; cp += 1) {
-          if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (cpKeys[cp] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callQuery[cpKeys[cp]] = fieldValue;
-                }
-              }
-            }
-          }
-        }
-      }
-      if (callProps.body) {
-        callBody = callProps.body;
-
-        // go through the body fields to check for variable values
-        const cbKeys = Object.keys(callBody);
-        for (let cb = 0; cb < cbKeys.length; cb += 1) {
-          if (callBody[cbKeys[cb]].startsWith('{') && callBody[cbKeys[cb]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (cbKeys[cb] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callBody[cbKeys[cb]] = fieldValue;
-                }
-              }
-            }
-          }
-        }
-      }
-      if (callProps.headers) {
-        callHeaders = callProps.headers;
-
-        // go through the body fields to check for variable values
-        const chKeys = Object.keys(callHeaders);
-        for (let ch = 0; ch < chKeys.length; ch += 1) {
-          if (callHeaders[chKeys[ch]].startsWith('{') && callHeaders[chKeys[ch]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (chKeys[ch] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callHeaders[chKeys[ch]] = fieldValue;
-                }
-              }
-            }
-          }
-        }
-      }
-      if (callProps.handleFailure) {
-        handleFail = callProps.handleFailure;
-      }
-      if (callProps.responseFields && callProps.responseFields.ostypePrefix) {
-        ostypePrefix = callProps.responseFields.ostypePrefix;
-      }
-      if (callProps.responseFields && callProps.responseFields.statusValue) {
-        statusValue = callProps.responseFields.statusValue;
-      }
-
-      // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
-      // !! you can also replace with a specific call if that is easier
-      return this.genericAdapterRequest(uriPath, uriMethod, callQuery, callBody, callHeaders, (result, error) => {
-        // if we received an error or their is no response on the results return an error
-        if (error) {
-          if (handleFail === 'fail') {
-            return callback(null, error);
-          }
-          return callback({}, null);
-        }
-        if (!result.response) {
-          if (handleFail === 'fail') {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', [brokCall], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-          return callback({}, null);
-        }
-
-        // get the response piece we care about from the response
-        const myResult = result;
-        if (callProps.responseDatakey) {
-          myResult.response = jsonQuery(callProps.responseDatakey, { data: myResult.response }).value;
-        }
-
-        // get the keys for the response fields
-        let rfKeys = [];
-        if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
-          rfKeys = Object.keys(callProps.responseFields);
-        }
-
-        // if we got an array returned (e.g. getDevicesFitered)
-        if (Array.isArray(myResult.response)) {
-          const listDevices = [];
-          for (let a = 0; a < myResult.response.length; a += 1) {
-            const thisDevice = myResult.response[a];
-            for (let rf = 0; rf < rfKeys.length; rf += 1) {
-              if (rfKeys[rf] !== 'ostypePrefix') {
-                let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
-
-                // if the field is ostype - need to add prefix
-                if (rfKeys[rf] === 'ostype' && typeof fieldValue === 'string') {
-                  fieldValue = ostypePrefix + fieldValue;
-                }
-                // if there is a status to set, set it
-                if (rfKeys[rf] === 'status') {
-                  // if really looking for just a good response
-                  if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
-                    thisDevice.isAlive = true;
-                  } else if (fieldValue.toString() === statusValue.toString()) {
-                    thisDevice.isAlive = true;
-                  } else {
-                    thisDevice.isAlive = false;
-                  }
-                }
-                // if we found a good value
-                thisDevice[rfKeys[rf]] = fieldValue;
-              }
-            }
-
-            // if there is no filter - add the device to the list
-            if (!filterName || filterName.length === 0) {
-              listDevices.push(thisDevice);
-            } else {
-              // if we have to match a filter
-              let found = false;
-              for (let f = 0; f < filterName.length; f += 1) {
-                if (thisDevice.name.indexOf(filterName[f]) >= 0) {
-                  found = true;
-                  break;
-                }
-              }
-              // matching device
-              if (found) {
-                listDevices.push(thisDevice);
-              }
-            }
-          }
-
-          // return the array of devices
-          return callback(listDevices, null);
-        }
-
-        // if this is not an array - just about everything else, just handle as a single object
-        let thisDevice = myResult.response;
-        for (let rf = 0; rf < rfKeys.length; rf += 1) {
-          // skip ostypePrefix since it is not a field
-          if (rfKeys[rf] !== 'ostypePrefix') {
-            let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
-
-            // if the field is ostype - need to add prefix
-            if (rfKeys[rf] === 'ostype' && typeof fieldValue === 'string') {
-              fieldValue = ostypePrefix + fieldValue;
-            }
-            // if there is a status to set, set it
-            if (rfKeys[rf] === 'status') {
-              // if really looking for just a good response
-              if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
-                thisDevice.isAlive = true;
-              } else if (fieldValue.toString() === statusValue.toString()) {
-                thisDevice.isAlive = true;
-              } else {
-                thisDevice.isAlive = false;
-              }
-            }
-            // if we found a good value
-            thisDevice[rfKeys[rf]] = fieldValue;
-          }
-        }
-
-        // if there is a filter - check the device is in the list
-        if (filterName && filterName.length > 0) {
-          let found = false;
-          for (let f = 0; f < filterName.length; f += 1) {
-            if (thisDevice.name.indexOf(filterName[f]) >= 0) {
-              found = true;
-              break;
-            }
-          }
-          // no matching device - clear the device
-          if (!found) {
-            thisDevice = {};
-          }
-        }
-
-        return callback(thisDevice, null);
-      });
-    } catch (e) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, e);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+    return this.requestHandlerInst.getDevicesFiltered(options, callback);
   }
 
   /**
-   * @summary Get Appliance that match the deviceName
+   * @summary Gets the status for the provided appliance
    *
-   * @function getDevice
-   * @param {String} deviceName - the deviceName to find (required)
+   * @function isAlive
+   * @param {String} deviceName - the deviceName of the appliance. (required)
    *
-   * @param {getCallback} callback - a callback function to return the result
-   *                                 (appliance) or the error
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAlive) or the error
    */
-  getDevice(deviceName, callback) {
-    const meth = 'adapterBase-getDevice';
-    const origin = `${this.id}-${meth}`;
+  isAlive(deviceName, callback) {
+    const origin = `${this.id}-adapterBase-isAlive`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getDevice
-    if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevice || this.allProps.devicebroker.getDevice.length === 0 || !this.allProps.devicebroker.getDevice[0].path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevice.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    /* HERE IS WHERE YOU VALIDATE DATA */
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
-      };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-
-        const callPromises = [];
-        for (let i = 0; i < this.allProps.devicebroker.getDevice.length; i += 1) {
-          // Perform component calls here.
-          callPromises.push(
-            new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], null, (callRet, callErr) => {
-                // return an error
-                if (callErr) {
-                  reject(callErr);
-                } else {
-                  // return the data
-                  resolve(callRet);
-                }
-              });
-            })
-          );
-        }
+    return this.requestHandlerInst.isAlive(deviceName, callback);
+  }
 
-        // return an array of repsonses
-        return Promise.all(callPromises).then((results) => {
-          let myResult = {};
-          results.forEach((result) => {
-            myResult = { ...myResult, ...result };
-          });
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfig
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfig(deviceName, format, callback) {
+    const origin = `${this.id}-adapterBase-getConfig`;
+    log.trace(origin);
 
-          return callback(myResult, null);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+    return this.requestHandlerInst.getConfig(deviceName, format, callback);
   }
 
   /**
-   * @summary Get Appliances that match the filter
+   * @summary Gets the device count from the system
    *
-   * @function getDevicesFiltered
-   * @param {Object} options - the data to use to filter the appliances (optional)
+   * @function iapGetDeviceCount
    *
-   * @param {getCallback} callback - a callback function to return the result
-   *                                 (appliances) or the error
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
    */
-  getDevicesFiltered(options, callback) {
-    const meth = 'adapterBase-getDevicesFiltered';
-    const origin = `${this.id}-${meth}`;
+  iapGetDeviceCount(callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCount`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getDevicesFiltered
-    if (!this.allProps.devicebroker || !this.allProps.devicebroker.getDevicesFiltered || this.allProps.devicebroker.getDevicesFiltered.length === 0 || !this.allProps.devicebroker.getDevicesFiltered[0].path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getDevicesFiltered.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+    return this.requestHandlerInst.iapGetDeviceCount(callback);
+  }
 
-    // verify the required fields have been provided
-    if (options === undefined || options === null || options === '' || options.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['options'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES GENERIC HANDLER               */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * Makes the requested generic call
+   *
+   * @function iapExpandedGenericAdapterRequest
+   * @param {Object} metadata - metadata for the call (optional).
+   *                 Can be a stringified Object.
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (optional)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (optional)
+   * @param {Object} pathVars - the parameters to be put within the url path (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-iapExpandedGenericAdapterRequest`;
+    log.trace(origin);
 
-    try {
-      // TODO - get pagination working
-      // const nextToken = options.start;
-      // const maxResults = options.limit;
-
-      // set up the filter of Device Names
-      let filterName = [];
-      if (options && options.filter && options.filter.name) {
-        // when this hack is removed, remove the lint ignore above
-        if (Array.isArray(options.filter.name)) {
-          // eslint-disable-next-line prefer-destructuring
-          filterName = options.filter.name;
-        } else {
-          filterName = [options.filter.name];
-        }
-      }
+    return this.requestHandlerInst.expandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback);
+  }
 
-      // TODO - get sort and order working
-      /*
-      if (options && options.sort) {
-        reqObj.uriOptions.sort = JSON.stringify(options.sort);
-      }
-      if (options && options.order) {
-        reqObj.uriOptions.order = options.order;
-      }
-      */
-      const callPromises = [];
-      for (let i = 0; i < this.allProps.devicebroker.getDevicesFiltered.length; i += 1) {
-        // Perform component calls here.
-        callPromises.push(
-          new Promise((resolve, reject) => {
-            this.iapMakeBrokerCall('getDevicesFiltered', this.allProps.devicebroker.getDevicesFiltered[i], [{ fake: 'fakedata' }], filterName, (callRet, callErr) => {
-              // return an error
-              if (callErr) {
-                reject(callErr);
-              } else {
-                // return the data
-                resolve(callRet);
-              }
-            });
-          })
-        );
-      }
+  /**
+   * Makes the requested generic call
+   *
+   * @function genericAdapterRequest
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-genericAdapterRequest`;
+    log.trace(origin);
 
-      // return an array of repsonses
-      return Promise.all(callPromises).then((results) => {
-        let myResult = [];
-        results.forEach((result) => {
-          if (Array.isArray(result)) {
-            myResult = [...myResult, ...result];
-          } else if (Object.keys(result).length > 0) {
-            myResult.push(result);
-          }
-        });
+    return this.requestHandlerInst.genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
+  }
 
-        log.debug(`${origin}: Found #${myResult.length} devices.`);
-        log.debug(`Devices: ${JSON.stringify(myResult)}`);
-        return callback({ total: myResult.length, list: myResult });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+  /**
+   * Makes the requested generic call with no base path or version
+   *
+   * @function genericAdapterRequestNoBasePath
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-genericAdapterRequestNoBasePath`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
   }
 
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES INVENTORY CALLS               */
+  /*                                                */
+  /* ********************************************** */
   /**
-   * @summary Gets the status for the provided appliance
+   * @summary run the adapter lint script to return the results.
    *
-   * @function isAlive
-   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @function iapRunAdapterLint
    *
-   * @param {configCallback} callback - callback function to return the result
-   *                                    (appliance isAlive) or the error
+   * @return {Object} - containing the results of the lint call.
    */
-  isAlive(deviceName, callback) {
-    const meth = 'adapterBase-isAlive';
+  iapRunAdapterLint(callback) {
+    const meth = 'adapterBase-iapRunAdapterLint';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
+    let command = null;
 
-    // make sure we are set up for device broker isAlive
-    if (!this.allProps.devicebroker || !this.allProps.devicebroker.isAlive || this.allProps.devicebroker.isAlive.length === 0 || !this.allProps.devicebroker.isAlive[0].path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.isAlive.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // verify the required fields have been provided
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
-      };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
+    if (fs.existsSync('package.json')) {
+      const packageData = require('./package.json');
 
-        const callPromises = [];
-        for (let i = 0; i < this.allProps.devicebroker.isAlive.length; i += 1) {
-          // Perform component calls here.
-          callPromises.push(
-            new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('isAlive', this.allProps.devicebroker.isAlive[i], [devs.list[0]], null, (callRet, callErr) => {
-                // return an error
-                if (callErr) {
-                  reject(callErr);
-                } else {
-                  // return the data
-                  resolve(callRet);
-                }
-              });
-            })
-          );
-        }
+      // check if 'test', 'test:unit', 'test:integration' exists in package.json file
+      if (!packageData.scripts || !packageData.scripts['lint:errors']) {
+        log.error('The required script does not exist in the package.json file');
+        return callback(null, 'The required script does not exist in the package.json file');
+      }
 
-        // return an array of repsonses
-        return Promise.all(callPromises).then((results) => {
-          let myResult = {};
-          results.forEach((result) => {
-            myResult = { ...myResult, ...result };
-          });
+      // execute 'npm run lint:errors' command
+      command = spawnSync('npm', ['run', 'lint:errors'], { cwd: __dirname, encoding: 'utf-8' });
 
-          let response = true;
-          if (myResult.isAlive !== null && myResult.isAlive !== undefined && myResult.isAlive === false) {
-            response = false;
-          }
-          return callback(response);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      // analyze and format the response
+      const result = {
+        status: 'SUCCESS'
+      };
+      if (command.status !== 0) {
+        result.status = 'FAILED';
+        result.output = command.stdout;
+      }
+      return callback(result);
     }
+
+    log.error('Package Not Found');
+    return callback(null, 'Package Not Found');
   }
 
   /**
-   * @summary Gets a config for the provided Appliance
+   * @summary run the adapter test scripts (baseunit and unit) to return the results.
+   *    can not run integration as there can be implications with that.
    *
-   * @function getConfig
-   * @param {String} deviceName - the deviceName of the appliance. (required)
-   * @param {String} format - the desired format of the config. (optional)
+   * @function iapRunAdapterTests
    *
-   * @param {configCallback} callback - callback function to return the result
-   *                                    (appliance config) or the error
+   * @return {Object} - containing the results of the baseunit and unit tests.
    */
-  getConfig(deviceName, format, callback) {
-    const meth = 'adapterBase-getConfig';
+  iapRunAdapterTests(callback) {
+    const meth = 'adapterBase-iapRunAdapterTests';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
+    let basecommand = null;
+    let command = null;
 
-    // make sure we are set up for device broker getConfig
-    if (!this.allProps.devicebroker || !this.allProps.devicebroker.getConfig || this.allProps.devicebroker.getConfig.length === 0 || !this.allProps.devicebroker.getConfig[0].path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getConfig.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+    if (fs.existsSync('package.json')) {
+      const packageData = require('./package.json');
 
-    // verify the required fields have been provided
-    if (deviceName === undefined || deviceName === null || deviceName === '' || deviceName.length === 0) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['deviceName'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
+      // check if 'test', 'test:unit', 'test:integration' exists in package.json file
+      if (!packageData.scripts || !packageData.scripts['test:baseunit'] || !packageData.scripts['test:unit']) {
+        log.error('The required scripts do not exist in the package.json file');
+        return callback(null, 'The required scripts do not exist in the package.json file');
+      }
 
-    try {
-      // need to get the device so we can convert the deviceName to an id
-      // !! if we can do a lookup by name the getDevicesFiltered may not be necessary
-      const opts = {
-        filter: {
-          name: deviceName
-        }
+      // run baseunit test
+      basecommand = spawnSync('npm', ['run', 'test:baseunit'], { cwd: __dirname, encoding: 'utf-8' });
+
+      // analyze and format the response to baseunit
+      const baseresult = {
+        status: 'SUCCESS'
       };
-      return this.getDevicesFiltered(opts, (devs, ferr) => {
-        // if we received an error or their is no response on the results return an error
-        if (ferr) {
-          return callback(null, ferr);
-        }
-        if (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
+      if (basecommand.status !== 0) {
+        baseresult.status = 'FAILED';
+        baseresult.output = basecommand.stdout;
+      }
 
-        const callPromises = [];
-        for (let i = 0; i < this.allProps.devicebroker.getConfig.length; i += 1) {
-          // Perform component calls here.
-          callPromises.push(
-            new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], null, (callRet, callErr) => {
-                // return an error
-                if (callErr) {
-                  reject(callErr);
-                } else {
-                  // return the data
-                  resolve(callRet);
-                }
-              });
-            })
-          );
-        }
+      // run unit test
+      command = spawnSync('npm', ['run', 'test:unit'], { cwd: __dirname, encoding: 'utf-8' });
 
-        // return an array of repsonses
-        return Promise.all(callPromises).then((results) => {
-          let myResult = {};
-          results.forEach((result) => {
-            myResult = { ...myResult, ...result };
-          });
-
-          // return the result
-          const newResponse = {
-            response: JSON.stringify(myResult, null, 2)
-          };
-          return callback(newResponse, null);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+      // analyze and format the response to unit
+      const unitresult = {
+        status: 'SUCCESS'
+      };
+      if (command.status !== 0) {
+        unitresult.status = 'FAILED';
+        unitresult.output = command.stdout;
+      }
+
+      // format the response and return it
+      const result = {
+        base: baseresult,
+        unit: unitresult
+      };
+      return callback(result);
     }
+
+    log.error('Package Not Found');
+    return callback(null, 'Package Not Found');
   }
 
   /**
-   * @summary Gets the device count from the system
+   * @summary provide inventory information abbout the adapter
    *
-   * @function iapGetDeviceCount
+   * @function iapGetAdapterInventory
    *
-   * @param {getCallback} callback - callback function to return the result
-   *                                    (count) or the error
+   * @return {Object} - containing the adapter inventory information
    */
-  iapGetDeviceCount(callback) {
-    const meth = 'adapterBase-iapGetDeviceCount';
+  iapGetAdapterInventory(callback) {
+    const meth = 'adapterBase-iapGetAdapterInventory';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // make sure we are set up for device broker getCount
-    if (!this.allProps.devicebroker || !this.allProps.devicebroker.getCount || this.allProps.devicebroker.getCount.length === 0 || !this.allProps.devicebroker.getCount[0].path) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Properties', ['devicebroker.getCount.path'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // verify the required fields have been provided
-
     try {
-      const callPromises = [];
-      for (let i = 0; i < this.allProps.devicebroker.getCount.length; i += 1) {
-        // Perform component calls here.
-        callPromises.push(
-          new Promise((resolve, reject) => {
-            this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], null, null, (callRet, callErr) => {
-              // return an error
-              if (callErr) {
-                reject(callErr);
-              } else {
-                // return the data
-                resolve(callRet);
-              }
-            });
-          })
-        );
-      }
+      // call to the adapter utils to get inventory
+      return this.requestHandlerInst.getAdapterInventory((res, error) => {
+        const adapterInv = res;
+
+        // get all of the tasks
+        const allTasks = this.getAllFunctions();
+        adapterInv.totalTasks = allTasks.length;
+
+        // get all of the possible workflow tasks
+        const myIgnore = [
+          'healthCheck',
+          'iapGetAdapterWorkflowFunctions',
+          'hasEntities'
+        ];
+        adapterInv.totalWorkflowTasks = this.iapGetAdapterWorkflowFunctions(myIgnore).length;
+
+        // TODO: CACHE
+        // CONFIRM CACHE
+        // GET CACHE ENTITIES
+
+        // get the Device Count
+        return this.iapGetDeviceCount((devres, deverror) => {
+          // if call failed assume not broker integrated
+          if (deverror) {
+            adapterInv.brokerDefined = false;
+            adapterInv.deviceCount = -1;
+          } else {
+            // broker confirmed
+            adapterInv.brokerDefined = true;
+            adapterInv.deviceCount = 0;
+            if (devres && devres.count) {
+              adapterInv.deviceCount = devres.count;
+            }
+          }
 
-      // return an array of repsonses
-      return Promise.all(callPromises).then((results) => {
-        let myResult = {};
-        results.forEach((result) => {
-          myResult = { ...myResult, ...result };
+          return callback(adapterInv);
         });
-
-        // return the result
-        return callback({ count: myResult.length });
       });
     } catch (ex) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);