Package org.apache.hadoop.hdfs.server.diskbalancer.command

Class Command

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.hdfs.server.diskbalancer.command.Command

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.hadoop.conf.Configurable

Direct Known Subclasses:

CancelCommand, ExecuteCommand, HelpCommand, PlanCommand, QueryCommand, ReportCommand

public abstract class Command
extends org.apache.hadoop.conf.Configured
implements java.io.Closeable

Common interface for command handling.

Constructor Summary

Constructors

Constructor	Description
Command(org.apache.hadoop.conf.Configuration conf)	Constructs a command.
Command(org.apache.hadoop.conf.Configuration conf, java.io.PrintStream ps)	Constructs a command.

Method Summary

Modifier and Type	Method	Description
protected void	addValidCommandParameters(java.lang.String key, java.lang.String desc)	Adds valid params to the valid args table.
void	close()	Cleans any resources held by this command.
protected org.apache.hadoop.fs.FSDataOutputStream	create(java.lang.String fileName)	Returns a file created in the cluster.
abstract void	execute(org.apache.commons.cli.CommandLine cmd)	Executes the Client Calls.
java.net.URI	getClusterURI()	Gets cluster URL.
org.apache.hadoop.hdfs.protocol.ClientDatanodeProtocol	getDataNodeProxy(java.lang.String datanode)	Copied from DFSAdmin.java.
protected int	getDefaultTop()	returns default top number of nodes.
protected java.util.Set<java.lang.String>	getNodeList(java.lang.String listArg)	Gets the node set from a file or a string.
protected java.util.List<DiskBalancerDataNode>	getNodes(java.lang.String listArg)	Returns a DiskBalancer Node list from the Cluster or null if not found.
protected org.apache.hadoop.fs.Path	getOutputPath()	Returns the output path where the plan and snapshot gets written.
int	getTopNodes()	Get top number of nodes to be processed.
protected org.apache.hadoop.fs.FSDataInputStream	open(java.lang.String fileName)	Returns a InputStream to read data.
protected int	parseTopNodes(org.apache.commons.cli.CommandLine cmd, org.apache.commons.text.TextStringBuilder result)	Parse top number of nodes to be processed.
protected void	populatePathNames(DiskBalancerDataNode node)	Reads the Physical path of the disks we are balancing.
abstract void	printHelp()	Gets extended help for this command.
protected DiskBalancerCluster	readClusterInfo(org.apache.commons.cli.CommandLine cmd)	Process the URI and return the cluster with nodes setup.
protected void	recordOutput(org.apache.commons.text.TextStringBuilder result, java.lang.String outputLine)	Put output line to log and string buffer.
void	setCluster(DiskBalancerCluster newCluster)	Set DiskBalancer cluster
void	setClusterURI(java.net.URI clusterURI)	Set cluster URL.
protected void	setNodesToProcess(java.util.List<DiskBalancerDataNode> nodes)	Sets the list of Nodes to process.
protected void	setNodesToProcess(DiskBalancerDataNode node)	Sets the nodes to process.
protected void	setOutputPath(java.lang.String path)	Setup the outpath.
void	setTopNodes(int topNodes)	Set top number of nodes to be processed.
protected void	verifyCommandOptions(java.lang.String commandName, org.apache.commons.cli.CommandLine cmd)	Verifies if the command line options are sane.

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(org.apache.hadoop.conf.Configuration conf)

Constructs a command.

Command

public Command(org.apache.hadoop.conf.Configuration conf,
               java.io.PrintStream ps)

Constructs a command.

Method Detail

close

public void close()
           throws java.io.IOException

Cleans any resources held by this command.

The main goal is to delete id file created in .NameNodeConnector#checkAndMarkRunning , otherwise, it's not allowed to run multiple commands in a row.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

execute

public abstract void execute(org.apache.commons.cli.CommandLine cmd)
                      throws java.lang.Exception

Executes the Client Calls.

Parameters:

cmd - - CommandLine

Throws:

java.lang.Exception

printHelp

public abstract void printHelp()

Gets extended help for this command.

readClusterInfo

protected DiskBalancerCluster readClusterInfo(org.apache.commons.cli.CommandLine cmd)
                                       throws java.lang.Exception

Process the URI and return the cluster with nodes setup. This is used in all commands.

