HDFS-12835. Fix the javadoc errors in Router-based federation.
This commit is contained in:
parent
3881c9ef7e
commit
301641811d
@ -103,7 +103,8 @@ void updateActiveNamenode(
|
||||
* federation.
|
||||
*
|
||||
* @return List of name spaces in the federation
|
||||
* @throws Throws exception if the namespace list is not available.
|
||||
* @throws IOException Throws exception if the namespace list is not
|
||||
* available.
|
||||
*/
|
||||
Set<FederationNamespaceInfo> getNamespaces() throws IOException;
|
||||
|
||||
@ -111,7 +112,7 @@ void updateActiveNamenode(
|
||||
* Assign a unique identifier for the parent router service.
|
||||
* Required to report the status to the namenode resolver.
|
||||
*
|
||||
* @param router Unique string identifier for the router.
|
||||
* @param routerId Unique string identifier for the router.
|
||||
*/
|
||||
void setRouterId(String routerId);
|
||||
}
|
||||
|
@ -270,8 +270,7 @@ public Set<FederationNamespaceInfo> getNamespaces() throws IOException {
|
||||
* (if showStandby) 3) Most recently updated UNAVAILABLE registration (if
|
||||
* showUnavailable). EXPIRED registrations are ignored.
|
||||
*
|
||||
* @param query The select query for NN registrations.
|
||||
* @param excludes List of NNs to exclude from matching results.
|
||||
* @param request The select query for NN registrations.
|
||||
* @param addUnavailable include UNAVAILABLE registrations.
|
||||
* @param addExpired include EXPIRED registrations.
|
||||
* @return List of memberships or null if no registrations that
|
||||
|
@ -207,7 +207,7 @@ public void removeEntry(final String srcPath) {
|
||||
/**
|
||||
* Invalidates all cache entries below this path. It requires the write lock.
|
||||
*
|
||||
* @param src Source path.
|
||||
* @param path Source path.
|
||||
*/
|
||||
private void invalidateLocationCache(final String path) {
|
||||
if (locationCache.isEmpty()) {
|
||||
@ -449,7 +449,8 @@ public String toString() {
|
||||
/**
|
||||
* Build a location for this result beneath the discovered mount point.
|
||||
*
|
||||
* @param result Tree node search result.
|
||||
* @param path Path to build for.
|
||||
* @param entry Mount table entry.
|
||||
* @return PathLocation containing the namespace, local path.
|
||||
*/
|
||||
private static PathLocation buildLocation(
|
||||
|
@ -289,9 +289,9 @@ public int getNumDecomDeadDatanodes() {
|
||||
* @param numFiles Number of files.
|
||||
* @param numBlocks Total number of blocks.
|
||||
* @param numBlocksMissing Number of missing blocks.
|
||||
* @param numOfBlocksPendingReplication Number of blocks pending replication.
|
||||
* @param numOfBlocksUnderReplicated Number of blocks under replication.
|
||||
* @param numOfBlocksPendingDeletion Number of blocks pending deletion.
|
||||
* @param numBlocksPendingReplication Number of blocks pending replication.
|
||||
* @param numBlocksUnderReplicated Number of blocks under replication.
|
||||
* @param numBlocksPendingDeletion Number of blocks pending deletion.
|
||||
*/
|
||||
public void setNamesystemInfo(long available, long total,
|
||||
long numFiles, long numBlocks, long numBlocksMissing,
|
||||
|
@ -93,8 +93,6 @@ public class ConnectionManager {
|
||||
* Creates a proxy client connection pool manager.
|
||||
*
|
||||
* @param config Configuration for the connections.
|
||||
* @param minPoolSize Min size of the connection pool.
|
||||
* @param maxPoolSize Max size of the connection pool.
|
||||
*/
|
||||
public ConnectionManager(Configuration config) {
|
||||
this.conf = config;
|
||||
|
@ -171,7 +171,7 @@ protected ConnectionContext getConnection() {
|
||||
/**
|
||||
* Add a connection to the current pool. It uses a Copy-On-Write approach.
|
||||
*
|
||||
* @param conns New connections to add to the pool.
|
||||
* @param conn New connection to add to the pool.
|
||||
*/
|
||||
public synchronized void addConnection(ConnectionContext conn) {
|
||||
List<ConnectionContext> tmpConnections = new ArrayList<>(this.connections);
|
||||
|
@ -155,7 +155,7 @@ public static FileSubclusterResolver newFileSubclusterResolver(
|
||||
* Creates an instance of an ActiveNamenodeResolver from the configuration.
|
||||
*
|
||||
* @param conf Configuration that defines the namenode resolver class.
|
||||
* @param obj Context object passed to class constructor.
|
||||
* @param stateStore State store passed to class constructor.
|
||||
* @return New active namenode resolver.
|
||||
*/
|
||||
public static ActiveNamenodeResolver newActiveNamenodeResolver(
|
||||
|
@ -89,8 +89,8 @@ public class NamenodeHeartbeatService extends PeriodicService {
|
||||
/**
|
||||
* Create a new Namenode status updater.
|
||||
* @param resolver Namenode resolver service to handle NN registration.
|
||||
* @param nameserviceId Identifier of the nameservice.
|
||||
* @param namenodeId Identifier of the namenode in HA.
|
||||
* @param nsId Identifier of the nameservice.
|
||||
* @param nnId Identifier of the namenode in HA.
|
||||
*/
|
||||
public NamenodeHeartbeatService(
|
||||
ActiveNamenodeResolver resolver, String nsId, String nnId) {
|
||||
@ -320,7 +320,7 @@ public String getNamenodeDesc() {
|
||||
|
||||
/**
|
||||
* Get the parameters for a Namenode from JMX and add them to the report.
|
||||
* @param webAddress Web interface of the Namenode to monitor.
|
||||
* @param address Web interface of the Namenode to monitor.
|
||||
* @param report Namenode status report to update with JMX data.
|
||||
*/
|
||||
private void updateJMXParameters(
|
||||
|
@ -267,7 +267,7 @@ public RouterRpcServer getRpcServer() {
|
||||
/**
|
||||
* Set the current RPC socket for the router.
|
||||
*
|
||||
* @param rpcAddress RPC address.
|
||||
* @param address RPC address.
|
||||
*/
|
||||
protected void setRpcServerAddress(InetSocketAddress address) {
|
||||
this.rpcAddress = address;
|
||||
@ -310,7 +310,7 @@ protected RouterAdminServer createAdminServer() throws IOException {
|
||||
/**
|
||||
* Set the current Admin socket for the router.
|
||||
*
|
||||
* @param adminAddress Admin RPC address.
|
||||
* @param address Admin RPC address.
|
||||
*/
|
||||
protected void setAdminServerAddress(InetSocketAddress address) {
|
||||
this.adminAddress = address;
|
||||
@ -513,7 +513,7 @@ public String getRouterId() {
|
||||
/**
|
||||
* Sets a unique ID for this router.
|
||||
*
|
||||
* @param router Identifier of the Router.
|
||||
* @param id Identifier of the Router.
|
||||
*/
|
||||
public void setRouterId(String id) {
|
||||
this.routerId = id;
|
||||
|
@ -264,7 +264,7 @@ private static IOException toIOException(Exception e) {
|
||||
/**
|
||||
* If we should retry the RPC call.
|
||||
*
|
||||
* @param ex Exception reported.
|
||||
* @param ioe IOException reported.
|
||||
* @param retryCount Number of retries.
|
||||
* @return Retry decision.
|
||||
* @throws IOException Original exception if the retry policy generates one.
|
||||
@ -675,8 +675,8 @@ public Object invokeSequential(
|
||||
/**
|
||||
* Checks if a result matches the required result class.
|
||||
*
|
||||
* @param expectedResultClass Required result class, null to skip the check.
|
||||
* @param result The result to check.
|
||||
* @param expectedClass Required result class, null to skip the check.
|
||||
* @param clazz The result to check.
|
||||
* @return True if the result is an instance of the required class or if the
|
||||
* expected class is null.
|
||||
*/
|
||||
@ -693,8 +693,8 @@ private static boolean isExpectedClass(Class<?> expectedClass, Object clazz) {
|
||||
/**
|
||||
* Checks if a result matches the expected value.
|
||||
*
|
||||
* @param expectedResultValue The expected value, null to skip the check.
|
||||
* @param result The result to check.
|
||||
* @param expectedValue The expected value, null to skip the check.
|
||||
* @param value The result to check.
|
||||
* @return True if the result is equals to the expected value or if the
|
||||
* expected value is null.
|
||||
*/
|
||||
@ -717,7 +717,7 @@ private static boolean isExpectedValue(Object expectedValue, Object value) {
|
||||
*
|
||||
* @param <T> The type of the remote location.
|
||||
* @param locations List of remote locations to call concurrently.
|
||||
* @param remoteMethod The remote method and parameters to invoke.
|
||||
* @param method The remote method and parameters to invoke.
|
||||
* @param requireResponse If true an exception will be thrown if all calls do
|
||||
* not complete. If false exceptions are ignored and all data results
|
||||
* successfully received are returned.
|
||||
@ -740,12 +740,12 @@ public <T extends RemoteLocationContext> Map<T, Object> invokeConcurrent(
|
||||
* RemoteException or IOException.
|
||||
*
|
||||
* @param locations List of remote locations to call concurrently.
|
||||
* @param remoteMethod The remote method and parameters to invoke.
|
||||
* @param method The remote method and parameters to invoke.
|
||||
* @param requireResponse If true an exception will be thrown if all calls do
|
||||
* not complete. If false exceptions are ignored and all data results
|
||||
* successfully received are returned.
|
||||
* @param standby If the requests should go to the standby namenodes too.
|
||||
* @param timeoutMs Timeout for each individual call.
|
||||
* @param timeOutMs Timeout for each individual call.
|
||||
* @return Result of invoking the method per subcluster: nsId -> result.
|
||||
* @throws IOException If requiredResponse=true and any of the calls throw an
|
||||
* exception.
|
||||
@ -877,7 +877,7 @@ public Object call() throws Exception {
|
||||
* Get a prioritized list of NNs that share the same nameservice ID (in the
|
||||
* same namespace). NNs that are reported as ACTIVE will be first in the list.
|
||||
*
|
||||
* @param nameserviceId The nameservice ID for the namespace.
|
||||
* @param nsId The nameservice ID for the namespace.
|
||||
* @return A prioritized list of NNs to use for communication.
|
||||
* @throws IOException If a NN cannot be located for the nameservice ID.
|
||||
*/
|
||||
@ -898,7 +898,7 @@ private List<? extends FederationNamenodeContext> getNamenodesForNameservice(
|
||||
* Get a prioritized list of NNs that share the same block pool ID (in the
|
||||
* same namespace). NNs that are reported as ACTIVE will be first in the list.
|
||||
*
|
||||
* @param blockPoolId The blockpool ID for the namespace.
|
||||
* @param bpId The blockpool ID for the namespace.
|
||||
* @return A prioritized list of NNs to use for communication.
|
||||
* @throws IOException If a NN cannot be located for the block pool ID.
|
||||
*/
|
||||
|
@ -1390,7 +1390,7 @@ public ContentSummary getContentSummary(String path) throws IOException {
|
||||
/**
|
||||
* Aggregate content summaries for each subcluster.
|
||||
*
|
||||
* @param results Collection of individual summaries.
|
||||
* @param summaries Collection of individual summaries.
|
||||
* @return Aggregated content summary.
|
||||
*/
|
||||
private ContentSummary aggregateContentSummary(
|
||||
@ -1999,7 +1999,7 @@ private Map<String, Long> getMountPointDates(String path) {
|
||||
*
|
||||
* @param name Name of the mount point.
|
||||
* @param childrenNum Number of children.
|
||||
* @param dates Map with the dates.
|
||||
* @param date Map with the dates.
|
||||
* @return New HDFS file status representing a mount point.
|
||||
*/
|
||||
private HdfsFileStatus getMountPointStatus(
|
||||
|
@ -86,7 +86,7 @@ protected CachedRecordStore(Class<R> clazz, StateStoreDriver driver) {
|
||||
*
|
||||
* @param clazz Class of the record to store.
|
||||
* @param driver State Store driver.
|
||||
* @param override If the entries should be override if they expire
|
||||
* @param over If the entries should be override if they expire
|
||||
*/
|
||||
protected CachedRecordStore(
|
||||
Class<R> clazz, StateStoreDriver driver, boolean over) {
|
||||
@ -167,7 +167,6 @@ private boolean isUpdateTime() {
|
||||
* expired state.
|
||||
*
|
||||
* @param query RecordQueryResult containing the data to be inspected.
|
||||
* @param clazz Type of objects contained in the query.
|
||||
* @throws IOException
|
||||
*/
|
||||
public void overrideExpiredRecords(QueryResult<R> query) throws IOException {
|
||||
@ -194,9 +193,7 @@ public void overrideExpiredRecords(QueryResult<R> query) throws IOException {
|
||||
* Updates the state store with any record overrides we detected, such as an
|
||||
* expired state.
|
||||
*
|
||||
* @param driver State store driver for the data store.
|
||||
* @param record Record record to be updated.
|
||||
* @param clazz Type of data record.
|
||||
* @throws IOException
|
||||
*/
|
||||
public void overrideExpiredRecord(R record) throws IOException {
|
||||
|
@ -80,7 +80,7 @@ protected StateStoreDriver getDriver() {
|
||||
/**
|
||||
* Build a state store API implementation interface.
|
||||
*
|
||||
* @param interfaceClass The specific interface implementation to create
|
||||
* @param clazz The specific interface implementation to create
|
||||
* @param driver The {@link StateStoreDriver} implementation in use.
|
||||
* @return An initialized instance of the specified state store API
|
||||
* implementation.
|
||||
|
@ -128,9 +128,10 @@ public StateStoreMetrics getMetrics() {
|
||||
/**
|
||||
* Initialize storage for a single record class.
|
||||
*
|
||||
* @param name String reference of the record class to initialize, used to
|
||||
* construct paths and file names for the record. Determined by
|
||||
* configuration settings for the specific driver.
|
||||
* @param className String reference of the record class to initialize,
|
||||
* used to construct paths and file names for the record.
|
||||
* Determined by configuration settings for the specific
|
||||
* driver.
|
||||
* @param clazz Record type corresponding to the provided name.
|
||||
* @return True if successful, false otherwise.
|
||||
*/
|
||||
|
@ -192,7 +192,7 @@ public <T extends BaseRecord> boolean initRecordStorage(
|
||||
* Read all lines from a file and deserialize into the desired record type.
|
||||
*
|
||||
* @param reader Open handle for the file.
|
||||
* @param recordClass Record class to create.
|
||||
* @param clazz Record class to create.
|
||||
* @param includeDates True if dateModified/dateCreated are serialized.
|
||||
* @return List of records.
|
||||
* @throws IOException
|
||||
@ -250,7 +250,7 @@ public <T extends BaseRecord> QueryResult<T> get(Class<T> clazz, String sub)
|
||||
/**
|
||||
* Overwrite the existing data with a new data set.
|
||||
*
|
||||
* @param list List of records to write.
|
||||
* @param records List of records to write.
|
||||
* @param writer BufferedWriter stream to write to.
|
||||
* @return If the records were succesfully written.
|
||||
*/
|
||||
|
@ -98,7 +98,7 @@ public void close() throws Exception {
|
||||
/**
|
||||
* Get the folder path for the record class' data.
|
||||
*
|
||||
* @param cls Data record class.
|
||||
* @param clazz Data record class.
|
||||
* @return Path of the folder containing the record class' data files.
|
||||
*/
|
||||
private Path getPathForClass(Class<? extends BaseRecord> clazz) {
|
||||
|
@ -309,7 +309,8 @@ private <T extends BaseRecord> String getZNodeForClass(Class<T> clazz) {
|
||||
/**
|
||||
* Creates a record from a string returned by ZooKeeper.
|
||||
*
|
||||
* @param source Object from ZooKeeper.
|
||||
* @param data The data to write.
|
||||
* @param stat Stat of the data record to create.
|
||||
* @param clazz The data record type to create.
|
||||
* @return The created record.
|
||||
* @throws IOException
|
||||
|
@ -267,8 +267,7 @@ public UpdateNamenodeRegistrationResponse updateNamenodeRegistration(
|
||||
* majority value 2) Otherwise the first sorted entry in the set of all
|
||||
* entries
|
||||
*
|
||||
* @param entries - Collection of state store record objects of the same type
|
||||
* @param fieldName - Field name for the value to compare
|
||||
* @param records - Collection of state store record objects of the same type
|
||||
* @return record that is most representative of the field name
|
||||
*/
|
||||
private MembershipState getRepresentativeQuorum(
|
||||
|
Loading…
Reference in New Issue
Block a user