Package org.apache.hadoop.hdfs.protocolPB

Class ClientDatanodeProtocolTranslatorPB

java.lang.Object

org.apache.hadoop.hdfs.protocolPB.ClientDatanodeProtocolTranslatorPB

All Implemented Interfaces:

Closeable, AutoCloseable, ClientDatanodeProtocol, org.apache.hadoop.ipc.ProtocolMetaInterface, org.apache.hadoop.ipc.ProtocolTranslator

@Private
@Stable
public class ClientDatanodeProtocolTranslatorPB
extends Object
implements org.apache.hadoop.ipc.ProtocolMetaInterface, ClientDatanodeProtocol, org.apache.hadoop.ipc.ProtocolTranslator, Closeable

This class is the client side translator to translate the requests made on ClientDatanodeProtocol interfaces to the RPC server implementing ClientDatanodeProtocolPB.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.slf4j.Logger	LOG

Fields inherited from interface org.apache.hadoop.hdfs.protocol.ClientDatanodeProtocol

versionID

Constructor Summary

Constructors

Constructor	Description
ClientDatanodeProtocolTranslatorPB(InetSocketAddress addr, org.apache.hadoop.security.UserGroupInformation ticket, org.apache.hadoop.conf.Configuration conf, SocketFactory factory)
ClientDatanodeProtocolTranslatorPB(DatanodeID datanodeid, org.apache.hadoop.conf.Configuration conf, int socketTimeout, boolean connectToDnViaHostname)	Constructor.
ClientDatanodeProtocolTranslatorPB(DatanodeID datanodeid, org.apache.hadoop.conf.Configuration conf, int socketTimeout, boolean connectToDnViaHostname, LocatedBlock locatedBlock)

Method Summary

Modifier and Type	Method	Description
void	cancelDiskBalancePlan(String planID)	Cancels an executing disk balancer plan.
void	close()
void	deleteBlockPool(String bpid, boolean force)	Delete the block pool directory.
void	evictWriters()	Evict clients that are writing to a datanode.
long	getBalancerBandwidth()	Get current value of the balancer bandwidth in bytes per second.
BlockLocalPathInfo	getBlockLocalPathInfo(ExtendedBlock block, org.apache.hadoop.security.token.Token<BlockTokenIdentifier> token)	Retrieves the path names of the block file and metadata file stored on the local file system.
DatanodeLocalInfo	getDatanodeInfo()	Obtains datanode info
String	getDiskBalancerSetting(String key)	Gets a run-time configuration value from running diskbalancer instance.
org.apache.hadoop.conf.ReconfigurationTaskStatus	getReconfigurationStatus()	Get the status of the previously issued reconfig task.
long	getReplicaVisibleLength(ExtendedBlock b)	Return the visible length of a replica.
Object	getUnderlyingProxyObject()
List<DatanodeVolumeInfo>	getVolumeReport()	Get volume report of datanode.
boolean	isMethodSupported(String methodName)
List<String>	listReconfigurableProperties()	Get a list of allowed properties for reconfiguration.
DiskBalancerWorkStatus	queryDiskBalancerPlan()	Gets the status of an executing diskbalancer Plan.
void	refreshNamenodes()	Refresh the list of federated namenodes from updated configuration Adds new namenodes and stops the deleted namenodes.
void	shutdownDatanode(boolean forUpgrade)	Shuts down a datanode.
void	startReconfiguration()	Asynchronously reload configuration on disk and apply changes.
void	submitDiskBalancerPlan(String planID, long planVersion, String planFile, String planData, boolean skipDateCheck)	Submits a disk balancer plan to the datanode.
void	triggerBlockReport(BlockReportOptions options)	Trigger a new block report.

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static final org.slf4j.Logger LOG

Constructor Details

ClientDatanodeProtocolTranslatorPB