Parameters:

cmd - - CommandLine

Returns:

DiskBalancerCluster

Throws:

java.lang.Exception

setOutputPath

protected void setOutputPath(java.lang.String path)
                      throws java.io.IOException

Setup the outpath.

Parameters:

path - - Path or null to use default path.

Throws:

java.io.IOException

setNodesToProcess

protected void setNodesToProcess(DiskBalancerDataNode node)

Sets the nodes to process.

Parameters:

node - - Node

setNodesToProcess

protected void setNodesToProcess(java.util.List<DiskBalancerDataNode> nodes)

Sets the list of Nodes to process.

Parameters:

nodes - Nodes.

getNodeList

protected java.util.Set<java.lang.String> getNodeList(java.lang.String listArg)
                                               throws java.io.IOException

Gets the node set from a file or a string.

Parameters:

listArg - - String File URL or a comma separated list of node names.

Returns:

Set of node names

Throws:

java.io.IOException

getNodes

protected java.util.List<DiskBalancerDataNode> getNodes(java.lang.String listArg)
                                                 throws java.io.IOException

Returns a DiskBalancer Node list from the Cluster or null if not found.

Parameters:

listArg - String File URL or a comma separated list of node names.

Returns:

List of DiskBalancer Node

Throws:

java.io.IOException

verifyCommandOptions

protected void verifyCommandOptions(java.lang.String commandName,
                                    org.apache.commons.cli.CommandLine cmd)

Verifies if the command line options are sane.

Parameters:

commandName - - Name of the command

cmd - - Parsed Command Line

getClusterURI

public java.net.URI getClusterURI()

Gets cluster URL.

Returns:

- URL

setClusterURI

public void setClusterURI(java.net.URI clusterURI)

Set cluster URL.

Parameters:

clusterURI - - URL

getDataNodeProxy

public org.apache.hadoop.hdfs.protocol.ClientDatanodeProtocol getDataNodeProxy(java.lang.String datanode)
                                                                        throws java.io.IOException

Copied from DFSAdmin.java. -- Creates a connection to dataNode.

Parameters:

datanode - - dataNode.

Returns:

ClientDataNodeProtocol

Throws:

java.io.IOException

create

protected org.apache.hadoop.fs.FSDataOutputStream create(java.lang.String fileName)
                                                  throws java.io.IOException

Returns a file created in the cluster.

Parameters:

fileName - - fileName to open.

Returns:

OutputStream.

Throws:

java.io.IOException

open

protected org.apache.hadoop.fs.FSDataInputStream open(java.lang.String fileName)
                                               throws java.io.IOException

Returns a InputStream to read data.

Throws:

java.io.IOException

getOutputPath

protected org.apache.hadoop.fs.Path getOutputPath()

Returns the output path where the plan and snapshot gets written.

Returns:

Path

addValidCommandParameters

protected void addValidCommandParameters(java.lang.String key,
                                         java.lang.String desc)

Adds valid params to the valid args table.

Parameters:

key -

desc -

getDefaultTop

protected int getDefaultTop()

returns default top number of nodes.

Returns:

default top number of nodes.

recordOutput

protected void recordOutput(org.apache.commons.text.TextStringBuilder result,
                            java.lang.String outputLine)

Put output line to log and string buffer.

parseTopNodes

protected int parseTopNodes(org.apache.commons.cli.CommandLine cmd,
                            org.apache.commons.text.TextStringBuilder result)
                     throws java.lang.IllegalArgumentException

Parse top number of nodes to be processed.

Returns:

top number of nodes to be processed.

Throws:

java.lang.IllegalArgumentException

populatePathNames

protected void populatePathNames(DiskBalancerDataNode node)
                          throws java.io.IOException

Reads the Physical path of the disks we are balancing. This is needed to make the disk balancer human friendly and not used in balancing.

Parameters:

node - - Disk Balancer Node.

Throws:

java.io.IOException

setTopNodes

public void setTopNodes(int topNodes)

Set top number of nodes to be processed.

getTopNodes

public int getTopNodes()

Get top number of nodes to be processed.

Returns:

top number of nodes to be processed.

setCluster

@VisibleForTesting
public void setCluster(DiskBalancerCluster newCluster)

Set DiskBalancer cluster