org.apache.hadoop.fs.s3a.impl

Interface DirectoryPolicy

All Known Implementing Classes:

DirectoryPolicyImpl

public interface DirectoryPolicy

Interface for Directory Marker policies to implement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DirectoryPolicy.MarkerPolicy Supported retention policies.

Method Summary

Modifier and Type	Method and Description
String	describe() Describe the policy for marker tools and logs.
DirectoryPolicy.MarkerPolicy	getMarkerPolicy() Get the marker policy.
boolean	hasPathCapability(org.apache.hadoop.fs.Path path, String capability) Does a specific path have the relevant option.
boolean	keepDirectoryMarkers(org.apache.hadoop.fs.Path path) Should a directory marker be retained?

Method Detail

keepDirectoryMarkers

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

Should a directory marker be retained?

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

DirectoryPolicy.MarkerPolicy getMarkerPolicy()

Get the marker policy.

Returns:

policy.

describe

String describe()

Describe the policy for marker tools and logs.

Returns:

description of the current policy.

hasPathCapability

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

Does a specific path have the relevant option. This is to be forwarded from the S3AFileSystem.hasPathCapability But only for those capabilities related to markers*

Parameters:

path - path

capability - capability

Returns:

true if the capability is supported, false if not

Throws:

IllegalArgumentException - if the capability is unknown.