public ClientDatanodeProtocolTranslatorPB(DatanodeID datanodeid,
 org.apache.hadoop.conf.Configuration conf,
 int socketTimeout,
 boolean connectToDnViaHostname,
 LocatedBlock locatedBlock)
                                   throws IOException

Throws:

IOException

ClientDatanodeProtocolTranslatorPB

public ClientDatanodeProtocolTranslatorPB(InetSocketAddress addr,
 org.apache.hadoop.security.UserGroupInformation ticket,
 org.apache.hadoop.conf.Configuration conf,
 SocketFactory factory)
                                   throws IOException

Throws:

IOException

ClientDatanodeProtocolTranslatorPB

public ClientDatanodeProtocolTranslatorPB(DatanodeID datanodeid,
 org.apache.hadoop.conf.Configuration conf,
 int socketTimeout,
 boolean connectToDnViaHostname)
                                   throws IOException

Constructor.

Parameters:

datanodeid - Datanode to connect to.

conf - Configuration.

socketTimeout - Socket timeout to use.

connectToDnViaHostname - connect to the Datanode using its hostname

Throws:

IOException

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getReplicaVisibleLength

public long getReplicaVisibleLength(ExtendedBlock b)
                             throws IOException

Description copied from interface: ClientDatanodeProtocol

Return the visible length of a replica.

Specified by:

getReplicaVisibleLength in interface ClientDatanodeProtocol

Throws:

IOException

refreshNamenodes

public void refreshNamenodes()
                      throws IOException

Description copied from interface: ClientDatanodeProtocol

Refresh the list of federated namenodes from updated configuration Adds new namenodes and stops the deleted namenodes.

Specified by:

refreshNamenodes in interface ClientDatanodeProtocol

Throws:

IOException - on error

deleteBlockPool

public void deleteBlockPool(String bpid,
 boolean force)
                     throws IOException

Description copied from interface: ClientDatanodeProtocol

Delete the block pool directory. If force is false it is deleted only if it is empty, otherwise it is deleted along with its contents.

Specified by:

deleteBlockPool in interface ClientDatanodeProtocol

Parameters:

bpid - Blockpool id to be deleted.

force - If false blockpool directory is deleted only if it is empty i.e. if it doesn't contain any block files, otherwise it is deleted along with its contents.

Throws:

IOException

getBlockLocalPathInfo

public BlockLocalPathInfo getBlockLocalPathInfo(ExtendedBlock block,
 org.apache.hadoop.security.token.Token<BlockTokenIdentifier> token)
                                         throws IOException

Description copied from interface: ClientDatanodeProtocol

Retrieves the path names of the block file and metadata file stored on the local file system. In order for this method to work, one of the following should be satisfied:

• The client user must be configured at the datanode to be able to use this method.
• When security is enabled, kerberos authentication must be used to connect to the datanode.

Specified by:

getBlockLocalPathInfo in interface ClientDatanodeProtocol

Parameters:

block - the specified block on the local datanode

token - the block access token.

Returns:

the BlockLocalPathInfo of a block

Throws:

IOException - on error

isMethodSupported

public boolean isMethodSupported(String methodName)
                          throws IOException

Specified by:

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

Throws:

IOException

getUnderlyingProxyObject

public Object getUnderlyingProxyObject()

Specified by:

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

shutdownDatanode

public void shutdownDatanode(boolean forUpgrade)
                      throws IOException

Description copied from interface: ClientDatanodeProtocol

Shuts down a datanode.

Specified by:

shutdownDatanode in interface ClientDatanodeProtocol

Parameters:

forUpgrade - If true, data node does extra prep work before shutting down. The work includes advising clients to wait and saving certain states for quick restart. This should only be used when the stored data will remain the same during upgrade/restart.

Throws:

IOException

evictWriters

public void evictWriters()
                  throws IOException

Description copied from interface: ClientDatanodeProtocol

Evict clients that are writing to a datanode.

Specified by:

evictWriters in interface ClientDatanodeProtocol

Throws:

IOException

