Package org.apache.hadoop.hdfs.protocolPB

Class RouterAdminProtocolTranslatorPB

java.lang.Object

org.apache.hadoop.hdfs.protocolPB.RouterAdminProtocolTranslatorPB

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, MountTableManager, RouterGenericManager, NameserviceManager, RouterStateManager, org.apache.hadoop.ipc.ProtocolMetaInterface, org.apache.hadoop.ipc.ProtocolTranslator

@Private
@Stable
public class RouterAdminProtocolTranslatorPB
extends java.lang.Object
implements org.apache.hadoop.ipc.ProtocolMetaInterface, MountTableManager, java.io.Closeable, org.apache.hadoop.ipc.ProtocolTranslator, RouterStateManager, NameserviceManager, RouterGenericManager

This class forwards RouterAdminProtocol calls as RPC calls to the RouterAdmin server while translating from the parameter types used in RouterAdminProtocol to the new PB types.

Constructor Summary

Constructors

Constructor	Description
RouterAdminProtocolTranslatorPB(RouterAdminProtocolPB proxy)

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.
void	close()
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.
GetSafeModeResponse	getSafeMode(GetSafeModeRequest request)	Verify if current Router state is safe mode.
java.lang.Object	getUnderlyingProxyObject()
boolean	isMethodSupported(java.lang.String methodName)
LeaveSafeModeResponse	leaveSafeMode(LeaveSafeModeRequest request)	Leave safe mode and change Router state to RouterServiceState#RUNNING.
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.
UpdateMountTableEntryResponse	updateMountTableEntry(UpdateMountTableEntryRequest request)	Updates an existing entry in the mount table.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterAdminProtocolTranslatorPB

public RouterAdminProtocolTranslatorPB(RouterAdminProtocolPB proxy)

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

getUnderlyingProxyObject

public java.lang.Object getUnderlyingProxyObject()

Specified by:

getUnderlyingProxyObject in interface org.apache.hadoop.ipc.ProtocolTranslator

isMethodSupported

public boolean isMethodSupported(java.lang.String methodName)
                          throws java.io.IOException

Specified by:

isMethodSupported in interface org.apache.hadoop.ipc.ProtocolMetaInterface

Throws:

java.io.IOException

addMountTableEntry

public AddMountTableEntryResponse addMountTableEntry(AddMountTableEntryRequest request)
                                              throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

addMountTableEntries

public AddMountTableEntriesResponse addMountTableEntries(AddMountTableEntriesRequest request)
                                                  throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

updateMountTableEntry

public UpdateMountTableEntryResponse updateMountTableEntry(UpdateMountTableEntryRequest request)
                                                    throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

removeMountTableEntry

public RemoveMountTableEntryResponse removeMountTableEntry(RemoveMountTableEntryRequest request)
                                                    throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

getMountTableEntries

public GetMountTableEntriesResponse getMountTableEntries(GetMountTableEntriesRequest request)
                                                  throws java.io.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:

java.io.IOException - Throws exception if the data store cannot be queried.

enterSafeMode

public EnterSafeModeResponse enterSafeMode(EnterSafeModeRequest request)
                                    throws java.io.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:

java.io.IOException - If it cannot perform the operation.

leaveSafeMode

public LeaveSafeModeResponse leaveSafeMode(LeaveSafeModeRequest request)
                                    throws java.io.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:

java.io.IOException - If it cannot perform the operation.

getSafeMode

public GetSafeModeResponse getSafeMode(GetSafeModeRequest request)
                                throws java.io.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:

java.io.IOException - If it cannot perform the operation.

disableNameservice

public DisableNameserviceResponse disableNameservice(DisableNameserviceRequest request)
                                              throws java.io.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:

java.io.IOException - If it cannot perform the operation.

enableNameservice

public EnableNameserviceResponse enableNameservice(EnableNameserviceRequest request)
                                            throws java.io.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:

java.io.IOException - If it cannot perform the operation.

getDisabledNameservices

public GetDisabledNameservicesResponse getDisabledNameservices(GetDisabledNameservicesRequest request)
                                                        throws java.io.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:

java.io.IOException - If it cannot perform the operation.

refreshMountTableEntries

public RefreshMountTableEntriesResponse refreshMountTableEntries(RefreshMountTableEntriesRequest request)
                                                          throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

getDestination

public GetDestinationResponse getDestination(GetDestinationRequest request)
                                      throws java.io.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:

java.io.IOException - Throws exception if the data store is not initialized.

refreshSuperUserGroupsConfiguration

public boolean refreshSuperUserGroupsConfiguration()
                                            throws java.io.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:

java.io.IOException - if operation was not successful.