org.apache.hadoop.hdfs.protocolPB

Class ClientDatanodeProtocolTranslatorPB

java.lang.Object

org.apache.hadoop.hdfs.protocolPB.ClientDatanodeProtocolTranslatorPB

All Implemented Interfaces:

Closeable, AutoCloseable, ClientDatanodeProtocol, ProtocolMetaInterface, ProtocolTranslator

@InterfaceAudience.Private
@InterfaceStability.Stable
public class ClientDatanodeProtocolTranslatorPB
extends Object
implements ProtocolMetaInterface, ClientDatanodeProtocol, 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 and Description
static org.apache.commons.logging.Log	LOG

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

versionID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	deleteBlockPool(String bpid, boolean force) Delete the block pool directory.
BlockLocalPathInfo	getBlockLocalPathInfo(ExtendedBlock block, Token<BlockTokenIdentifier> token) Retrieves the path names of the block file and metadata file stored on the local file system.
HdfsBlocksMetadata	getHdfsBlocksMetadata(List<ExtendedBlock> blocks, List<Token<BlockTokenIdentifier>> tokens) Retrieves volume location information about a list of blocks on a datanode.
long	getReplicaVisibleLength(ExtendedBlock b) Return the visible length of a replica.
Object	getUnderlyingProxyObject() Return the proxy object underlying this protocol translator.
boolean	isMethodSupported(String methodName) Checks whether the given method name is supported by the server.
void	refreshNamenodes() Refresh the list of federated namenodes from updated configuration Adds new namenodes and stops the deleted namenodes.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Constructor Detail

ClientDatanodeProtocolTranslatorPB

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

Throws:

IOException

ClientDatanodeProtocolTranslatorPB

public ClientDatanodeProtocolTranslatorPB(InetSocketAddress addr,
                                  UserGroupInformation ticket,
                                  Configuration conf,
                                  SocketFactory factory)
                                   throws IOException

Throws:

IOException

ClientDatanodeProtocolTranslatorPB

public ClientDatanodeProtocolTranslatorPB(DatanodeID datanodeid,
                                  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 Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

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,
                                       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

Description copied from interface: ProtocolMetaInterface

Checks whether the given method name is supported by the server. It is assumed that all method names are unique for a protocol.

Specified by:

isMethodSupported in interface ProtocolMetaInterface

Parameters:

methodName - The name of the method

Returns:

true if method is supported, otherwise false.

Throws:

IOException

getUnderlyingProxyObject

public Object getUnderlyingProxyObject()

Description copied from interface: ProtocolTranslator

Return the proxy object underlying this protocol translator.

Specified by:

getUnderlyingProxyObject in interface ProtocolTranslator

Returns:

the proxy object underlying this protocol translator.

getHdfsBlocksMetadata

public HdfsBlocksMetadata getHdfsBlocksMetadata(List<ExtendedBlock> blocks,
                                       List<Token<BlockTokenIdentifier>> tokens)
                                         throws IOException

Description copied from interface: ClientDatanodeProtocol

Retrieves volume location information about a list of blocks on a datanode. This is in the form of an opaque VolumeId for each configured data directory, which is not guaranteed to be the same across DN restarts.

Specified by:

getHdfsBlocksMetadata in interface ClientDatanodeProtocol

Parameters:

blocks - list of blocks on the local datanode

tokens - block access tokens corresponding to the requested blocks

Returns:

an HdfsBlocksMetadata that associates ExtendedBlocks with data directories

Throws:

IOException - if datanode is unreachable, or replica is not found on datanode