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

Class RouterAdminServer

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.hdfs.server.federation.router.RouterAdminServer

All Implemented Interfaces:

Closeable, AutoCloseable, RouterAdminProtocol, MountTableManager, RouterGenericManager, NameserviceManager, RouterStateManager, org.apache.hadoop.ipc.GenericRefreshProtocol, org.apache.hadoop.ipc.RefreshCallQueueProtocol, org.apache.hadoop.service.Service

public class RouterAdminServer
extends org.apache.hadoop.service.AbstractService
implements RouterAdminProtocol, org.apache.hadoop.ipc.RefreshCallQueueProtocol

This class is responsible for handling all the Admin calls to the HDFS router. It is created, started, and stopped by Router.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Field Summary

Fields inherited from interface org.apache.hadoop.ipc.GenericRefreshProtocol

versionID

Fields inherited from interface org.apache.hadoop.ipc.RefreshCallQueueProtocol

versionID

Constructor Summary

Constructors

Constructor	Description
RouterAdminServer(org.apache.hadoop.conf.Configuration conf, Router router)

Method Summary

Modifier and Type	Method	Description
AddMountTableEntriesResponse	addMountTableEntries(AddMountTableEntriesRequest request)	Add multiple entries to the mount table.
AddMountTableEntryResponse	addMountTableEntry(AddMountTableEntryRequest request)	Add an entry to the mount table.
DisableNameserviceResponse	disableNameservice(DisableNameserviceRequest request)	Disable a name service.
EnableNameserviceResponse	enableNameservice(EnableNameserviceRequest request)	Enable a name service.
EnterSafeModeResponse	enterSafeMode(EnterSafeModeRequest request)	Enter safe mode and change Router state to RouterServiceState#SAFEMODE.
GetDestinationResponse	getDestination(GetDestinationRequest request)	Get the destination subcluster (namespace) of a file/directory.
GetDisabledNameservicesResponse	getDisabledNameservices(GetDisabledNameservicesRequest request)	Get the list of disabled name service.
GetMountTableEntriesResponse	getMountTableEntries(GetMountTableEntriesRequest request)	List all mount table entries present at or below the path.
static RouterPermissionChecker	getPermissionChecker()	Get a new permission checker used for making mount table access control.
InetSocketAddress	getRpcAddress()	Get the RPC address of the admin service.
GetSafeModeResponse	getSafeMode(GetSafeModeRequest request)	Verify if current Router state is safe mode.
static String	getSuperGroup()	Get super group name.
static String	getSuperUser()	Get super user name.
LeaveSafeModeResponse	leaveSafeMode(LeaveSafeModeRequest request)	Leave safe mode and change Router state to RouterServiceState#RUNNING.
Collection<org.apache.hadoop.ipc.RefreshResponse>	refresh(String identifier, String[] args)
void	refreshCallQueue()
RefreshMountTableEntriesResponse	refreshMountTableEntries(RefreshMountTableEntriesRequest request)	Refresh mount table entries cache from the state store.
boolean	refreshSuperUserGroupsConfiguration()	Refresh superuser proxy groups mappings (used in RBF).
RemoveMountTableEntryResponse	removeMountTableEntry(RemoveMountTableEntryRequest request)	Remove an entry from the mount table.
protected void	serviceInit(org.apache.hadoop.conf.Configuration configuration)
protected void	serviceStart()
protected void	serviceStop()
UpdateMountTableEntryResponse	updateMountTableEntry(UpdateMountTableEntryRequest request)	Updates an existing entry in the mount table.
List<String>	verifyFileInDestinations(MountTable entry)	Verify the file exists in destination nameservices to avoid dangling mount points.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

RouterAdminServer

public RouterAdminServer(org.apache.hadoop.conf.Configuration conf,
 Router router)
                  throws IOException

Throws:

IOException

Method Details

getRpcAddress

public InetSocketAddress getRpcAddress()

Get the RPC address of the admin service.

Returns:

Administration service RPC address.

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration configuration)
                    throws Exception

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Throws:

Exception

serviceStart

protected void serviceStart()
                     throws Exception

Overrides:

serviceStart in class org.apache.hadoop.service.AbstractService

Throws:

Exception

serviceStop

protected void serviceStop()
                    throws Exception

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

Throws:

Exception

addMountTableEntry

public AddMountTableEntryResponse addMountTableEntry(AddMountTableEntryRequest request)
                                              throws IOException

Description copied from interface: MountTableManager

Add an entry to the mount table.

Specified by:

addMountTableEntry in interface MountTableManager

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

public AddMountTableEntriesResponse addMountTableEntries(AddMountTableEntriesRequest request)
                                                  throws IOException

Description copied from interface: MountTableManager

Add multiple entries to the mount table.

Specified by:

addMountTableEntries in interface MountTableManager

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

public UpdateMountTableEntryResponse updateMountTableEntry(UpdateMountTableEntryRequest request)
                                                    throws IOException

Description copied from interface: MountTableManager

Updates an existing entry in the mount table.

Specified by:

updateMountTableEntry in interface MountTableManager

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

public RemoveMountTableEntryResponse removeMountTableEntry(RemoveMountTableEntryRequest request)
                                                    throws IOException

