Return-Path: X-Original-To: apmail-accumulo-notifications-archive@minotaur.apache.org Delivered-To: apmail-accumulo-notifications-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1B42317E69 for ; Mon, 13 Apr 2015 18:10:14 +0000 (UTC) Received: (qmail 16935 invoked by uid 500); 13 Apr 2015 18:10:13 -0000 Delivered-To: apmail-accumulo-notifications-archive@accumulo.apache.org Received: (qmail 16893 invoked by uid 500); 13 Apr 2015 18:10:13 -0000 Mailing-List: contact notifications-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: jira@apache.org Delivered-To: mailing list notifications@accumulo.apache.org Received: (qmail 16874 invoked by uid 99); 13 Apr 2015 18:10:13 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 13 Apr 2015 18:10:13 +0000 Date: Mon, 13 Apr 2015 18:10:13 +0000 (UTC) From: "Keith Turner (JIRA)" To: notifications@accumulo.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (ACCUMULO-3657) API Specification is incomplete MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/ACCUMULO-3657?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14492759#comment-14492759 ] Keith Turner commented on ACCUMULO-3657: ---------------------------------------- bq. DelegationToken is probably not private since it's expected that downstream apps will need to interface with it, and not public because users don't need to do this directly. Are you saying that DelegationToken is not public? Its a public class in a public API package. > API Specification is incomplete > ------------------------------- > > Key: ACCUMULO-3657 > URL: https://issues.apache.org/jira/browse/ACCUMULO-3657 > Project: Accumulo > Issue Type: Bug > Affects Versions: 1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.6.2 > Reporter: Keith Turner > Assignee: Keith Turner > Priority: Blocker > Fix For: 1.5.3, 1.7.0, 1.6.3 > > Attachments: apilyzer-1.txt, pom-1.xml > > > While working on [fluo-365|https://github.com/fluo-io/fluo/issues/365] and trying to create an [example Accumulo API checkstyle rule|https://gist.github.com/keith-turner/ee0deafe88fa9f5bc43f] 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. -- This message was sent by Atlassian JIRA (v6.3.4#6332)