[HBASE-10462] Recategorize some of the client facing Public / Private interfaces

• Type: Umbrella
• Status: Closed
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 2.0.0-alpha-3, 2.0.0
• Component/s: Client
• Assignee: Enis Soztutar
• Reporter: Enis Soztutar
• Created: 04/Feb/14 01:55
• Updated: 17/Jun/22 05:03
• Resolved: 06/Sep/17 18:24

Description

We should go over the list of InterfaceAudience.Public interfaces one more to remove those that are NOT indeed public interfaces.

From current trunk, we should change these from public to private:

ReversedScannerCallable
ReversedClientScanner
ClientScanner  (note that ResultScanner is public interface, while ClientScanner should not be) 
ClientSmallScanner
TableSnapshotScanner -> We need a way of constructing this since it cannot be constructed from HConnection / HTable. Maybe a basic factory. 

These are not marked:

Registry, 
ZooKeeperRegistry
RpcRetryingCallerFactory
ZooKeeperKeepAliveConnection
AsyncProcess
DelegatingRetryingCallable
HConnectionKey
MasterKeepAliveConnection
MultiServerCallable

We can think about making these public interface:

ScanMetrics

Add javadoc to:

Query

We can add a test to find out all classes in client package to check for interface mark.

We can extend this to brainstorm on the preferred API options. We probably want the clients to use HTableInterface, instead of HTable everywhere. HConnectionManager comes with bazillion methods which are not intended for public use, etc.

Raising this as blocker to 1.0

Issue Links

• is blocked by: HBASE-12106 Move test annotations to test artifact
• is related to: HBASE-12567 Track remaining issues for HBase-1.0
• is related to: HBASE-10856 Prep for 1.0
• relates to: HBASE-12107 Add lint for hbase-annotations being used.
• relates to: HADOOP-10374 InterfaceAudience annotations should have RetentionPolicy.RUNTIME
• relates to: HADOOP-10383 InterfaceStability annotations should have RetentionPolicy.RUNTIME
• relates to: HBASE-18766 Make TableSnapshotScanner Audience Private
• supercedes: HBASE-12107 Add lint for hbase-annotations being used.

Sub-Tasks

• Add missing InterfaceAudience annotations for classes in hbase-common and hbase-client modules: Closed
• Classes in security subpackages missing @InterfaceAudience annotations.: Closed
• Add HBaseInterfaceAudience.TOOLS and move some of the Public classes to LimitedPrivate: Closed