[ACCUMULO-2589] Create new client API

• Type: New Feature
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: client
• Assignee: Christopher Tubbs
• Reporter: Christopher Tubbs
• Created: 28/Mar/14 20:38
• Updated: 11/Jun/19 06:46

Description

There are many issues with the current client API, and we've had a lot of lessons learned that could be incorporated into a new one.

Some of the issues this would address:

• questions like "What is considered 'Public API'?"
• automated testing for incompatible API changes
• provide better support for alternative implementations of pluggable features
• distinguish between compile-time dependencies and runtime dependencies
• consistent exception handling
• consistent/symmetric getters/setters
• well-defined resource lifecycles
• better resource management
• simpler entry point to communicate with Accumulo
• better support for client-side configuration management
• logical layout of first class Accumulo objects in the API (Table, User, Scan, Connection)

Some of these goal may evolve during the development of this feature, and many previously identified issues can be moved to sub-tasks of this one. This ticket is intended to cover the overall feature, but the details will be handled in sub-tasks.

Issue Links

• breaks: ACCUMULO-4517 tool.sh broken after removal of accumulo-trace module
• is related to: ACCUMULO-2915 Avoid copying all Mutations when using a TabletServerBatchWriter
• is related to: ACCUMULO-3268 HoldTimeoutException is poorly propagated to clients
• is related to: ACCUMULO-4838 Create SPI package
• relates to: ACCUMULO-1268 add client wide timeout setting
• relates to: ACCUMULO-2590 Update public API in readme to clarify what's included
• supercedes: ACCUMULO-1578 Connector constructor doesn't need to fail-fast (maybe?)

Sub-Tasks

• Support external configuration in client API: Resolved
• Create client module with essential dependencies: Resolved
• Look into removing hadoop dependencies from client interface: Open
• refactor core to reduce client application dependency version conflicts: Resolved
• Examples should *only* use public API: Resolved
• client library should provide a mechanism for all resources to be cleaned up: Open
• User Management API should support appending authorizations: Resolved
• Client session migration: Resolved
• Provide API to validate table and namespace names: Resolved
• [API] Better exceptions for invalid table/namespace arg: Resolved
• Use Clirr maven plugin to enforce API compatibility: Resolved
• API should use collection-of-bytes representation instead of Text: Open
• Make it easier to connect to acccumulo: Resolved
• Create BatchDeleter with a provided BatchWriter instead of creating a new one: Resolved
• remove priority setting for scan-time iterators: Open
• Create API annotations with well-defined semantics: Resolved
• Rename version 1.7.0 to 2.0.0: Resolved
• Allow options through public API for table creation: Resolved
• Authorization constructors are pretty wonky - String research?: Open
• Improve stale-reads with ZooKeeper-backed data: Resolved
• Consider API additions to support non-batch oriented reads/writes: Resolved
• Replace String tableName arguments with TableHandle: Resolved
• Drop the ability to filter column qualifiers natively in the scanner: Open