Package org.apache.hadoop.hdfs.server.federation.resolver

Interface MountTableManager

All Known Subinterfaces:
RouterAdminProtocol
All Known Implementing Classes:
MountTableStore, MountTableStoreImpl, RouterAdminProtocolTranslatorPB, RouterAdminServer
public interface MountTableManager
Manage a mount table.

  • Method Details

    • addMountTableEntry

      AddMountTableEntryResponse addMountTableEntry(AddMountTableEntryRequest request) throws IOException
      Add an entry to the mount table.
      Parameters:
      request - Fully populated request object.
      Returns:
      True if the mount table entry was successfully committed to the data store.
      Throws:
      IOException - Throws exception if the data store is not initialized.

    • addMountTableEntries

      AddMountTableEntriesResponse addMountTableEntries(AddMountTableEntriesRequest request) throws IOException
      Add multiple entries to the mount table.
      Parameters:
      request - Request object with fully populated list of mount point entries.
      Returns:
      True if all the mount table entries were successfully committed to the data store.
      Throws:
      IOException - Throws exception if the data store is not initialized.

    • updateMountTableEntry

      UpdateMountTableEntryResponse updateMountTableEntry(UpdateMountTableEntryRequest request) throws IOException
      Updates an existing entry in the mount table.
      Parameters:
      request - Fully populated request object.
      Returns:
      True if the mount table entry was successfully committed to the data store.
      Throws:
      IOException - Throws exception if the data store is not initialized.

    • removeMountTableEntry

      RemoveMountTableEntryResponse removeMountTableEntry(RemoveMountTableEntryRequest request) throws IOException
      Remove an entry from the mount table.
      Parameters:
      request - Fully populated request object.
      Returns:
      True the mount table entry was removed from the data store.
      Throws:
      IOException - Throws exception if the data store is not initialized.

    • getMountTableEntries

      GetMountTableEntriesResponse getMountTableEntries(GetMountTableEntriesRequest request) throws IOException
      List all mount table entries present at or below the path. Fetches from the state store.
      Parameters:
      request - Fully populated request object.
      Returns:
      List of all mount table entries under the path. Zero-length list if none are found.
      Throws:
      IOException - Throws exception if the data store cannot be queried.

    • refreshMountTableEntries

      RefreshMountTableEntriesResponse refreshMountTableEntries(RefreshMountTableEntriesRequest request) throws IOException
      Refresh mount table entries cache from the state store. Cache is updated periodically but with this API cache can be refreshed immediately. This API is primarily meant to be called from the Admin Server. Admin Server will call this API and refresh mount table cache of all the routers while changing mount table entries.
      Parameters:
      request - Fully populated request object.
      Returns:
      True the mount table entry was updated without any error.
      Throws:
      IOException - Throws exception if the data store is not initialized.

    • getDestination

      GetDestinationResponse getDestination(GetDestinationRequest request) throws IOException
      Get the destination subcluster (namespace) of a file/directory.
      Parameters:
      request - Fully populated request object including the file to check.
      Returns:
      The response including the subcluster where the input file is.
      Throws:
      IOException - Throws exception if the data store is not initialized.