[ACCUMULO-3657] API Specification is incomplete

• Type: Bug
• Status: Resolved
• Priority: Blocker
• Resolution: Fixed
• Affects Version/s: 1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.6.2
• Fix Version/s: 1.7.0
• Assignee: Keith Turner
• Reporter: Keith Turner
• Created: 10/Mar/15 20:38
• Updated: 13/Jan/17 17:44
• Resolved: 27/Apr/15 22:54

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.

Issue Links

• is related to: ACCUMULO-3737 Create 1.7.0 release notes
• is related to: ACCUMULO-4568 Remove leaked non-public API types from public API
• relates to: ACCUMULO-3548 Classes leaked through InstanceOperations into public API methods
• relates to: ACCUMULO-3488 KeyExtent used in the public API, but not documented as such in README
• relates to: ACCUMULO-3755 Update 1.6 API statement
• links to: GitHub Pull Request #28
• links to: Pull Request

Sub-Tasks

• Classes leaked through InstanceOperations into public API methods: Resolved
• KeyExtent used in the public API, but not documented as such in README: Resolved
• Add apilyzer-maven-plugin to the build to check for API problems: Resolved
• DelegationToken uses types not meant for public API: Resolved