@itentialopensource/adapter-aruba_airwave 0.2.1 → 0.3.0

package/adapter.js

@@ -80,10 +80,15 @@ class ArubaAirwave extends AdapterBaseCl {
   }
 
   /**
-   * @getWorkflowFunctions
+   * @iapGetAdapterWorkflowFunctions
    */
-  getWorkflowFunctions(inIgnore) {
-    let myIgnore = [];
+  iapGetAdapterWorkflowFunctions(inIgnore) {
+    let myIgnore = [
+      'healthCheck',
+      'iapGetAdapterWorkflowFunctions',
+      'hasEntities',
+      'getAuthorization'
+    ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;
     } else if (!inIgnore && typeof inIgnore === 'string') {
@@ -94,231 +99,44 @@ class ArubaAirwave extends AdapterBaseCl {
     // you can add specific methods that you do not want to be workflow functions to ignore like below
     // myIgnore.push('myMethodNotInWorkflow');
 
-    return super.getWorkflowFunctions(myIgnore);
+    return super.iapGetAdapterWorkflowFunctions(myIgnore);
   }
 
   /**
-   * @callback healthCallback
-   * @param {Object} result - the result of the get request (contains an id and a status)
-   */
-  /**
-   * @callback getCallback
-   * @param {Object} result - the result of the get request (entity/ies)
-   * @param {String} error - any error that occurred
-   */
-  /**
-   * @callback createCallback
-   * @param {Object} item - the newly created entity
-   * @param {String} error - any error that occurred
-   */
-  /**
-   * @callback updateCallback
-   * @param {String} status - the status of the update action
-   * @param {String} error - any error that occurred
-   */
-  /**
-   * @callback deleteCallback
-   * @param {String} status - the status of the delete action
-   * @param {String} error - any error that occurred
-   */
-
-  /**
-   * @summary Determines if this adapter supports the specific entity
-   *
-   * @function hasEntity
-   * @param {String} entityType - the entity type to check for
-   * @param {String/Array} entityId - the specific entity we are looking for
-   *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
-   */
-  hasEntity(entityType, entityId, callback) {
-    const origin = `${this.id}-adapter-hasEntity`;
-    log.trace(origin);
-
-    // Make the call -
-    // verifyCapability(entityType, actionType, entityId, callback)
-    return this.verifyCapability(entityType, null, entityId, callback);
-  }
-
-  /**
-   * @summary Provides a way for the adapter to tell north bound integrations
-   * whether the adapter supports type, action and specific entity
-   *
-   * @function verifyCapability
-   * @param {String} entityType - the entity type to check for
-   * @param {String} actionType - the action type to check for
-   * @param {String/Array} entityId - the specific entity we are looking for
-   *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
-   */
-  verifyCapability(entityType, actionType, entityId, callback) {
-    const meth = 'adapterBase-verifyCapability';
-    const origin = `${this.id}-${meth}`;
-    log.trace(origin);
-
-    // if caching
-    if (this.caching) {
-      // Make the call - verifyCapability(entityType, actionType, entityId, callback)
-      return this.requestHandlerInst.verifyCapability(entityType, actionType, entityId, (results, error) => {
-        if (error) {
-          return callback(null, error);
-        }
-
-        // if the cache needs to be updated, update and try again
-        if (results && results[0] === 'needupdate') {
-          switch (entityType) {
-            case 'template_entity': {
-              // if the cache is invalid, update the cache
-              return this.getEntities(null, null, null, null, (data, err) => {
-                if (err) {
-                  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
-                  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-                  return callback(null, errorObj);
-                }
-
-                // need to check the cache again since it has been updated
-                return this.requestHandlerInst.verifyCapability(entityType, actionType, entityId, (vcapable, verror) => {
-                  if (verror) {
-                    return callback(null, verror);
-                  }
-
-                  return this.capabilityResults(vcapable, callback);
-                });
-              });
-            }
-            default: {
-              // unsupported entity type
-              const result = [false];
-
-              // put false in array for all entities
-              if (Array.isArray(entityId)) {
-                for (let e = 1; e < entityId.length; e += 1) {
-                  result.push(false);
-                }
-              }
-
-              return callback(result);
-            }
-          }
-        }
-
-        // return the results
-        return this.capabilityResults(results, callback);
-      });
-    }
-
-    // if no entity id
-    if (!entityId) {
-      // need to check the cache again since it has been updated
-      return this.requestHandlerInst.verifyCapability(entityType, actionType, null, (vcapable, verror) => {
-        if (verror) {
-          return callback(null, verror);
-        }
-
-        return this.capabilityResults(vcapable, callback);
-      });
-    }
-
-    // if not caching
-    switch (entityType) {
-      case 'template_entity': {
-        // need to get the entities to check
-        return this.getEntities(null, null, null, null, (data, err) => {
-          if (err) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Could not update entity: $VARIABLE$, cache', [entityType], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-
-          // need to check the cache again since it has been updated
-          return this.requestHandlerInst.verifyCapability(entityType, actionType, null, (vcapable, verror) => {
-            if (verror) {
-              return callback(null, verror);
-            }
-
-            // is the entity in the list?
-            const isEntity = this.entityInList(entityId, data.response, callback);
-            const res = [];
-
-            // not found
-            for (let i = 0; i < isEntity.length; i += 1) {
-              if (vcapable) {
-                res.push(isEntity[i]);
-              } else {
-                res.push(false);
-              }
-            }
-
-            return callback(res);
-          });
-        });
-      }
-      default: {
-        // unsupported entity type
-        const result = [false];
-
-        // put false in array for all entities
-        if (Array.isArray(entityId)) {
-          for (let e = 1; e < entityId.length; e += 1) {
-            result.push(false);
-          }
-        }
-
-        return callback(result);
-      }
-    }
-  }
-
-  /**
-   * @summary Updates the cache for all entities by call the get All entity method
-   *
-   * @function updateEntityCache
-   *
-   */
-  updateEntityCache() {
-    const origin = `${this.id}-adapter-updateEntityCache`;
-    log.trace(origin);
-
-    if (this.caching) {
-      // if the cache is invalid, update the cache
-      this.getEntities(null, null, null, null, (data, err) => {
-        if (err) {
-          log.trace(`${origin}: Could not load template_entity into cache - ${err}`);
-        }
-      });
-    }
-  }
-
-  /**
-   * updateAdapterConfiguration is used to update any of the adapter configuration files. This
+   * 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
    * file system.
    *
-   * @function updateAdapterConfiguration
+   * @function iapUpdateAdapterConfiguration
    * @param {string} configFile - the name of the file being updated (required)
    * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
    * @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
    * @param {Callback} callback - The results of the call
    */
-  updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
-    super.updateAdapterConfiguration(configFile, changes, entity, type, action, callback);
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback) {
+    const meth = 'adapter-iapUpdateAdapterConfiguration';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback);
   }
 
   /**
     * @summary Suspends adapter
     *
-    * @function suspend
+    * @function iapSuspendAdapter
     * @param {Callback} callback - callback function
     */
-  suspend(mode, callback) {
-    const origin = `${this.id}-adapter-suspend`;
+  iapSuspendAdapter(mode, callback) {
+    const meth = 'adapter-iapSuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.suspend(mode, callback);
+      return super.iapSuspendAdapter(mode, callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
@@ -328,34 +146,68 @@ class ArubaAirwave extends AdapterBaseCl {
   /**
     * @summary Unsuspends adapter
     *
-    * @function unsuspend
+    * @function iapUnsuspendAdapter
     * @param {Callback} callback - callback function
     */
-  unsuspend(callback) {
-    const origin = `${this.id}-adapter-unsuspend`;
+  iapUnsuspendAdapter(callback) {
+    const meth = 'adapter-iapUnsuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.unsuspend(callback);
+      return super.iapUnsuspendAdapter(callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
     }
   }
 
+  /**
+    * @summary Get the Adapter Queue
+    *
+    * @function iapGetAdapterQueue
+    * @param {Callback} callback - callback function
+    */
+  iapGetAdapterQueue(callback) {
+    const meth = 'adapter-iapGetAdapterQueue';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    return super.iapGetAdapterQueue(callback);
+  }
+
+  /* SCRIPT CALLS */
+  /**
+   * See if the API path provided is found in this adapter
+   *
+   * @function iapFindAdapterPath
+   * @param {string} apiPath - the api path to check on
+   * @param {Callback} callback - The results of the call
+   */
+  iapFindAdapterPath(apiPath, callback) {
+    const meth = 'adapter-iapFindAdapterPath';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    super.iapFindAdapterPath(apiPath, callback);
+  }
+
   /**
   * @summary Runs troubleshoot scripts for adapter
   *
-  * @function troubleshoot
+  * @function iapTroubleshootAdapter
   * @param {Object} props - the connection, healthcheck and authentication properties
   *
   * @param {boolean} persistFlag - whether the adapter properties should be updated
   * @param {Callback} callback - The results of the call
   */
-  troubleshoot(props, persistFlag, callback) {
-    const origin = `${this.id}-adapter-troubleshoot`;
+  iapTroubleshootAdapter(props, persistFlag, callback) {
+    const meth = 'adapter-iapTroubleshootAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.troubleshoot(props, persistFlag, this, callback);
+      return super.iapTroubleshootAdapter(props, persistFlag, this, callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
@@ -365,15 +217,17 @@ class ArubaAirwave extends AdapterBaseCl {
   /**
     * @summary runs healthcheck script for adapter
     *
-    * @function runHealthcheck
+    * @function iapRunAdapterHealthcheck
     * @param {Adapter} adapter - adapter instance to troubleshoot
     * @param {Callback} callback - callback function
     */
-  runHealthcheck(callback) {
-    const origin = `${this.id}-adapter-runHealthcheck`;
+  iapRunAdapterHealthcheck(callback) {
+    const meth = 'adapter-iapRunAdapterHealthcheck';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.runHealthcheck(this, callback);
+      return super.iapRunAdapterHealthcheck(this, callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
@@ -383,14 +237,16 @@ class ArubaAirwave extends AdapterBaseCl {
   /**
     * @summary runs connectivity check script for adapter
     *
-    * @function runConnectivity
+    * @function iapRunAdapterConnectivity
     * @param {Callback} callback - callback function
     */
-  runConnectivity(callback) {
-    const origin = `${this.id}-adapter-runConnectivity`;
+  iapRunAdapterConnectivity(callback) {
+    const meth = 'adapter-iapRunAdapterConnectivity';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.runConnectivity(callback);
+      return super.iapRunAdapterConnectivity(callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
@@ -400,20 +256,420 @@ class ArubaAirwave extends AdapterBaseCl {
   /**
     * @summary runs basicGet script for adapter
     *
-    * @function runBasicGet
+    * @function iapRunAdapterBasicGet
     * @param {Callback} callback - callback function
     */
-  runBasicGet(callback) {
-    const origin = `${this.id}-adapter-runBasicGet`;
+  iapRunAdapterBasicGet(callback) {
+    const meth = 'adapter-iapRunAdapterBasicGet';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.runBasicGet(callback);
+      return super.iapRunAdapterBasicGet(callback);
     } catch (error) {
       log.error(`${origin}: ${error}`);
       return callback(null, error);
     }
   }
 
+  /**
+   * @summary moves entites into Mongo DB
+   *
+   * @function iapMoveAdapterEntitiesToDB
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                                  or the error
+   */
+  iapMoveAdapterEntitiesToDB(callback) {
+    const meth = 'adapter-iapMoveAdapterEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapMoveAdapterEntitiesToDB(callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Deactivate adapter tasks
+   *
+   * @function iapDeactivateTasks
+   *
+   * @param {Array} tasks - List of tasks to deactivate
+   * @param {Callback} callback
+   */
+  iapDeactivateTasks(tasks, callback) {
+    const meth = 'adapter-iapDeactivateTasks';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapDeactivateTasks(tasks, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Activate adapter tasks that have previously been deactivated
+   *
+   * @function iapActivateTasks
+   *
+   * @param {Array} tasks - List of tasks to activate
+   * @param {Callback} callback
+   */
+  iapActivateTasks(tasks, callback) {
+    const meth = 'adapter-iapActivateTasks';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapActivateTasks(tasks, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /* CACHE CALLS */
+  /**
+   * @summary Populate the cache for the given entities
+   *
+   * @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 status of the populate
+   */
+  iapPopulateEntityCache(entityTypes, callback) {
+    const meth = 'adapter-iapPopulateEntityCache';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapPopulateEntityCache(entityTypes, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Retrieves data from cache for specified entity type
+   *
+   * @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
+   */
+  iapRetrieveEntitiesCache(entityType, options, callback) {
+    const meth = 'adapter-iapCheckEiapRetrieveEntitiesCachentityCached';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapRetrieveEntitiesCache(entityType, options, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /* BROKER CALLS */
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntities
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntities(entityType, entityList, callback) {
+    const meth = 'adapter-hasEntities';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.hasEntities(entityType, entityList, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDevice
+   * @param {String} deviceName - the deviceName to find (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDevice(deviceName, callback) {
+    const meth = 'adapter-getDevice';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.getDevice(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFiltered
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFiltered(options, callback) {
+    const meth = 'adapter-getDevicesFiltered';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.getDevicesFiltered(options, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAlive
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAlive) or the error
+   */
+  isAlive(deviceName, callback) {
+    const meth = 'adapter-isAlive';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.isAlive(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @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 meth = 'adapter-getConfig';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.getConfig(deviceName, format, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCount
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCount(callback) {
+    const meth = 'adapter-iapGetDeviceCount';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapGetDeviceCount(callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /* GENERIC ADAPTER REQUEST - allows extension of adapter without new calls being added */
+  /**
+   * 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 meth = 'adapter-iapExpandedGenericAdapterRequest';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * 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 meth = 'adapter-genericAdapterRequest';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /**
+   * 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 meth = 'adapter-genericAdapterRequestNoBasePath';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    try {
+      return super.genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
+    }
+  }
+
+  /* INVENTORY CALLS */
+  /**
+   * @summary run the adapter lint script to return the results.
+   *
+   * @function iapRunAdapterLint
+   * @param {Callback} callback - callback function
+   */
+  iapRunAdapterLint(callback) {
+    const meth = 'adapter-iapRunAdapterLint';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    return super.iapRunAdapterLint(callback);
+  }
+
+  /**
+   * @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 iapRunAdapterTests
+   * @param {Callback} callback - callback function
+   */
+  iapRunAdapterTests(callback) {
+    const meth = 'adapter-iapRunAdapterTests';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    return super.iapRunAdapterTests(callback);
+  }
+
+  /**
+   * @summary provide inventory information abbout the adapter
+   *
+   * @function iapGetAdapterInventory
+   * @param {Callback} callback - callback function
+   */
+  iapGetAdapterInventory(callback) {
+    const meth = 'adapter-iapGetAdapterInventory';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    return super.iapGetAdapterInventory(callback);
+  }
+
+  /**
+   * @callback healthCallback
+   * @param {Object} result - the result of the get request (contains an id and a status)
+   */
+  /**
+   * @callback getCallback
+   * @param {Object} result - the result of the get request (entity/ies)
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback createCallback
+   * @param {Object} item - the newly created entity
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback updateCallback
+   * @param {String} status - the status of the update action
+   * @param {String} error - any error that occurred
+   */
+  /**
+   * @callback deleteCallback
+   * @param {String} status - the status of the delete action
+   * @param {String} error - any error that occurred
+   */
+
   /**
    * @function aMPStats
    * @pronghornType method