org.apache.hadoop.fs.s3a.impl

Class DirectoryPolicyImpl

java.lang.Object

org.apache.hadoop.fs.s3a.impl.DirectoryPolicyImpl

All Implemented Interfaces:

DirectoryPolicy

public final class DirectoryPolicyImpl
extends Object
implements DirectoryPolicy

Implementation of directory policy.

As only the DELETE policy is supported, the policy logic here is relatively straightforward.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.fs.s3a.impl.DirectoryPolicy

DirectoryPolicy.MarkerPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static DirectoryPolicy	DELETE Delete all markers.
static String	UNKNOWN_MARKER_POLICY Error string when unable to parse the marker policy option.

Constructor Summary

Constructors

Constructor and Description
DirectoryPolicyImpl(DirectoryPolicy.MarkerPolicy markerPolicy, Predicate<org.apache.hadoop.fs.Path> authoritativeness) Constructor.

Method Summary

Modifier and Type	Method and Description
static Set<DirectoryPolicy.MarkerPolicy>	availablePolicies() Enumerate all available policies.
String	describe() Describe the policy for marker tools and logs.
static DirectoryPolicy	getDirectoryPolicy(org.apache.hadoop.conf.Configuration conf) Create/Get the policy for this configuration.
DirectoryPolicy.MarkerPolicy	getMarkerPolicy() Get the marker policy.
boolean	hasPathCapability(org.apache.hadoop.fs.Path path, String capability) Return path policy for store and paths.
boolean	keepDirectoryMarkers(org.apache.hadoop.fs.Path path) Should a directory marker be retained?
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_MARKER_POLICY

public static final String UNKNOWN_MARKER_POLICY

Error string when unable to parse the marker policy option.

See Also:

Constant Field Values

DELETE

public static final DirectoryPolicy DELETE

Delete all markers.

Constructor Detail

DirectoryPolicyImpl

public DirectoryPolicyImpl(DirectoryPolicy.MarkerPolicy markerPolicy,
                           Predicate<org.apache.hadoop.fs.Path> authoritativeness)

Constructor.

Parameters:

markerPolicy - marker policy

authoritativeness - function for authoritativeness

Method Detail

keepDirectoryMarkers

public boolean keepDirectoryMarkers(org.apache.hadoop.fs.Path path)

Description copied from interface: DirectoryPolicy

Should a directory marker be retained?

Specified by:

keepDirectoryMarkers in interface DirectoryPolicy

Parameters:

path - path a file/directory is being created with.

Returns:

true if the marker MAY be kept, false if it MUST be deleted.

getMarkerPolicy

public DirectoryPolicy.MarkerPolicy getMarkerPolicy()

Description copied from interface: DirectoryPolicy

Get the marker policy.

Specified by:

getMarkerPolicy in interface DirectoryPolicy

Returns:

policy.

describe

public String describe()

Description copied from interface: DirectoryPolicy

Describe the policy for marker tools and logs.

Specified by:

describe in interface DirectoryPolicy

Returns:

description of the current policy.

toString

public String toString()

Overrides:

toString in class Object

hasPathCapability

public boolean hasPathCapability(org.apache.hadoop.fs.Path path,
                                 String capability)

Return path policy for store and paths.

Specified by:

hasPathCapability in interface DirectoryPolicy

Parameters:

path - path

capability - capability

Returns:

true if a capability is active

getDirectoryPolicy

public static DirectoryPolicy getDirectoryPolicy(org.apache.hadoop.conf.Configuration conf)

Create/Get the policy for this configuration.

Parameters:

conf - config

Returns:

a policy

availablePolicies

public static Set<DirectoryPolicy.MarkerPolicy> availablePolicies()

Enumerate all available policies.

Returns:

set of the policies.