org.apache.hadoop.crypto.key
Class KeyShell

java.lang.Object
  org.apache.hadoop.conf.Configured
      org.apache.hadoop.crypto.key.KeyShell

All Implemented Interfaces:

Configurable, Tool

public class KeyShell
extends Configured
implements Tool

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

Field Summary

PrintStream	err allows stderr to be captured if necessary
PrintStream	out allows stdout to be captured if necessary

Constructor Summary

KeyShell()

Method Summary

static void	main(String[] args) main() entry point for the KeyShell.
int	run(String[] args) Primary entry point for the KeyShell; called via main().

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

out

public PrintStream out

allows stdout to be captured if necessary

err

public PrintStream err

allows stderr to be captured if necessary

Constructor Detail

KeyShell

public KeyShell()

Method Detail

run

public int run(String[] args)
        throws Exception

Primary entry point for the KeyShell; called via main().

Specified by:

run in interface Tool

Parameters:

args - Command line arguments.

Returns:

0 on success and 1 on failure. This value is passed back to the unix shell, so we must follow shell return code conventions: the return code is an unsigned character, and 0 means success, and small positive integers mean failure.

Throws:

Exception

main

public static void main(String[] args)
                 throws 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:

Exception