Uploaded image for project: 'Accumulo'
  1. Accumulo
  2. ACCUMULO-3657

API Specification is incomplete

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Blocker
    • Resolution: Fixed
    • 1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.6.2
    • 1.7.0
    • None
    • None

    Description

      While working on fluo-365 and trying to create an example Accumulo API checkstyle rule I discovered that API specification in the README is incomplete. The API specification does not include the following classes (which are referenced by classes that are declared to be in public API).

      • o.a.a.core.security.ColumnVisibility (used by public methods in Mutation)
      • o.a.a.core.security.Authorizations (used by public methods in Connector)
      • o.a.a.core.data.ByteSequence (used by public methods in Key)
      • o.a.a.core.data.PartialKey (used by public methods in Key)
      • o.a.a.core.data.ColumnUpdate (used by public methods in Mutation)

      This list is not exhausitive, I did not analyze all methods in public API. These are just the issue I ran into while trying to apply a checkstyle rule to Fluo.

      After correcting the README and website, it would be nice to add a recommended checkstyle rule to the web site.

      Attachments

        1. apilyzer-1.txt
          13 kB
          Keith Turner
        2. pom-1.xml
          3 kB
          Keith Turner

        Issue Links

          is related to

          Task - A task that needs to be done. ACCUMULO-3737 Create 1.7.0 release notes

          • Blocker - Blocks development and/or testing work, production could not run
          • Resolved

          Task - A task that needs to be done. ACCUMULO-4568 Remove leaked non-public API types from public API

          • Major - Major loss of function.
          • Resolved
          relates to

          Sub-task - The sub-task of the issue ACCUMULO-3548 Classes leaked through InstanceOperations into public API methods

          • Critical - Crashes, loss of data, severe memory leak.
          • Resolved

          Sub-task - The sub-task of the issue ACCUMULO-3488 KeyExtent used in the public API, but not documented as such in README

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. ACCUMULO-3755 Update 1.6 API statement

          • Blocker - Blocks development and/or testing work, production could not run
          • Resolved
          links to

          Web Link GitHub Pull Request #28

          Web Link Pull Request

          There are no Sub-Tasks for this issue.

          Activity

            People

              kturner Keith Turner
              kturner Keith Turner
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 4h 40m
                  4h 40m