Package org.apache.hadoop.security.alias

Class CredentialShell

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.tools.CommandShell

org.apache.hadoop.security.alias.CredentialShell

All Implemented Interfaces:

Configurable, Tool

public class CredentialShell
extends CommandShell

This program is the CLI utility for the CredentialProvider facilities in Hadoop.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialShell.PasswordReader	To facilitate testing since Console is a final class.

Nested classes/interfaces inherited from class org.apache.hadoop.tools.CommandShell

CommandShell.SubCommand

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NO_VALID_PROVIDERS

Constructor Summary

Constructors

Constructor	Description
CredentialShell()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommandUsage()	Return usage string for the command including any summary of subcommands.
CredentialShell.PasswordReader	getPasswordReader()
protected int	init(java.lang.String[] args)	Parse the command line arguments and initialize the data.
static void	main(java.lang.String[] args)	Main program.
protected char[]	promptForCredential()
void	setPasswordReader(CredentialShell.PasswordReader reader)

Methods inherited from class org.apache.hadoop.tools.CommandShell

getErr, getOut, printException, printShellUsage, run, setErr, setOut, setSubCommand

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

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

getConf, setConf

Field Detail

NO_VALID_PROVIDERS

@VisibleForTesting
public static final java.lang.String NO_VALID_PROVIDERS

See Also:

Constant Field Values

Constructor Detail

CredentialShell

public CredentialShell()

Method Detail

init

protected int init(java.lang.String[] args)
            throws java.io.IOException

Parse the command line arguments and initialize the data.

 % hadoop credential create alias [-provider providerPath]
 % hadoop credential list [-provider providerPath]
 % hadoop credential check alias [-provider providerPath]
 % hadoop credential delete alias [-provider providerPath] [-f]
 

Specified by:

init in class CommandShell

Parameters:

args - args.

Returns:

0 if the argument(s) were recognized, 1 otherwise

Throws:

java.io.IOException - raised on errors performing I/O.

getCommandUsage

public java.lang.String getCommandUsage()

Description copied from class: CommandShell

Return usage string for the command including any summary of subcommands.

Specified by:

getCommandUsage in class CommandShell

Returns:

command usage.

promptForCredential

protected char[] promptForCredential()
                              throws java.io.IOException

Throws:

java.io.IOException

getPasswordReader

public CredentialShell.PasswordReader getPasswordReader()

setPasswordReader

public void setPasswordReader(CredentialShell.PasswordReader reader)

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Main program.

Parameters:

args - Command line arguments

Throws:

java.lang.Exception - exception.