[RATIS-2058] Define ratis-common-api

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: API
• Assignee: Tsz-wo Sze
• Reporter: Tsz-wo Sze
• Created: 15/Apr/24 19:55
• Updated: 21/Jun/24 02:28

Description

Currently, it is not clear that if the ratis common utils are public API.

• Classes (e.g. SizeInBytes, TimeDuration, ReferenceCountedObject) used in Ratis-server-api have to be public APIs.
• Other classes (e.g. JavaUtils, JvmPauseMonitor, DataQueue) may not necessarily be.

Since Ratis is a library, it is nice to declare the useful classes as public APIs. We should clarify it and move the public APIs to a new "ratis-common-api" module.

Issue Links

• relates to: RATIS-2057 Add back JavaUtils.attemptUntilTrue(..)
• relates to: RATIS-2113 Use consistent method names and parameter types in RaftUtils