alluxio.underfs

Class ObjectPositionReader

java.lang.Object

alluxio.underfs.ObjectPositionReader

All Implemented Interfaces:

PositionReader, Closeable, AutoCloseable

Direct Known Subclasses:

COSPositionReader, GCSPositionReader, OBSPositionReader, OSSPositionReader, S3APositionReader

public abstract class ObjectPositionReader
extends Object
implements PositionReader

A stream for reading data using position reader.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mBucketName Name of the bucket the object resides in.
protected long	mFileLength Length of the file.
protected String	mPath Path of the file when it is uploaded to object storage.

Constructor Summary

Constructors

Constructor and Description
ObjectPositionReader(String bucketName, String path, long fileLength)

Method Summary

Modifier and Type	Method and Description
protected abstract InputStream	openObjectInputStream(long position, int bytesToRead)
int	readInternal(long position, ReadTargetBuffer buffer, int length)

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.PositionReader

close, read, read, read, read, read

Field Detail

mPath

protected final String mPath

Path of the file when it is uploaded to object storage.

mFileLength

protected final long mFileLength

Length of the file.

mBucketName

protected final String mBucketName

Name of the bucket the object resides in.

Constructor Detail

ObjectPositionReader

public ObjectPositionReader(String bucketName,
                            String path,
                            long fileLength)

Parameters:

bucketName - the bucket name

path - path of the file when it is uploaded to object storage

fileLength - the file length

Method Detail

readInternal

public int readInternal(long position,
                        ReadTargetBuffer buffer,
                        int length)
                 throws IOException

Specified by:

readInternal in interface PositionReader

Parameters:

position - position of the file to start reading data

buffer - target byte buffer

length - bytes to read

Returns:

bytes read, or -1 none of data is read

Throws:

IOException

openObjectInputStream

protected abstract InputStream openObjectInputStream(long position,
                                                     int bytesToRead)
                                              throws IOException

Parameters:

position - position of the file to start reading data

bytesToRead - bytes to read

Returns:

input stream of Object Storage's API

Throws:

IOException