alluxio.master.file.meta

Class TtlBucketList

java.lang.Object

alluxio.master.file.meta.TtlBucketList

All Implemented Interfaces:

Checkpointed

@ThreadSafe
public final class TtlBucketList
extends Object
implements Checkpointed

A list of non-empty TtlBuckets sorted by ttl interval start time of each bucket.

Two adjacent buckets may not have adjacent intervals since there may be no inodes with ttl value in the skipped intervals.

Constructor Summary

Constructors

Constructor and Description
TtlBucketList(ReadOnlyInodeStore inodeStore) Creates a new list of TtlBuckets.

Method Summary

Modifier and Type	Method and Description
CheckpointName	getCheckpointName()
int	getNumBuckets()
long	getNumInodes()
void	insert(Inode inode) Insert inode to the ttlbucket with default number of retry attempts.
void	insert(Inode inode, int numOfRetry) Inserts an inode to the appropriate bucket where its ttl end time lies in the bucket's interval, if no appropriate bucket exists, a new bucket will be created to contain this inode, if ttl value is Constants.NO_TTL, the inode won't be inserted to any buckets and nothing will happen.
Inode	loadInode(long inodeId) Load inode from inode store on processing the provided inode id.
Set<TtlBucket>	pollExpiredBuckets(long time) Polls buckets whose ttl interval has expired before the specified time, that is, the bucket's interval start time should be less than or equal to (specified time - ttl interval).
void	remove(InodeView inode) Removes an inode from the bucket containing it if the inode is in one of the buckets, otherwise, do nothing.
void	restoreFromCheckpoint(CheckpointInputStream input) Restores state from a checkpoint.
void	writeToCheckpoint(OutputStream output) Writes a checkpoint of all state to the given output stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed

restoreFromCheckpoint, writeToCheckpoint

Constructor Detail

TtlBucketList

public TtlBucketList(ReadOnlyInodeStore inodeStore)

Creates a new list of TtlBuckets.

Parameters:

inodeStore - the inode store

Method Detail

loadInode

public Inode loadInode(long inodeId)

Load inode from inode store on processing the provided inode id.

Parameters:

inodeId -

Returns:

Inode

getNumBuckets

public int getNumBuckets()

Returns:

the number of TTL buckets

getNumInodes

public long getNumInodes()

Returns:

the total number of inodes in all the buckets

insert

public void insert(Inode inode)

Insert inode to the ttlbucket with default number of retry attempts.

Parameters:

inode -

insert

public void insert(Inode inode,
                   int numOfRetry)

Inserts an inode to the appropriate bucket where its ttl end time lies in the bucket's interval, if no appropriate bucket exists, a new bucket will be created to contain this inode, if ttl value is Constants.NO_TTL, the inode won't be inserted to any buckets and nothing will happen.

Parameters:

inode - the inode to be inserted

numOfRetry - number of retries left to process this inode

remove

public void remove(InodeView inode)

Removes an inode from the bucket containing it if the inode is in one of the buckets, otherwise, do nothing.

Assume that no inode in the buckets has ttl value that equals Constants.NO_TTL. If an inode with valid ttl value is inserted to the buckets and its ttl value is going to be set to Constants.NO_TTL later, be sure to remove the inode from the buckets first.

Parameters:

inode - the inode to be removed

pollExpiredBuckets

public Set<TtlBucket> pollExpiredBuckets(long time)

Polls buckets whose ttl interval has expired before the specified time, that is, the bucket's interval start time should be less than or equal to (specified time - ttl interval). if concurrently there are new inodes added to those polled buckets, we check if after the moment it got added and the bucket got polled out, we're not sure if InodeTtlChecker will process it sa part of this batch, it will create a new bucket and added there to retry. Check insert(Inode)

Parameters:

time - the expiration time

Returns:

a set of expired buckets or an empty set if no buckets have expired

getCheckpointName

public CheckpointName getCheckpointName()

Specified by:

getCheckpointName in interface Checkpointed

Returns:

a name for this checkpointed class

writeToCheckpoint

public void writeToCheckpoint(OutputStream output)
                       throws IOException,
                              InterruptedException

Description copied from interface: Checkpointed

Writes a checkpoint of all state to the given output stream. Implementations should make an effort to throw InterruptedException if they get interrupted while running.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

public void restoreFromCheckpoint(CheckpointInputStream input)
                           throws IOException

Description copied from interface: Checkpointed

Restores state from a checkpoint.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

input - an input stream with checkpoint data

Throws:

IOException