@itentialopensource/adapter-etsi_sol005 0.1.1 → 0.2.0

package/adapter.js

@@ -80,10 +80,18 @@ class EtsiSol005 extends AdapterBaseCl {
   }
 
   /**
-   * @getWorkflowFunctions
+   * @iapGetAdapterWorkflowFunctions
    */
-  getWorkflowFunctions(inIgnore) {
-    let myIgnore = ['hasEntities', 'hasDevices'];
+  iapGetAdapterWorkflowFunctions(inIgnore) {
+    let myIgnore = [
+      'healthCheck',
+      'iapGetAdapterWorkflowFunctions',
+      'iapHasAdapterEntity',
+      'iapVerifyAdapterCapability',
+      'iapUpdateAdapterEntityCache',
+      'hasEntities',
+      'getAuthorization'
+    ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;
     } else if (!inIgnore && typeof inIgnore === 'string') {
@@ -94,15 +102,15 @@ class EtsiSol005 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);
   }
 
   /**
-   * 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)
@@ -110,36 +118,42 @@ class EtsiSol005 extends AdapterBaseCl {
    * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
    * @param {Callback} callback - The results of the call
    */
-  updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
-    const origin = `${this.id}-adapter-updateAdapterConfiguration`;
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+    const meth = 'adapter-iapUpdateAdapterConfiguration';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
-    super.updateAdapterConfiguration(configFile, changes, entity, type, action, callback);
+
+    super.iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback);
   }
 
   /**
    * See if the API path provided is found in this adapter
    *
-   * @function findPath
+   * @function iapFindAdapterPath
    * @param {string} apiPath - the api path to check on
    * @param {Callback} callback - The results of the call
    */
