alluxio.client.lineage

Class LineageMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.lineage.LineageMasterClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

@ThreadSafe
public final class LineageMasterClient
extends AbstractMasterClient

A wrapper for the thrift client to interact with the lineage master, used by alluxio clients. Since thrift clients are not thread safe, this class is a wrapper to provide thread safety, and to provide retries.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

mAddress, mClosed, mConnected, mProtocol, mServiceVersion

Constructor Summary

Constructors

Constructor and Description
LineageMasterClient(MasterClientConfig conf) Creates a new lineage master client.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
long	createLineage(List<String> inputFiles, List<String> outputFiles, CommandLineJob job) Creates a lineage.
boolean	deleteLineage(long lineageId, boolean cascade) Deletes a lineage.
protected AlluxioService.Client	getClient()
List<LineageInfo>	getLineageInfoList() Retrieves the list of lineage information.
protected String	getServiceName()
protected long	getServiceVersion()
long	reinitializeFile(String path, long blockSizeBytes, long ttl, TtlAction ttlAction) Reinitializates a given file.
void	reportLostFile(String path) Reports a file as lost.

Methods inherited from class alluxio.AbstractMasterClient

getAddress

Methods inherited from class alluxio.AbstractClient

afterDisconnect, beforeDisconnect, checkVersion, close, connect, disconnect, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Constructor Detail

LineageMasterClient

public LineageMasterClient(MasterClientConfig conf)

Creates a new lineage master client.

Parameters:

conf - master client configuration

Method Detail

getClient

protected AlluxioService.Client getClient()

Specified by:

getClient in class AbstractClient

Returns:

a Thrift service client

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

createLineage

public long createLineage(List<String> inputFiles,
                          List<String> outputFiles,
                          CommandLineJob job)
                   throws IOException

Creates a lineage.

Parameters:

inputFiles - the list of input file names

outputFiles - the list of output file names

job - the job used for the creation

Returns:

the value of the lineage creation result

Throws:

IOException

deleteLineage

public boolean deleteLineage(long lineageId,
                             boolean cascade)
                      throws IOException

Deletes a lineage.

Parameters:

lineageId - the id of the lineage

cascade - true if the deletion is cascading, false otherwise

Returns:

true if the deletion was successful, false otherwise

Throws:

IOException

reinitializeFile

public long reinitializeFile(String path,
                             long blockSizeBytes,
                             long ttl,
                             TtlAction ttlAction)
                      throws IOException

Reinitializates a given file.

Parameters:

path - the path to the file

blockSizeBytes - the size of the block in bytes

ttl - the time to live for the file

ttlAction - Action to take after Ttl expiry

Returns:

the value of the lineage creation result

Throws:

IOException

getLineageInfoList

public List<LineageInfo> getLineageInfoList()
                                     throws IOException

Retrieves the list of lineage information.

Returns:

a list of lineage information

Throws:

IOException

reportLostFile

public void reportLostFile(String path)
                    throws IOException

Reports a file as lost.

Parameters:

path - the path to the lost file

Throws:

IOException