alluxio.underfs.swift

Class SwiftInputStream

java.lang.Object

java.io.InputStream

alluxio.underfs.MultiRangeObjectInputStream

alluxio.underfs.swift.SwiftInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public class SwiftInputStream
extends MultiRangeObjectInputStream

A stream for reading data from a Swift API based object store. This class maintains the following invariant: mStream is set to null whenever a read operation increments mPos to a chunk boundary.

Field Summary

Fields inherited from class alluxio.underfs.MultiRangeObjectInputStream

mClosed, mEndPos, mPos, mStream

Constructor Summary

Constructors

Constructor and Description
SwiftInputStream(org.javaswift.joss.model.Account account, String container, String object, long position, RetryPolicy retryPolicy, long multiRangeChunkSize) Constructor for an input stream to an object in a Swift API based store.
SwiftInputStream(org.javaswift.joss.model.Account account, String container, String object, RetryPolicy retryPolicy, long multiRangeChunkSize) Constructor for an input stream to an object in a Swift API based store.

Method Summary

Modifier and Type	Method and Description
protected InputStream	createStream(long startPos, long endPos) Opens a new stream reading a range.

Methods inherited from class alluxio.underfs.MultiRangeObjectInputStream

close, read, read, read, skip

Methods inherited from class java.io.InputStream

available, mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

SwiftInputStream

public SwiftInputStream(org.javaswift.joss.model.Account account,
                        String container,
                        String object,
                        RetryPolicy retryPolicy,
                        long multiRangeChunkSize)

Constructor for an input stream to an object in a Swift API based store.

Parameters:

account - JOSS account with authentication credentials

container - the name of container where the object resides

object - path of the object in the container

retryPolicy - retry policy in case the object does not exist

multiRangeChunkSize - the chunk size to use on this stream

SwiftInputStream

public SwiftInputStream(org.javaswift.joss.model.Account account,
                        String container,
                        String object,
                        long position,
                        RetryPolicy retryPolicy,
                        long multiRangeChunkSize)

Constructor for an input stream to an object in a Swift API based store.

Parameters:

account - JOSS account with authentication credentials

container - the name of container where the object resides

object - path of the object in the container

position - the position to begin reading from

retryPolicy - retry policy in case the object does not exist

multiRangeChunkSize - the chunk size to use on this stream

Method Detail

createStream

protected InputStream createStream(long startPos,
                                   long endPos)
                            throws IOException

Description copied from class: MultiRangeObjectInputStream

Opens a new stream reading a range. When endPos > content length, the returned stream should read till the last valid byte of the input. The behaviour is undefined when (startPos < 0), (startPos >= content length), or (endPos <= 0).

Specified by:

createStream in class MultiRangeObjectInputStream

Parameters:

startPos - start position in bytes (inclusive)

endPos - end position in bytes (exclusive)

Returns:

a new InputStream

Throws:

IOException