Package org.apache.hadoop.crypto.key

Class KeyShell

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.tools.CommandShell

org.apache.hadoop.crypto.key.KeyShell

All Implemented Interfaces:

Configurable, Tool

public class KeyShell
extends CommandShell

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

Nested Class Summary

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
KeyShell()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCommandUsage()	Return usage string for the command including any summary of subcommands.
protected int	init(java.lang.String[] args)	Parse the command line arguments and initialize the data.
static void	main(java.lang.String[] args)	main() entry point for the KeyShell.
protected void	printException(java.lang.Exception e)

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

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

KeyShell

public KeyShell()

Method Detail

init

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

Parse the command line arguments and initialize the data.

 % hadoop key create keyName [-size size] [-cipher algorithm]
    [-provider providerPath]
 % hadoop key roll keyName [-provider providerPath]
 % hadoop key list [-provider providerPath]
 % hadoop key delete keyName [-provider providerPath] [-i]
 % hadoop key invalidateCache keyName [-provider providerPath]
 

Specified by:

init in class CommandShell

Parameters:

args - Command line arguments.

Returns:

0 on success, 1 on failure.

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.

printException

protected void printException(java.lang.Exception e)

Overrides:

printException in class CommandShell

main

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

main() entry point for the KeyShell. While strictly speaking the return is void, it will System.exit() with a return code: 0 is for success and 1 for failure.

Parameters:

args - Command line arguments.

Throws:

java.lang.Exception - raised on errors performing I/O.