org.apache.hadoop.fs.s3a.s3guard

Class AuthoritativeAuditOperation

java.lang.Object

org.apache.hadoop.fs.s3a.impl.AbstractStoreOperation

org.apache.hadoop.fs.s3a.s3guard.AuthoritativeAuditOperation

public class AuthoritativeAuditOperation
extends AbstractStoreOperation

Audit a directory tree for being authoritative. One aspect of the audit to be aware of: the root directory is always considered authoritative, even though, because there is no matching entry in any of the stores, it is not strictly true.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthoritativeAuditOperation.NonAuthoritativeDirException A directory was found which was non-authoritative.

Field Summary

Fields

Modifier and Type	Field and Description
static String	E_NONAUTH Exception error string: "Directory is not marked as authoritative in the S3Guard store".
static int	ERROR_ENTRY_NOT_AUTH_IN_DDB Exception error code when a path is non-auth in the DB}.
static int	ERROR_PATH_NOT_AUTH_IN_FS Exception error code when a path is not configured to be auth in the S3A FS Config: 5.

Constructor Summary

Constructors

Constructor and Description
AuthoritativeAuditOperation(StoreContext storeContext, DynamoDBMetadataStore metastore, boolean requireAuthoritative, boolean verbose) Constructor.

Method Summary

Modifier and Type	Method and Description
org.apache.commons.lang3.tuple.Pair<Integer,Integer>	audit(org.apache.hadoop.fs.Path path) Audit the tree.

Methods inherited from class org.apache.hadoop.fs.s3a.impl.AbstractStoreOperation

activateAuditSpan, getAuditSpan, getStoreContext

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_ENTRY_NOT_AUTH_IN_DDB

public static final int ERROR_ENTRY_NOT_AUTH_IN_DDB

Exception error code when a path is non-auth in the DB}.

See Also:

Constant Field Values

ERROR_PATH_NOT_AUTH_IN_FS

public static final int ERROR_PATH_NOT_AUTH_IN_FS

Exception error code when a path is not configured to be auth in the S3A FS Config: 5.

See Also:

Constant Field Values

E_NONAUTH

public static final String E_NONAUTH

Exception error string: "Directory is not marked as authoritative in the S3Guard store".

See Also:

Constant Field Values

Constructor Detail

AuthoritativeAuditOperation

public AuthoritativeAuditOperation(StoreContext storeContext,
                                   DynamoDBMetadataStore metastore,
                                   boolean requireAuthoritative,
                                   boolean verbose)

Constructor.

Parameters:

storeContext - store context.

metastore - metastore

requireAuthoritative - require all directories to be authoritative

verbose - verbose output

Method Detail

audit

public org.apache.commons.lang3.tuple.Pair<Integer,Integer> audit(org.apache.hadoop.fs.Path path)
                                                           throws IOException

Audit the tree.

Parameters:

path - qualified path to scan

Returns:

tuple(dirs scanned, nonauth dirs found)

Throws:

IOException - IO failure

ExitUtil.ExitException - if a non-auth dir was found.