org.apache.hadoop.ha

Class HAAdmin

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.ha.HAAdmin

All Implemented Interfaces:

Configurable, Tool

Direct Known Subclasses:

DFSHAAdmin

@InterfaceAudience.Private
public abstract class HAAdmin
extends Configured
implements Tool

A command-line tool for making calls in the HAServiceProtocol. For example,. this can be used to force a service to standby or active mode, or to trigger a health-check.

Field Summary

Fields

Modifier and Type	Field and Description
protected PrintStream	errOut Output stream for errors, for use in tests
protected PrintStream	out

Constructor Summary

Constructors

Constructor and Description
HAAdmin()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getServiceAddr(String serviceId) Return the serviceId as is, we are assuming it was given as a service address of form .
protected String	getUsageString()
protected void	printUsage(PrintStream errOut)
protected abstract HAServiceTarget	resolveTarget(String string)
int	run(String[] argv) Execute the command with the given arguments.
protected int	runCmd(String[] argv)
void	setConf(Configuration conf) Set the configuration to be used by this object.

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

getConf

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.conf.Configurable

getConf

Field Detail

errOut

protected PrintStream errOut

Output stream for errors, for use in tests

out

protected PrintStream out

Constructor Detail

HAAdmin

public HAAdmin()

Method Detail

resolveTarget

protected abstract HAServiceTarget resolveTarget(String string)

getUsageString

protected String getUsageString()

printUsage

protected void printUsage(PrintStream errOut)

getServiceAddr

protected String getServiceAddr(String serviceId)

Return the serviceId as is, we are assuming it was given as a service address of form .

setConf

public void setConf(Configuration conf)

Description copied from interface: Configurable

Set the configuration to be used by this object.

Specified by:

setConf in interface Configurable

Overrides:

setConf in class Configured

run

public int run(String[] argv)
        throws Exception

Description copied from interface: Tool

Execute the command with the given arguments.

Specified by:

run in interface Tool

Parameters:

argv - command specific arguments.

Returns:

exit code.

Throws:

Exception

runCmd

protected int runCmd(String[] argv)
              throws Exception

Throws:

Exception