Package org.apache.hadoop.ha

Class HAAdmin

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.ha.HAAdmin

All Implemented Interfaces:

Configurable, Tool

@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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HAAdmin.UsageInfo	UsageInfo class holds args and help details.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.io.PrintStream	errOut	Output stream for errors, for use in tests
protected static java.lang.String	FORCEACTIVE
protected static java.lang.String	FORCEMANUAL	Undocumented flag which allows an administrator to use manual failover state transitions even when auto-failover is enabled.
protected java.io.PrintStream	out
protected static java.util.Map<java.lang.String,HAAdmin.UsageInfo>	USAGE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HAAdmin()
protected	HAAdmin(Configuration conf)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkManualStateManagementOK(HAServiceTarget target)	Ensure that we are allowed to manually manage the HA state of the target service.
protected boolean	checkParameterValidity(java.lang.String[] argv)
protected boolean	checkParameterValidity(java.lang.String[] argv, java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)
protected boolean	confirmForceManual()
protected HAServiceProtocol.StateChangeRequestInfo	createReqInfo()
protected int	getAllServiceState()
protected HAServiceProtocol.RequestSource	getRequestSource()
protected java.lang.String	getServiceAddr(java.lang.String serviceId)	Return the serviceId as is, we are assuming it was given as a service address of form <host:ipcport>.
protected java.util.Collection<java.lang.String>	getTargetIds(java.lang.String targetNodeToActivate)
protected java.lang.String	getUsageString()
protected int	gracefulFailoverThroughZKFCs(HAServiceTarget toNode)	Initiate a graceful failover by talking to the target node's ZKFC.
protected int	help(java.lang.String[] argv)
protected int	help(java.lang.String[] argv, java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)
protected org.apache.commons.cli.CommandLine	parseOpts(java.lang.String cmdName, org.apache.commons.cli.Options opts, java.lang.String[] argv)
protected org.apache.commons.cli.CommandLine	parseOpts(java.lang.String cmdName, org.apache.commons.cli.Options opts, java.lang.String[] argv, java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)
protected void	printUsage(java.io.PrintStream pStr)
protected void	printUsage(java.io.PrintStream pStr, java.lang.String cmd)
protected void	printUsage(java.io.PrintStream pStr, java.lang.String cmd, java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)
protected void	printUsage(java.io.PrintStream pStr, java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)
protected abstract HAServiceTarget	resolveTarget(java.lang.String string)
int	run(java.lang.String[] argv)	Execute the command with the given arguments.
protected int	runCmd(java.lang.String[] argv)
void	setConf(Configuration conf)	Set the configuration to be used by this object.
protected void	setRequestSource(HAServiceProtocol.RequestSource requestSource)

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

FORCEACTIVE

protected static final java.lang.String FORCEACTIVE

See Also:

Constant Field Values

FORCEMANUAL

protected static final java.lang.String FORCEMANUAL

Undocumented flag which allows an administrator to use manual failover state transitions even when auto-failover is enabled. This is an unsafe operation, which is why it is not documented in the usage below.

See Also:

Constant Field Values

USAGE

protected static final java.util.Map<java.lang.String,HAAdmin.UsageInfo> USAGE

errOut

protected java.io.PrintStream errOut

Output stream for errors, for use in tests

out

protected java.io.PrintStream out

Constructor Detail

HAAdmin

protected HAAdmin()

HAAdmin

protected HAAdmin(Configuration conf)

Method Detail

getRequestSource

protected HAServiceProtocol.RequestSource getRequestSource()

setRequestSource

protected void setRequestSource(HAServiceProtocol.RequestSource requestSource)

resolveTarget

protected abstract HAServiceTarget resolveTarget(java.lang.String string)

getTargetIds

protected java.util.Collection<java.lang.String> getTargetIds(java.lang.String targetNodeToActivate)

getUsageString

protected java.lang.String getUsageString()

printUsage

protected void printUsage(java.io.PrintStream pStr,
                          java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)

printUsage

protected void printUsage(java.io.PrintStream pStr)

printUsage

protected void printUsage(java.io.PrintStream pStr,
                          java.lang.String cmd,
                          java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)

printUsage

protected void printUsage(java.io.PrintStream pStr,
                          java.lang.String cmd)

checkManualStateManagementOK

protected boolean checkManualStateManagementOK(HAServiceTarget target)

Ensure that we are allowed to manually manage the HA state of the target service. If automatic failover is configured, then the automatic failover controllers should be doing state management, and it is generally an error to use the HAAdmin command line to do so.

Parameters:

target - the target to check

Returns:

true if manual state management is allowed

createReqInfo

protected HAServiceProtocol.StateChangeRequestInfo createReqInfo()

gracefulFailoverThroughZKFCs

protected int gracefulFailoverThroughZKFCs(HAServiceTarget toNode)
                                    throws java.io.IOException

Initiate a graceful failover by talking to the target node's ZKFC. This sends an RPC to the ZKFC, which coordinates the failover.

Parameters:

toNode - the node to fail to

Returns:

status code (0 for success)

Throws:

java.io.IOException - if failover does not succeed

getServiceAddr

protected java.lang.String getServiceAddr(java.lang.String serviceId)

Return the serviceId as is, we are assuming it was given as a service address of form <host:ipcport>.

Parameters:

serviceId - serviceId.

Returns:

service addr.

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

Parameters:

conf - configuration to be used

run

public int run(java.lang.String[] argv)
        throws java.lang.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:

java.lang.Exception - command exception.

checkParameterValidity

protected boolean checkParameterValidity(java.lang.String[] argv,
                                         java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)

checkParameterValidity

protected boolean checkParameterValidity(java.lang.String[] argv)

runCmd

protected int runCmd(java.lang.String[] argv)
              throws java.lang.Exception

Throws:

java.lang.Exception

getAllServiceState

protected int getAllServiceState()

confirmForceManual

protected boolean confirmForceManual()
                              throws java.io.IOException

Throws:

java.io.IOException

parseOpts

protected org.apache.commons.cli.CommandLine parseOpts(java.lang.String cmdName,
                                                       org.apache.commons.cli.Options opts,
                                                       java.lang.String[] argv,
                                                       java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)

parseOpts

protected org.apache.commons.cli.CommandLine parseOpts(java.lang.String cmdName,
                                                       org.apache.commons.cli.Options opts,
                                                       java.lang.String[] argv)

help

protected int help(java.lang.String[] argv)

help

protected int help(java.lang.String[] argv,
                   java.util.Map<java.lang.String,HAAdmin.UsageInfo> helpEntries)