getDatanodeInfo

public DatanodeLocalInfo getDatanodeInfo()
                                  throws IOException

Description copied from interface: ClientDatanodeProtocol

Obtains datanode info

Specified by:

getDatanodeInfo in interface ClientDatanodeProtocol

Returns:

software/config version and uptime of the datanode

Throws:

IOException

startReconfiguration

public void startReconfiguration()
                          throws IOException

Description copied from interface: ClientDatanodeProtocol

Asynchronously reload configuration on disk and apply changes.

Specified by:

startReconfiguration in interface ClientDatanodeProtocol

Throws:

IOException

getReconfigurationStatus

public org.apache.hadoop.conf.ReconfigurationTaskStatus getReconfigurationStatus()
                                                                          throws IOException

Description copied from interface: ClientDatanodeProtocol

Get the status of the previously issued reconfig task.

Specified by:

getReconfigurationStatus in interface ClientDatanodeProtocol

Throws:

IOException

See Also:

• ReconfigurationTaskStatus

listReconfigurableProperties

public List<String> listReconfigurableProperties()
                                          throws IOException

Description copied from interface: ClientDatanodeProtocol

Get a list of allowed properties for reconfiguration.

Specified by:

listReconfigurableProperties in interface ClientDatanodeProtocol

Throws:

IOException

triggerBlockReport

public void triggerBlockReport(BlockReportOptions options)
                        throws IOException

Description copied from interface: ClientDatanodeProtocol

Trigger a new block report.

Specified by:

triggerBlockReport in interface ClientDatanodeProtocol

Throws:

IOException

getBalancerBandwidth

public long getBalancerBandwidth()
                          throws IOException

Description copied from interface: ClientDatanodeProtocol

Get current value of the balancer bandwidth in bytes per second.

Specified by:

getBalancerBandwidth in interface ClientDatanodeProtocol

Returns:

balancer bandwidth

Throws:

IOException

submitDiskBalancerPlan

public void submitDiskBalancerPlan(String planID,
 long planVersion,
 String planFile,
 String planData,
 boolean skipDateCheck)
                            throws IOException

Submits a disk balancer plan to the datanode.

Specified by:

submitDiskBalancerPlan in interface ClientDatanodeProtocol

Parameters:

planID - - Plan ID is the hash512 string of the plan that is submitted. This is used by clients when they want to find local copies of these plans.

planVersion - - The data format of the plans - for future , not used now.

planFile - - Plan file name

planData - - Actual plan data in json format

skipDateCheck - - Skips the date check.

Throws:

IOException

cancelDiskBalancePlan

public void cancelDiskBalancePlan(String planID)
                           throws IOException

Cancels an executing disk balancer plan.

Specified by:

cancelDiskBalancePlan in interface ClientDatanodeProtocol

Parameters:

planID - - A SHA-1 hash of the plan string.

Throws:

IOException - on error

queryDiskBalancerPlan

public DiskBalancerWorkStatus queryDiskBalancerPlan()
                                             throws IOException

Gets the status of an executing diskbalancer Plan.

Specified by:

queryDiskBalancerPlan in interface ClientDatanodeProtocol

Throws:

IOException

getDiskBalancerSetting

public String getDiskBalancerSetting(String key)
                              throws IOException

Description copied from interface: ClientDatanodeProtocol

Gets a run-time configuration value from running diskbalancer instance. For example : Disk Balancer bandwidth of a running instance.

Specified by:

getDiskBalancerSetting in interface ClientDatanodeProtocol

Parameters:

key - runtime configuration key

Returns:

value of the key as a string.

Throws:

IOException - - Throws if there is no such key

getVolumeReport

public List<DatanodeVolumeInfo> getVolumeReport()
                                         throws IOException

Description copied from interface: ClientDatanodeProtocol

Get volume report of datanode.

Specified by:

getVolumeReport in interface ClientDatanodeProtocol

Throws:

IOException