Return-Path: X-Original-To: apmail-accumulo-dev-archive@www.apache.org Delivered-To: apmail-accumulo-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id E265817F94 for ; Tue, 14 Apr 2015 23:46:03 +0000 (UTC) Received: (qmail 54157 invoked by uid 500); 14 Apr 2015 23:45:58 -0000 Delivered-To: apmail-accumulo-dev-archive@accumulo.apache.org Received: (qmail 54118 invoked by uid 500); 14 Apr 2015 23:45:58 -0000 Mailing-List: contact dev-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@accumulo.apache.org Delivered-To: mailing list dev@accumulo.apache.org Received: (qmail 54101 invoked by uid 99); 14 Apr 2015 23:45:58 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 14 Apr 2015 23:45:58 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 3CFD6E0416; Tue, 14 Apr 2015 23:45:58 +0000 (UTC) From: keith-turner To: dev@accumulo.apache.org Reply-To: dev@accumulo.apache.org Message-ID: Subject: [GitHub] accumulo pull request: Clarify Accumulo API Content-Type: text/plain Date: Tue, 14 Apr 2015 23:45:58 +0000 (UTC) GitHub user keith-turner opened a pull request: https://github.com/apache/accumulo/pull/28 Clarify Accumulo API This pull request attempts to clarify what the Accumulo API is. The existing API statement does not include all types that a user would realistically need to use. A new API statement is proposed in 2f7d095. This pull request also prunes (via deprecation) things from the API that were not intended to be in the API, but ended up there. For example parts of the API that referenced non API types and as a result may not be stable were deprecated. I am requesting this review on GH instead of ReviewBoard because I thought it would be much easier to review the commits in this PR individually rather than squasing them for RB. For example the commit that deprecated and moved KeyExtent was very noisy and would make reviewing other changes difficult. One thing that I was not able to deprecate move was `o.a.a.c.security.crypto`. I would have liked to have moved this to `o.a.a.c.crypto`. Its not really client API code, its more server side extension code. However the class names are possibly referenced by user config. Also users may have extended the classes. I added an exception for the package in the README's API stmt. Does anyone have any ideas about making this less confusing w/o causing existing users any pain. You can merge this pull request into a Git repository by running: $ git pull https://github.com/keith-turner/accumulo api-cleanup Alternatively you can review and apply these changes as the patch at: https://github.com/apache/accumulo/pull/28.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #28 ---- commit b2fc1b7c5a2515329a3dca394877018dc28e6a47 Author: Keith Turner Date: 2015-04-10T19:01:43Z ACCUMULO-3657 Fix API problems with IsolatedScanner commit b6270514ad234fb646bdafcfef92151fd340c7c3 Author: Keith Turner Date: 2015-04-10T22:47:11Z ACCUMULO-3657 Deprecate public inner class in ClientSiderIteratorScanner that was not intended to be in public API commit 218e1fa10052a8077081511d362b16bc5057413b Author: Keith Turner Date: 2015-04-13T22:01:17Z ACCUMULO-3548 Deprecated KeyExtent from public API commit a13d0851e6b93cff86a3400ec2dad301400f033c Author: Keith Turner Date: 2015-04-13T22:38:31Z ACCUMULO-3657 Deprecate use of Property in ClientConfiguration commit 83e504259ae858a08735ce17113288c707744baa Author: Keith Turner Date: 2015-04-14T17:00:08Z ACCUMULO-3657 deprecated ZooKeeperInstance.lookupIntanceName(ZooCache, UUID) commit 061dcb3a131b3a6db09211044f5429a8ed16d5c9 Author: Keith Turner Date: 2015-04-14T17:15:31Z ACCUMULO-3657 deprecated IteratorUtil.getProperty(IteratorScope) commit 905008f6ae39492703dcb224ea282ccb491b5a09 Author: Keith Turner Date: 2015-04-14T17:38:54Z ACCUMULO-3657 deprecated class ComparableBytes commit 76974ebaad375f8d522a1f9e80a097917b3903e9 Author: Christopher Tubbs Date: 2015-04-10T19:10:07Z ACCUMULO-3720 Use apilyzer-maven-plugin Use plugin to check for API problems commit 2f7d09551bcd5923358ac9fff8edac59a9c997b1 Author: Keith Turner Date: 2015-04-14T17:54:33Z ACCUMULO-3657 updated README to accurately communicate Accumulo's API. Update APILyzer config to enforce commit abd177558308c45026572e7a81364b05185b0837 Author: Keith Turner Date: 2015-04-14T19:05:25Z ACCUMULO-3657 move DelegationToken and AuthenticationTokenIdentifier out of public API commit 06f4b13f25986dfca3240f10d5db463290c8776f Author: Keith Turner Date: 2015-04-14T19:25:12Z ACCUMULO-3657 deprecated getTabletLocator() in both AbstractInputFormat classes commit d6eb55a4f95c7d49838437547901602fd093c2d6 Author: Keith Turner Date: 2015-04-14T20:26:08Z ACCUMULO-3657 deprecated getAccumuloConfiguration() in both AccumuloFileOutputFormat classes commit 6286af4e8994f696b89ba2edf59e42d85bb2f61a Author: Keith Turner Date: 2015-04-14T22:50:26Z ACCUMULO-3657 deperecated and moved VisibilityConstraint ---- --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastructure@apache.org or file a JIRA ticket with INFRA. ---