-  findPath(apiPath, callback) {
-    const origin = `${this.id}-adapter-findPath`;
+  iapFindAdapterPath(apiPath, callback) {
+    const meth = 'adapter-iapFindAdapterPath';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
-    super.findPath(apiPath, callback);
+
+    super.iapFindAdapterPath(apiPath, 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);
@@ -149,14 +163,16 @@ class EtsiSol005 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);
@@ -166,29 +182,33 @@ class EtsiSol005 extends AdapterBaseCl {
   /**
     * @summary Get the Adaoter Queue
     *
-    * @function getQueue
+    * @function iapGetAdapterQueue
     * @param {Callback} callback - callback function
     */
-  getQueue(callback) {
-    const origin = `${this.id}-adapter-getQueue`;
+  iapGetAdapterQueue(callback) {
+    const meth = 'adapter-iapGetAdapterQueue';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
-    return super.getQueue(callback);
+
+    return super.iapGetAdapterQueue(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);
@@ -198,15 +218,17 @@ class EtsiSol005 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);
@@ -216,14 +238,16 @@ class EtsiSol005 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);
@@ -233,14 +257,16 @@ class EtsiSol005 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);
@@ -250,45 +276,48 @@ class EtsiSol005 extends AdapterBaseCl {
   /**
    * @summary moves entites into Mongo DB
    *
-   * @function moveEntitiesToDB
+   * @function iapMoveAdapterEntitiesToDB
    * @param {getCallback} callback - a callback function to return the result (Generics)
    *                                  or the error
    */
-  moveEntitiesToDB(callback) {
-    const origin = `${this.id}-adapter-moveEntitiesToDB`;
+  iapMoveAdapterEntitiesToDB(callback) {
+    const meth = 'adapter-iapMoveAdapterEntitiesToDB';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
+
     try {
-      return super.moveEntitiesToDB(callback);
+      return super.iapMoveAdapterEntitiesToDB(callback);
     } catch (err) {
       log.error(`${origin}: ${err}`);
       return callback(null, err);
     }
   }
 
+  /* BROKER CALLS */
   /**
    * @summary Determines if this adapter supports the specific entity
    *
-   * @function hasEntity
+   * @function iapHasAdapterEntity
    * @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`;
+  iapHasAdapterEntity(entityType, entityId, callback) {
+    const origin = `${this.id}-adapter-iapHasAdapterEntity`;
     log.trace(origin);
 
     // Make the call -
-    // verifyCapability(entityType, actionType, entityId, callback)
-    return this.verifyCapability(entityType, null, entityId, callback);
+    // iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
+    return this.iapVerifyAdapterCapability(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
+   * @function iapVerifyAdapterCapability
    * @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
@@ -296,15 +325,15 @@ class EtsiSol005 extends AdapterBaseCl {
    * @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';
+  iapVerifyAdapterCapability(entityType, actionType, entityId, callback) {
+    const meth = 'adapterBase-iapVerifyAdapterCapability';
     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) => {
+      // Make the call - iapVerifyAdapterCapability(entityType, actionType, entityId, callback)
+      return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (results, error) => {
         if (error) {
           return callback(null, error);
         }
@@ -322,7 +351,7 @@ class EtsiSol005 extends AdapterBaseCl {
                 }
 
                 // need to check the cache again since it has been updated
-                return this.requestHandlerInst.verifyCapability(entityType, actionType, entityId, (vcapable, verror) => {
+                return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, entityId, (vcapable, verror) => {
                   if (verror) {
                     return callback(null, verror);
                   }
@@ -355,7 +384,7 @@ class EtsiSol005 extends AdapterBaseCl {
     // 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) => {
+      return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
         if (verror) {
           return callback(null, verror);
         }
@@ -376,7 +405,7 @@ class EtsiSol005 extends AdapterBaseCl {
           }
 
           // need to check the cache again since it has been updated
-          return this.requestHandlerInst.verifyCapability(entityType, actionType, null, (vcapable, verror) => {
+          return this.requestHandlerInst.iapVerifyAdapterCapability(entityType, actionType, null, (vcapable, verror) => {
             if (verror) {
               return callback(null, verror);
             }
@@ -417,11 +446,11 @@ class EtsiSol005 extends AdapterBaseCl {
   /**
    * @summary Updates the cache for all entities by call the get All entity method
    *
-   * @function updateEntityCache
+   * @function iapUpdateAdapterEntityCache
    *
    */
-  updateEntityCache() {
-    const origin = `${this.id}-adapter-updateEntityCache`;
+  iapUpdateAdapterEntityCache() {
+    const origin = `${this.id}-adapter-iapUpdateAdapterEntityCache`;
     log.trace(origin);
 
     if (this.caching) {
@@ -434,6 +463,140 @@ class EtsiSol005 extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @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
    *
@@ -544,79 +707,23 @@ class EtsiSol005 extends AdapterBaseCl {
     }
   }
 
-  /* BROKER CALLS */
   /**
-   * @summary Determines if this adapter supports any in a list of entities
+   * Makes the requested generic call with no base path or version
    *
-   * @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 origin = `${this.id}-adapter-hasEntities`;
-    log.trace(origin);
-
-    switch (entityType) {
-      case 'Device':
-        return this.hasDevices(entityList, callback);
-      default:
-        return callback(null, `${this.id} does not support entity ${entityType}`);
-    }
-  }
-
-  /**
-   * @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
-   *
-   * @function getDevice
-   * @param {String} deviceName - the deviceName to find (required)
-   *
-   * @param {getCallback} callback - a callback function to return the result
-   *                                 (appliance) or the error
+   * @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
    */
-  getDevice(deviceName, callback) {
-    const meth = 'adapter-getDevice';
+  genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const meth = 'adapter-genericAdapterRequestNoBasePath';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -627,365 +734,81 @@ class EtsiSol005 extends AdapterBaseCl {
     }
 
     /* 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);
+    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);
     }
-
-    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);
-        }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! 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
-        const uriPath = `/call/toget/device/${uuid}`;
-        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-          if (!result.response || !result.response.applianceMo) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevice'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
-
-          // return the response
-          // !! format the data we send back
-          // !! these fields are config manager fields you need to map to the data we receive
-          const thisDevice = result.response;
-          thisDevice.name = thisDevice.systemName;
-          thisDevice.ostype = `System-${thisDevice.systemType}`;
-          thisDevice.port = thisDevice.systemPort;
-          thisDevice.ipaddress = thisDevice.systemIP;
-          return callback(thisDevice);
-        });
-      });
-    } catch (ex) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+    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);
     }
-  }
 
-  /**
-   * @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);
-
-    // 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);
+    /* 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);
     }
-    log.debug(`Device Filter Options: ${JSON.stringify(options)}`);
-
-    // TODO - get pagination working
-    // const nextToken = options.start;
-    // const maxResults = options.limit;
+    const pathVars = myPath.split('/');
+    const queryParamsAvailable = queryData;
+    const queryParams = {};
+    const bodyVars = requestBody;
 
-    // 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];
+    // 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];
       }
-    }
-
-    // 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;
-    }
-    */
-    try {
-      // !! 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
-      const uriPath = '/call/toget/devices';
-      return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
-        // if we received an error or their is no response on the results return an error
-        if (error) {
-          return callback(null, error);
-        }
-        if (!result.response) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['getDevicesFiltered'], null, null, null);
-          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-          return callback(null, errorObj);
-        }
-
-        // !! go through the response - may have to look for sub object
-        // handle an array of devices
-        if (Array.isArray(result.response)) {
-          const myDevices = [];
-
-          for (let d = 0; d < result.response.length; d += 1) {
-            // !! format the data we send back
-            // !! these fields are config manager fields you need to map to the data we receive
-            const thisDevice = result.response;
-            thisDevice.name = thisDevice.systemName;
-            thisDevice.ostype = `System-${thisDevice.systemType}`;
-            thisDevice.port = thisDevice.systemPort;
-            thisDevice.ipaddress = thisDevice.systemIP;
-
-            // if there is no filter - return the device
-            if (filterName.length === 0) {
-              myDevices.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) {
-                myDevices.push(thisDevice);
-              }
-            }
-          }
-          log.debug(`${origin}: Found #${myDevices.length} devices.`);
-          log.debug(`Devices: ${JSON.stringify(myDevices)}`);
-          return callback({ total: myDevices.length, list: myDevices });
-        }
-        // handle a single device response
-        // !! format the data we send back
-        // !! these fields are config manager fields you need to map to the data we receive
-        const thisDevice = result.response;
-        thisDevice.name = thisDevice.systemName;
-        thisDevice.ostype = `System-${thisDevice.systemType}`;
-        thisDevice.port = thisDevice.systemPort;
-        thisDevice.ipaddress = thisDevice.systemIP;
-
-        // if there is no filter - return the device
-        if (filterName.length === 0) {
-          log.debug(`${origin}: Found #1 device.`);
-          log.debug(`Device: ${JSON.stringify(thisDevice)}`);
-          return callback({ total: 1, list: [thisDevice] });
-        }
-
-        // if there is a filter need to check for matching device
-        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) {
-          log.debug(`${origin}: Found #1 device.`);
-          log.debug(`Device Found: ${JSON.stringify(thisDevice)}`);
-          return callback({ total: 1, list: [thisDevice] });
-        }
-        // not a matching device
-        log.debug(`${origin}: No matching device found.`);
-        return callback({ total: 0, list: [] });
-      });
-    } 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);
-    }
-  }
-
-  /**
-   * @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);
-
-    // 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);
-        }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! 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
-        const uriPath = `/call/toget/status/${uuid}`;
-        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-          // !! should update this to make sure we are checking for the appropriate object/field
-          if (!result.response || !result.response.returnObj || !Object.hasOwnProperty.call(result.response.returnObj, 'statusField')) {
-            const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['isAlive'], null, null, null);
-            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-            return callback(null, errorObj);
-          }
+    });
 
-          // !! return the response - Update to the appropriate object/field
-          return callback(!result.response.returnObj.statusField);
-        });
-      });
-    } 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);
+    // 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;
     }
-  }
-
-  /**
-   * @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);
 
-    // 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);
+    // 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 {
-      // 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);
+      // 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 (devs.list.length < 1) {
-          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Did Not Find Device ${deviceName}`, [], null, null, null);
+        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);
         }
-        // get the uuid from the device
-        const { uuid } = devs.list[0];
-
-        // !! 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
-        const uriPath = `/call/toget/config/${uuid}`;
-        return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
-          // if we received an error or their is no response on the results return an error
-          if (error) {
-            return callback(null, error);
-          }
-
-          // return the result
-          const newResponse = {
-            response: JSON.stringify(result.response, null, 2)
-          };
-          return callback(newResponse);
-        });
-      });
-    } 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);
-    }
-  }
-
-  /**
-   * @summary Gets the device count from the system
-   *
-   * @function getCount
-   *
-   * @param {getCallback} callback - callback function to return the result
-   *                                    (count) or the error
-   */
-  getCount(callback) {
-    const meth = 'adapter-getCount';
-    const origin = `${this.id}-${meth}`;
-    log.trace(origin);
-
-    // verify the required fields have been provided
-
-    try {
-      // !! 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
-      const uriPath = '/call/toget/count';
-      return this.genericAdapterRequest(uriPath, 'GET', {}, {}, {}, (result, error) => {
-        // if we received an error or their is no response on the results return an error
-        if (error) {
-          return callback(null, error);
-        }
 
-        // return the result
-        return callback({ count: result.response });
+        /* 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);