org.apache.hadoop.fs.s3a.s3guard

Class S3GuardTool

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.fs.s3a.s3guard.S3GuardTool

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

public abstract class S3GuardTool
extends org.apache.hadoop.conf.Configured
implements org.apache.hadoop.util.Tool

CLI to manage S3Guard Metadata Store.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DAYS_FLAG
static String	HOURS_FLAG
static String	META_FLAG
static String	MINUTES_FLAG
static String	READ_FLAG
static String	REGION_FLAG
static String	SECONDS_FLAG
static String	WRITE_FLAG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S3GuardTool(org.apache.hadoop.conf.Configuration conf, String... opts) Constructor a S3Guard tool with HDFS configuration.

Method Summary

Methods

Modifier and Type	Method and Description
protected static org.apache.hadoop.util.ExitUtil.ExitException	badState(String format, Object... args) Build the exception to raise on a bad store/bucket state.
protected static void	exit(int status, String text)
protected org.apache.hadoop.fs.shell.CommandFormat	getCommandFormat()
protected S3AFileSystem	getFilesystem()
MetadataStore	getStore()
abstract String	getUsage()
protected static org.apache.hadoop.util.ExitUtil.ExitException	invalidArgs(String format, Object... args) Build the exception to raise on invalid arguments.
static void	main(String[] args) Main entry point.
protected static void	printStoreDiagnostics(PrintStream out, MetadataStore store) Retrieve and Print store diagnostics.
static int	run(org.apache.hadoop.conf.Configuration conf, String... args) Execute the command with the given arguments.
int	run(String[] args)
abstract int	run(String[] args, PrintStream out) Run the tool, capturing the output (if the tool supports that).
protected void	setFilesystem(S3AFileSystem filesystem)
protected void	setStore(MetadataStore store)
protected static org.apache.hadoop.util.ExitUtil.ExitException	storeNotFound(FileNotFoundException e) Handle store not found by converting to an exit exception with specific error code.
protected static URI	toUri(String s3Path) Convert a path to a URI, catching any URISyntaxException and converting to an invalid args exception.

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

META_FLAG

public static final String META_FLAG

See Also:

Constant Field Values

DAYS_FLAG

public static final String DAYS_FLAG

See Also:

Constant Field Values

HOURS_FLAG

public static final String HOURS_FLAG

See Also:

Constant Field Values

MINUTES_FLAG

public static final String MINUTES_FLAG

See Also:

Constant Field Values

SECONDS_FLAG

public static final String SECONDS_FLAG

See Also:

Constant Field Values

REGION_FLAG

public static final String REGION_FLAG

See Also:

Constant Field Values

READ_FLAG

public static final String READ_FLAG

See Also:

Constant Field Values

WRITE_FLAG

public static final String WRITE_FLAG

See Also:

Constant Field Values

Constructor Detail

S3GuardTool

protected S3GuardTool(org.apache.hadoop.conf.Configuration conf,
           String... opts)

Constructor a S3Guard tool with HDFS configuration.

Parameters:

conf - Configuration.

opts - any boolean options to support

Method Detail

getUsage

public abstract String getUsage()

getFilesystem

protected S3AFileSystem getFilesystem()

setFilesystem

protected void setFilesystem(S3AFileSystem filesystem)

getStore

public MetadataStore getStore()

setStore

protected void setStore(MetadataStore store)

getCommandFormat

protected org.apache.hadoop.fs.shell.CommandFormat getCommandFormat()

run

public final int run(String[] args)
              throws Exception

Specified by:

run in interface org.apache.hadoop.util.Tool

Throws:

Exception

run

public abstract int run(String[] args,
      PrintStream out)
                 throws Exception

Run the tool, capturing the output (if the tool supports that). As well as returning an exit code, the implementations can choose to throw an instance of ExitUtil.ExitException with their exit code set to the desired exit value. The exit code of auch an exception is used for the tool's exit code, and the stack trace only logged at debug.

Parameters:

args - argument list

out - output stream

Returns:

the exit code to return.

Throws:

Exception - on any failure

ExitUtil.ExitException - for an alternative clean exit

toUri

protected static URI toUri(String s3Path)

Convert a path to a URI, catching any URISyntaxException and converting to an invalid args exception.

Parameters:

s3Path - path to convert to a URI

Returns:

a URI of the path

Throws:

ExitUtil.ExitException - INVALID_ARGUMENT if the URI is invalid

printStoreDiagnostics

protected static void printStoreDiagnostics(PrintStream out,
                         MetadataStore store)
                                     throws IOException

Retrieve and Print store diagnostics.

Parameters:

out - output stream

store - store

Throws:

IOException - Failure to retrieve the data.

storeNotFound

protected static org.apache.hadoop.util.ExitUtil.ExitException storeNotFound(FileNotFoundException e)

Handle store not found by converting to an exit exception with specific error code.

Parameters:

e - exception

Returns:

a new exception to throw

invalidArgs

protected static org.apache.hadoop.util.ExitUtil.ExitException invalidArgs(String format,
                                                        Object... args)

Build the exception to raise on invalid arguments.

Parameters:

format - string format

args - optional arguments for the string

Returns:

a new exception to throw

badState

protected static org.apache.hadoop.util.ExitUtil.ExitException badState(String format,
                                                     Object... args)

Build the exception to raise on a bad store/bucket state.

Parameters:

format - string format

args - optional arguments for the string

Returns:

a new exception to throw

run

public static int run(org.apache.hadoop.conf.Configuration conf,
      String... args)
               throws Exception

Execute the command with the given arguments.

Parameters:

conf - Hadoop configuration.

args - command specific arguments.

Returns:

exit code.

Throws:

Exception - on I/O errors.

main

public static void main(String[] args)

Main entry point. Calls System.exit() on all execution paths.

Parameters:

args - argument list

exit

protected static void exit(int status,
        String text)