HDFS-16729. RBF: fix some unreasonably annotated docs. (#4745)

Reviewed-by: Inigo Goiri <inigoiri@apache.org>
Signed-off-by: Akira Ajisaka <aajisaka@apache.org>
This commit is contained in:
jianghuazhu 2022-08-21 06:29:31 +08:00 committed by GitHub
parent c870171182
commit 7f176d080c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 13 additions and 13 deletions

View File

@ -757,7 +757,7 @@ public class Router extends CompositeService implements
/** /**
* Get the state store interface for the router heartbeats. * Get the state store interface for the router heartbeats.
* *
* @return FederationRouterStateStore state store API handle. * @return RouterStore state store API handle.
*/ */
public RouterStore getRouterStateManager() { public RouterStore getRouterStateManager() {
if (this.routerStateManager == null && this.stateStore != null) { if (this.routerStateManager == null && this.stateStore != null) {

View File

@ -48,7 +48,7 @@ import org.apache.hadoop.hdfs.server.federation.store.records.MembershipState;
* StateStoreDriver}, NameNode registrations are cached until the next query. * StateStoreDriver}, NameNode registrations are cached until the next query.
* The fetched registration data is aggregated using a quorum to determine the * The fetched registration data is aggregated using a quorum to determine the
* best/most accurate state for each NameNode. The cache is periodically updated * best/most accurate state for each NameNode. The cache is periodically updated
* by the @{link StateStoreCacheUpdateService}. * by the {@link StateStoreCacheUpdateService}.
*/ */
@InterfaceAudience.Private @InterfaceAudience.Private
@InterfaceStability.Evolving @InterfaceStability.Evolving

View File

@ -50,6 +50,7 @@ import org.slf4j.LoggerFactory;
* |--- MEMBERSHIP * |--- MEMBERSHIP
* |--- REBALANCER * |--- REBALANCER
* |--- ROUTERS * |--- ROUTERS
* |--- DISABLE_NAMESERVICE
*/ */
public class StateStoreZooKeeperImpl extends StateStoreSerializableImpl { public class StateStoreZooKeeperImpl extends StateStoreSerializableImpl {

View File

@ -31,19 +31,21 @@
* StateStoreDriver} to handle querying, updating and deleting data records. The * StateStoreDriver} to handle querying, updating and deleting data records. The
* data storage driver is initialized and maintained by the {@link * data storage driver is initialized and maintained by the {@link
* org.apache.hadoop.hdfs.server.federation.store.StateStoreService * org.apache.hadoop.hdfs.server.federation.store.StateStoreService
* FederationStateStoreService}. The state store * StateStoreService}. The state store
* supports fetching all records of a type, filtering by column values or * supports fetching all records of a type, filtering by column values or
* fetching a single record by its primary key. * fetching a single record by its primary key.
* <p> * <p>
* The state store contains several API interfaces, one for each data records * The state store contains several API interfaces, one for each data records
* type. * type.
* <ul> * <ul>
* <li>FederationMembershipStateStore: state of all Namenodes in the federation. * <li>MembershipStore: state of all Namenodes in the federation.
* Uses the MembershipState record. * Uses the MembershipState record.
* <li>FederationMountTableStore: Mount table mapping paths in the global * <li>MountTableStore: Mount table mapping paths in the global
* namespace to individual subcluster paths. Uses the MountTable record. * namespace to individual subcluster paths. Uses the MountTable record.
* <li>RouterStateStore: State of all routers in the federation. Uses the * <li>RouterStore: State of all routers in the federation. Uses the
* RouterState record. * RouterState record.
* <li>DisabledNameserviceStore: state of all disabled nameservice in the federation.
* Uses the DisabledNameservice record.
* </ul> * </ul>
* Each API is defined in a separate interface. The implementations of these * Each API is defined in a separate interface. The implementations of these
* interfaces are responsible for accessing the {@link * interfaces are responsible for accessing the {@link

View File

@ -32,7 +32,7 @@ import org.apache.hadoop.hdfs.server.federation.store.driver.StateStoreSerialize
/** /**
* Data schema for storing NN registration information in the * Data schema for storing NN registration information in the
* {@link org.apache.hadoop.hdfs.server.federation.store.StateStoreService * {@link org.apache.hadoop.hdfs.server.federation.store.StateStoreService
* FederationStateStoreService}. * StateStoreService}.
*/ */
public abstract class MembershipState extends BaseRecord public abstract class MembershipState extends BaseRecord
implements FederationNamenodeContext { implements FederationNamenodeContext {

View File

@ -42,9 +42,9 @@ import org.apache.hadoop.security.UserGroupInformation;
/** /**
* Data schema for {@link * Data schema for {@link
* org.apache.hadoop.hdfs.server.federation.store.MountTableStore * org.apache.hadoop.hdfs.server.federation.store.MountTableStore
* FederationMountTableStore} data stored in the {@link * MountTableStore} data stored in the {@link
* org.apache.hadoop.hdfs.server.federation.store.StateStoreService * org.apache.hadoop.hdfs.server.federation.store.StateStoreService
* FederationStateStoreService}. Supports string serialization. * StateStoreService}. Supports string serialization.
*/ */
public abstract class MountTable extends BaseRecord { public abstract class MountTable extends BaseRecord {

View File

@ -31,7 +31,7 @@ import org.slf4j.LoggerFactory;
* Entry to log the state of a * Entry to log the state of a
* {@link org.apache.hadoop.hdfs.server.federation.router.Router Router} in the * {@link org.apache.hadoop.hdfs.server.federation.router.Router Router} in the
* {@link org.apache.hadoop.hdfs.server.federation.store.StateStoreService * {@link org.apache.hadoop.hdfs.server.federation.store.StateStoreService
* FederationStateStoreService}. * StateStoreService}.
*/ */
public abstract class RouterState extends BaseRecord { public abstract class RouterState extends BaseRecord {

View File

@ -586,8 +586,6 @@ public class TestStateStoreMembershipState extends TestStateStoreBase {
/** /**
* Register a namenode heartbeat with the state store. * Register a namenode heartbeat with the state store.
* *
* @param store FederationMembershipStateStore instance to retrieve the
* membership data records.
* @param namenode A fully populated namenode membership record to be * @param namenode A fully populated namenode membership record to be
* committed to the data store. * committed to the data store.
* @return True if successful, false otherwise. * @return True if successful, false otherwise.

View File

@ -227,7 +227,6 @@ public class TestStateStoreMountTable extends TestStateStoreBase {
/** /**
* Fetch all mount table records beneath a root path. * Fetch all mount table records beneath a root path.
* *
* @param store FederationMountTableStore instance to commit the data.
* @param mount The root search path, enter "/" to return all mount table * @param mount The root search path, enter "/" to return all mount table
* records. * records.
* *