Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-4857

StorageStrategy documentation does not match API in code

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 1.9.90
    • Fix Version/s: 1.9.91
    • Component/s: Data Collection - SNMP
    • Security Level: Default (Default Security Scheme)
    • Labels:
    • Environment:
      Bug was introduced between git fd61d34a7def8ab5f42210ea955aff5daa18fbf3 and git 8e72a7fcbfb12b656ece2331731e14a9b45a77f8

      Description

      If you take the git difference between fd61d34a7def8ab5f42210ea955aff5daa18fbf3 and 8e72a7fcbfb12b656ece2331731e14a9b45a77f8 for the file opennms-dao/src/main/java/org/opennms/netmgt/config/StorageStrategy.java you can see the following:

      ----------------
      @@ -67,7 +64,7 @@ public interface StorageStrategy {

      • @param resourceIndex a {@link java.lang.String} object.
        * @return a {@link java.lang.String}

        object.
        */

      • public String getResourceNameFromIndex(String resourceParent, String resourceIndex);
        + public String getResourceNameFromIndex(CollectionResource resource);

      /*

      • Add to a strategy the possibility to get additional information using SNMP when is necessary.
        ----------------

      But the documentation (right above the change) was not updated, and was decidedly sketchy to begin with, now it is both sketchy and wrong. This is kind of an important part of the API because the storage strategy is one of the key pluggable components in the whole SNMP system.

      Would be really excellent to have something like a two paragraph explanation of what this object method is intended to get as an argument, and also what it is intended to return as a string.

        Attachments

          Activity

            People

            • Assignee:
              seth Seth Leger
              Reporter:
              telford Telford Tendys
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Time Tracking

                Estimated:
                Original Estimate - 2 hours
                2h
                Remaining:
                Remaining Estimate - 2 hours
                2h
                Logged:
                Time Spent - Not Specified
                Not Specified