@itentialopensource/adapter-adtran_mosaic_devicemanager 0.1.1 → 0.2.0

package/adapter.js

@@ -83,7 +83,15 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
    * @iapGetAdapterWorkflowFunctions
    */
   iapGetAdapterWorkflowFunctions(inIgnore) {
-    let myIgnore = ['hasEntities', 'hasDevices'];
+    let myIgnore = [
+      'healthCheck',
+      'iapGetAdapterWorkflowFunctions',
+      'iapHasAdapterEntity',
+      'iapVerifyAdapterCapability',
+      'iapUpdateAdapterEntityCache',
+      'hasEntities',
+      'getAuthorization'
+    ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;
     } else if (!inIgnore && typeof inIgnore === 'string') {
@@ -111,8 +119,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
    * @param {Callback} callback - The results of the call
    */
   iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
-    const origin = `${this.id}-adapter-iapUpdateAdapterConfiguration`;
+    const meth = 'adapter-iapUpdateAdapterConfiguration';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback);
   }
 
@@ -124,8 +134,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
    * @param {Callback} callback - The results of the call
    */
   iapFindAdapterPath(apiPath, callback) {
-    const origin = `${this.id}-adapter-iapFindAdapterPath`;
+    const meth = 'adapter-iapFindAdapterPath';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     super.iapFindAdapterPath(apiPath, callback);
   }
 
