Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-10462

Recategorize some of the client facing Public / Private interfaces

    XMLWordPrintableJSON

Details

    • Umbrella
    • Status: Closed
    • Blocker
    • Resolution: Fixed
    • None
    • 2.0.0-alpha-3, 2.0.0
    • Client
    • None

    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

      Attachments

        1. hbase-10462_wip1.patch
          8 kB
          Enis Soztutar

        Issue Links

          is blocked by

          Bug - A problem which impairs or prevents the functions of the product. HBASE-12106 Move test annotations to test artifact

          • Major - Major loss of function.
          • Closed
          is related to

          Task - A task that needs to be done. HBASE-12567 Track remaining issues for HBase-1.0

          • Blocker - Blocks development and/or testing work, production could not run
          • Closed

          Umbrella - An overarching type made of sub-tasks HBASE-10856 Prep for 1.0

          • Major - Major loss of function.
          • Closed
          relates to

          Sub-task - The sub-task of the issue HBASE-12107 Add lint for hbase-annotations being used.

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. HADOOP-10374 InterfaceAudience annotations should have RetentionPolicy.RUNTIME

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. HADOOP-10383 InterfaceStability annotations should have RetentionPolicy.RUNTIME

          • Major - Major loss of function.
          • Closed

          Task - A task that needs to be done. HBASE-18766 Make TableSnapshotScanner Audience Private

          • Major - Major loss of function.
          • Resolved
          supercedes

          Sub-task - The sub-task of the issue HBASE-12107 Add lint for hbase-annotations being used.

          • Major - Major loss of function.
          • Closed
          There are no Sub-Tasks for this issue.

          Activity

            People

              enis Enis Soztutar
              enis Enis Soztutar
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: