org.apache.hadoop.fs.s3a.s3guard

Interface ITtlTimeProvider

All Known Implementing Classes:

S3Guard.TtlTimeProvider

public interface ITtlTimeProvider

This interface is defined for handling TTL expiry of metadata in S3Guard. TTL can be tested by implementing this interface and setting is as S3Guard.ttlTimeProvider. By doing this, getNow() can return any value preferred and flaky tests could be avoided. By default getNow() returns the EPOCH in runtime. Time is measured in milliseconds,

Method Summary

Modifier and Type	Method and Description
long	getMetadataTtl() The TTL of the metadata.
long	getNow() The current time in milliseconds.

Method Detail

getNow

long getNow()

The current time in milliseconds. Assuming this calls System.currentTimeMillis(), this is a native iO call and so should be invoked sparingly (i.e. evaluate before any loop, rather than inside).

Returns:

the current time.

getMetadataTtl

long getMetadataTtl()

The TTL of the metadata.

Returns:

time in millis after which metadata is considered out of date.