org.apache.hadoop.fs.s3a.s3guard

Class AbstractS3GuardDynamoDBDiagnostic

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.launcher.AbstractLaunchableService

org.apache.hadoop.fs.s3a.s3guard.AbstractS3GuardDynamoDBDiagnostic

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.launcher.LaunchableService, org.apache.hadoop.service.Service

Direct Known Subclasses:

DumpS3GuardDynamoTable, PurgeS3GuardDynamoTable

public class AbstractS3GuardDynamoDBDiagnostic
extends org.apache.hadoop.service.launcher.AbstractLaunchableService

Entry point for S3Guard diagnostics operations against DynamoDB tables.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor and Description
AbstractS3GuardDynamoDBDiagnostic(String name) Constructor.
AbstractS3GuardDynamoDBDiagnostic(String name, S3AFileSystem filesystem, DynamoDBMetadataStore store, URI uri) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.conf.Configuration	bindArgs(org.apache.hadoop.conf.Configuration config, List<String> args)
protected void	bindFromCLI(String fsURI) Bind to the store from a CLI argument.
protected static org.apache.hadoop.service.launcher.ServiceLaunchException	failure(String message) Generate a failure exception for throwing.
protected static org.apache.hadoop.service.launcher.ServiceLaunchException	failure(String message, Throwable ex) Generate a failure exception for throwing.
protected List<String>	getArgumentList(int argMin, int argMax, String usage) Get the list of arguments, after validating the list size.
protected List<String>	getArguments() Get the argument list.
S3AFileSystem	getFilesystem()
protected DynamoDBMetadataStore	getStore()
URI	getUri()
protected static void	require(boolean condition, String error) Require a condition to hold, otherwise an exception is thrown.
void	setUri(String fsURI) Set the URI from a string; will add a "/" if needed.
void	setUri(URI uri)

Methods inherited from class org.apache.hadoop.service.launcher.AbstractLaunchableService

execute

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceInit, serviceStart, serviceStop, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Constructor Detail

AbstractS3GuardDynamoDBDiagnostic

public AbstractS3GuardDynamoDBDiagnostic(String name)

Constructor.

Parameters:

name - entry point name.

AbstractS3GuardDynamoDBDiagnostic

public AbstractS3GuardDynamoDBDiagnostic(String name,
                                         @Nullable
                                         S3AFileSystem filesystem,
                                         @Nullable
                                         DynamoDBMetadataStore store,
                                         @Nullable
                                         URI uri)

Constructor. If the store is set then that is the store for the operation, otherwise the filesystem's binding is used instead.

Parameters:

name - entry point name.

filesystem - filesystem

store - optional metastore.

uri - URI. Must be set if filesystem == null.

Method Detail

require

protected static void require(boolean condition,
                              String error)

Require a condition to hold, otherwise an exception is thrown.

Parameters:

condition - condition to be true

error - text on failure.

Throws:

org.apache.hadoop.service.launcher.ServiceLaunchException - if the condition is not met

failure

protected static org.apache.hadoop.service.launcher.ServiceLaunchException failure(String message,
                                                                                   Throwable ex)

Generate a failure exception for throwing.

Parameters:

message - message

ex - optional nested exception.

Returns:

an exception to throw

failure

protected static org.apache.hadoop.service.launcher.ServiceLaunchException failure(String message)

Generate a failure exception for throwing.

Parameters:

message - message

Returns:

an exception to throw

bindArgs

public org.apache.hadoop.conf.Configuration bindArgs(org.apache.hadoop.conf.Configuration config,
                                                     List<String> args)
                                              throws Exception

Specified by:

bindArgs in interface org.apache.hadoop.service.launcher.LaunchableService

Overrides:

bindArgs in class org.apache.hadoop.service.launcher.AbstractLaunchableService

Throws:

Exception

getArguments

protected List<String> getArguments()

Get the argument list.

Returns:

the argument list.

bindFromCLI

protected void bindFromCLI(String fsURI)
                    throws IOException

Bind to the store from a CLI argument.

Parameters:

fsURI - filesystem URI

Throws:

IOException - failure

getStore

protected DynamoDBMetadataStore getStore()

getFilesystem

public S3AFileSystem getFilesystem()

getUri

public URI getUri()

setUri

public void setUri(URI uri)

setUri

public void setUri(String fsURI)

Set the URI from a string; will add a "/" if needed.

Parameters:

fsURI - filesystem URI.

Throws:

RuntimeException - if the fsURI parameter is not a valid URI.

getArgumentList

protected List<String> getArgumentList(int argMin,
                                       int argMax,
                                       String usage)

Get the list of arguments, after validating the list size.

Parameters:

argMin - minimum number of entries.

argMax - maximum number of entries.

usage - Usage message.

Returns:

the argument list, which will be in the range.

Throws:

org.apache.hadoop.service.launcher.ServiceLaunchException - if the argument list is not valid.