Description copied from interface: MountTableManager

Remove an entry from the mount table.

Specified by:

removeMountTableEntry in interface MountTableManager

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

public GetMountTableEntriesResponse getMountTableEntries(GetMountTableEntriesRequest request)
                                                  throws IOException

Description copied from interface: MountTableManager

List all mount table entries present at or below the path. Fetches from the state store.

Specified by:

getMountTableEntries in interface MountTableManager

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.

enterSafeMode

public EnterSafeModeResponse enterSafeMode(EnterSafeModeRequest request)
                                    throws IOException

Description copied from interface: RouterStateManager

Enter safe mode and change Router state to RouterServiceState#SAFEMODE.

Specified by:

enterSafeMode in interface RouterStateManager

Parameters:

request - Request to enter safe mode.

Returns:

Response to enter safe mode.

Throws:

IOException - If it cannot perform the operation.

leaveSafeMode

public LeaveSafeModeResponse leaveSafeMode(LeaveSafeModeRequest request)
                                    throws IOException

Description copied from interface: RouterStateManager

Leave safe mode and change Router state to RouterServiceState#RUNNING.

Specified by:

leaveSafeMode in interface RouterStateManager

Parameters:

request - Request to leave safe mode.

Returns:

Response to leave safe mode.

Throws:

IOException - If it cannot perform the operation.

getSafeMode

public GetSafeModeResponse getSafeMode(GetSafeModeRequest request)
                                throws IOException

Description copied from interface: RouterStateManager

Verify if current Router state is safe mode.

Specified by:

getSafeMode in interface RouterStateManager

Parameters:

request - Request to get the safe mode state.

Returns:

Response to get the safe mode state.

Throws:

IOException - If it cannot perform the operation.

refreshMountTableEntries

public RefreshMountTableEntriesResponse refreshMountTableEntries(RefreshMountTableEntriesRequest request)
                                                          throws IOException

Description copied from interface: MountTableManager

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.

Specified by:

refreshMountTableEntries in interface MountTableManager

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

public GetDestinationResponse getDestination(GetDestinationRequest request)
                                      throws IOException

Description copied from interface: MountTableManager

Get the destination subcluster (namespace) of a file/directory.

Specified by:

getDestination in interface MountTableManager

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.

verifyFileInDestinations

public List<String> verifyFileInDestinations(MountTable entry)
                                      throws IOException

Verify the file exists in destination nameservices to avoid dangling mount points.

Parameters:

entry - the new mount points added, could be from add or update.

Returns:

destination nameservices where the file doesn't exist.

Throws:

IOException - unable to verify the file in destinations

disableNameservice

public DisableNameserviceResponse disableNameservice(DisableNameserviceRequest request)
                                              throws IOException

Description copied from interface: NameserviceManager

Disable a name service.

Specified by:

disableNameservice in interface NameserviceManager

Parameters:

request - Request to disable a name service.

Returns:

Response to disable a name service.

Throws:

IOException - If it cannot perform the operation.

enableNameservice

public EnableNameserviceResponse enableNameservice(EnableNameserviceRequest request)
                                            throws IOException

Description copied from interface: NameserviceManager

Enable a name service.

Specified by:

enableNameservice in interface NameserviceManager

Parameters:

request - Request to enable a name service.

Returns:

Response to disable a name service.

Throws:

IOException - If it cannot perform the operation.

getDisabledNameservices

public GetDisabledNameservicesResponse getDisabledNameservices(GetDisabledNameservicesRequest request)
                                                        throws IOException

Description copied from interface: NameserviceManager

Get the list of disabled name service.

Specified by:

getDisabledNameservices in interface NameserviceManager

Parameters:

request - Request to get the disabled name services.

Returns:

Response to get the disabled name services.

Throws:

IOException - If it cannot perform the operation.

getPermissionChecker

public static RouterPermissionChecker getPermissionChecker()
                                                    throws org.apache.hadoop.security.AccessControlException

Get a new permission checker used for making mount table access control. This method will be invoked during each RPC call in router admin server.

Returns:

Router permission checker.

Throws:

org.apache.hadoop.security.AccessControlException - If the user is not authorized.

getSuperUser

public static String getSuperUser()

Get super user name.

Returns:

String super user name.

getSuperGroup

public static String getSuperGroup()

Get super group name.

Returns:

String super group name.

refresh

public Collection<org.apache.hadoop.ipc.RefreshResponse> refresh(String identifier,
 String[] args)

Specified by:

refresh in interface org.apache.hadoop.ipc.GenericRefreshProtocol

refreshSuperUserGroupsConfiguration

public boolean refreshSuperUserGroupsConfiguration()
                                            throws IOException

Description copied from interface: RouterGenericManager

Refresh superuser proxy groups mappings (used in RBF).

Specified by:

refreshSuperUserGroupsConfiguration in interface RouterGenericManager

Returns:

true if the operation was successful.

Throws:

IOException - if operation was not successful.

refreshCallQueue

public void refreshCallQueue()
                      throws IOException

Specified by:

refreshCallQueue in interface org.apache.hadoop.ipc.RefreshCallQueueProtocol

Throws:

IOException