alluxio.master.file

Class RpcContext

java.lang.Object

alluxio.master.file.RpcContext

All Implemented Interfaces:

Closeable, AutoCloseable, java.util.function.Supplier<JournalContext>

@NotThreadSafe
public final class RpcContext
extends Object
implements Closeable, java.util.function.Supplier<JournalContext>

Context passed through the span of a file system master RPC to manage actions that need to be taken when the body of the RPC is finished. Note that we cannot use Guava's Closer because it doesn't make guarantees about the order in which resources are closed.

Field Summary

Fields

Modifier and Type	Field and Description
static RpcContext	NOOP

Constructor Summary

Constructors

Constructor and Description
RpcContext(BlockDeletionContext blockDeleter, JournalContext journalContext, OperationContext operationContext) Creates an RpcContext.

Method Summary

Modifier and Type	Method and Description
void	close()
JournalContext	get()
BlockDeletionContext	getBlockDeletionContext()
JournalContext	getJournalContext()
OperationContext	getOperationContext()
boolean	isCancelled()
void	journal(Journal.JournalEntry entry) Syntax sugar for getJournalContext().append(entry).
void	throwIfCancelled() Throws RuntimeException if the RPC was cancelled by any tracker.

Methods inherited from class java.lang.Object

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

Field Detail

NOOP

public static final RpcContext NOOP

Constructor Detail

RpcContext

public RpcContext(BlockDeletionContext blockDeleter,
                  JournalContext journalContext,
                  OperationContext operationContext)

Creates an RpcContext. This class aggregates different contexts used over the course of an RPC, and makes sure they are closed in the right order when the RPC is finished.

Parameters:

blockDeleter - block deletion context

journalContext - journal context

operationContext - the operation context

Method Detail

getJournalContext

public JournalContext getJournalContext()

Returns:

the journal context

journal

public void journal(Journal.JournalEntry entry)

Syntax sugar for getJournalContext().append(entry).

Parameters:

entry - the Journal.JournalEntry to append to the journal

getBlockDeletionContext

public BlockDeletionContext getBlockDeletionContext()

Returns:

the block deletion context

getOperationContext

public OperationContext getOperationContext()

Returns:

the operation context

throwIfCancelled

public void throwIfCancelled()

Throws RuntimeException if the RPC was cancelled by any tracker.

isCancelled

public boolean isCancelled()

Returns:

true if the operation was cancelled

close

public void close()
           throws UnavailableException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

UnavailableException

get

public JournalContext get()

Specified by:

get in interface java.util.function.Supplier<JournalContext>