@@ -136,8 +148,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapSuspendAdapter(mode, callback) {
-    const origin = `${this.id}-adapter-iapSuspendAdapter`;
+    const meth = 'adapter-iapSuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapSuspendAdapter(mode, callback);
     } catch (error) {
@@ -153,8 +167,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapUnsuspendAdapter(callback) {
-    const origin = `${this.id}-adapter-iapUnsuspendAdapter`;
+    const meth = 'adapter-iapUnsuspendAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapUnsuspendAdapter(callback);
     } catch (error) {
@@ -170,8 +186,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapGetAdapterQueue(callback) {
-    const origin = `${this.id}-adapter-iapGetAdapterQueue`;
+    const meth = 'adapter-iapGetAdapterQueue';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     return super.iapGetAdapterQueue(callback);
   }
 
@@ -185,8 +203,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
   * @param {Callback} callback - The results of the call
   */
   iapTroubleshootAdapter(props, persistFlag, callback) {
-    const origin = `${this.id}-adapter-iapTroubleshootAdapter`;
+    const meth = 'adapter-iapTroubleshootAdapter';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapTroubleshootAdapter(props, persistFlag, this, callback);
     } catch (error) {
@@ -203,8 +223,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterHealthcheck(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterHealthcheck`;
+    const meth = 'adapter-iapRunAdapterHealthcheck';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterHealthcheck(this, callback);
     } catch (error) {
@@ -220,8 +242,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterConnectivity(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterConnectivity`;
+    const meth = 'adapter-iapRunAdapterConnectivity';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterConnectivity(callback);
     } catch (error) {
@@ -237,8 +261,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     * @param {Callback} callback - callback function
     */
   iapRunAdapterBasicGet(callback) {
-    const origin = `${this.id}-adapter-iapRunAdapterBasicGet`;
+    const meth = 'adapter-iapRunAdapterBasicGet';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapRunAdapterBasicGet(callback);
     } catch (error) {
@@ -255,8 +281,10 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
    *                                  or the error
    */
   iapMoveAdapterEntitiesToDB(callback) {
-    const origin = `${this.id}-adapter-iapMoveAdapterEntitiesToDB`;
+    const meth = 'adapter-iapMoveAdapterEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
       return super.iapMoveAdapterEntitiesToDB(callback);
     } catch (err) {
@@ -446,56 +474,18 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
    *                              value is true or false
    */
   hasEntities(entityType, entityList, callback) {
-    const origin = `${this.id}-adapter-hasEntities`;
+    const meth = 'adapter-hasEntities';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    switch (entityType) {
-      case 'Device':
-        return this.hasDevices(entityList, callback);
-      default:
-        return callback(null, `${this.id} does not support entity ${entityType}`);
+    try {
+      return super.hasEntities(entityType, entityList, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
-  /**
-   * @summary Helper method for hasEntities for the specific device case
-   *
-   * @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
-   */
-  hasDevices(deviceList, callback) {
-    const origin = `${this.id}-adapter-hasDevices`;
-    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 });
-    });
-  }
-
   /**
    * @summary Get Appliance that match the deviceName
    *
@@ -510,75 +500,11 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     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 an array of repsonses
-        return Promise.all(callPromises).then((results) => {
-          let myResult = {};
-          results.forEach((result) => {
-            myResult = { ...myResult, ...result };
-          });
-
-          return callback(myResult, null);
-        })
-          .catch((error) => {
-            log.debug(`Caught ${JSON.stringify(error)}`);
-            return callback(null, error);
-          });
-      });
-    } 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 super.getDevice(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -596,88 +522,11 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     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);
-    }
-
-    // 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)}`);
-
     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];
-        }
-      }
-
-      // 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], {}, filterName, (callRet, callErr) => {
-              // return an error
-              if (callErr) {
-                reject(callErr);
-              } else {
-                // return the data
-                resolve(callRet);
-              }
-            });
-          })
-        );
-      }
-
-      // 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);
-          }
-        });
-
-        log.debug(`${origin}: Found #${myResult.length} devices.`);
-        log.debug(`Devices: ${JSON.stringify(myResult)}`);
-        return callback({ total: myResult.length, list: myResult });
-      })
-        .catch((error) => {
-          log.debug(`Caught ${JSON.stringify(error)}`);
-          return callback(null, error);
-        });
-    } 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 super.getDevicesFiltered(options, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -695,79 +544,11 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // 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);
-        }
-
-        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);
-                }
-              });
-            })
-          );
-        }
-
-        // return an array of repsonses
-        return Promise.all(callPromises).then((results) => {
-          let myResult = {};
-          results.forEach((result) => {
-            myResult = { ...myResult, ...result };
-          });
-
-          let response = true;
-          if (myResult.isAlive !== null && myResult.isAlive !== undefined && myResult.isAlive === false) {
-            response = false;
-          }
-          return callback(response);
-        })
-          .catch((error) => {
-            log.debug(`Caught ${JSON.stringify(error)}`);
-            return callback(null, error);
-          });
-      });
-    } 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 super.isAlive(deviceName, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -786,79 +567,11 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // 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);
-    }
-
-    // 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);
-        }
-
-        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);
-                }
-              });
-            })
-          );
-        }
-
-        // 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((error) => {
-            log.debug(`Caught ${JSON.stringify(error)}`);
-            return callback(null, error);
-          });
-      });
-    } 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 super.getConfig(deviceName, format, callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -875,52 +588,11 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     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);
-              }
-            });
-          })
-        );
-      }
-
-      // return an array of repsonses
-      return Promise.all(callPromises).then((results) => {
-        let myResult = {};
-        results.forEach((result) => {
-          myResult = { ...myResult, ...result };
-        });
-
-        // return the result
-        return callback({ count: myResult.length });
-      })
-        .catch((error) => {
-          log.debug(`Caught ${JSON.stringify(error)}`);
-          return callback(null, error);
-        });
-    } 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 super.iapGetDeviceCount(callback);
+    } catch (err) {
+      log.error(`${origin}: ${err}`);
+      return callback(null, err);
     }
   }
 
@@ -1035,6 +707,116 @@ class AdtranMosaicDeviceManager extends AdapterBaseCl {
     }
   }
 
+  /**
+   * 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);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (uriPath === undefined || uriPath === null || uriPath === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['uriPath'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    if (restMethod === undefined || restMethod === null || restMethod === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['restMethod'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    // remove any leading / and split the uripath into path variables
+    let myPath = uriPath;
+    while (myPath.indexOf('/') === 0) {
+      myPath = myPath.substring(1);
+    }
+    const pathVars = myPath.split('/');
+    const queryParamsAvailable = queryData;
+    const queryParams = {};
+    const bodyVars = requestBody;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams,
+      uriOptions: {}
+    };
+    // add headers if provided
+    if (addlHeaders) {
+      reqObj.addlHeaders = addlHeaders;
+    }
+
+    // determine the call and return flag
+    let action = 'getGenericsNoBase';
+    let returnF = true;
+    if (restMethod.toUpperCase() === 'POST') {
+      action = 'createGenericNoBase';
+    } else if (restMethod.toUpperCase() === 'PUT') {
+      action = 'updateGenericNoBase';
+    } else if (restMethod.toUpperCase() === 'PATCH') {
+      action = 'patchGenericNoBase';
+    } else if (restMethod.toUpperCase() === 'DELETE') {
+      action = 'deleteGenericNoBase';
+      returnF = false;
+    }
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['genericAdapterRequestNoBasePath'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, 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);
+    }
+  }
+
   /**
    * @callback healthCallback
    * @param {Object} result - the result of the get request (contains an id and a status)