Package com.exasol.bucketfs

Class ReadEnabledBucket

java.lang.Object

com.exasol.bucketfs.ReadEnabledBucket

All Implemented Interfaces:

ReadOnlyBucket

Direct Known Subclasses:

WriteEnabledBucket

public class ReadEnabledBucket
extends Object
implements ReadOnlyBucket

Bucket that support read access like listing contents and downloading files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReadEnabledBucket.Builder<T extends ReadEnabledBucket.Builder<T>>	Builder for ReadEnabledBucket objects.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	bucketName	bucket name
protected String	host	Host or IP address
protected int	port	port
protected String	readPassword	read password
protected String	serviceName	bucketFs name
protected Map<String,Instant>	uploadHistory	upload history

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ReadEnabledBucket(ReadEnabledBucket.Builder<? extends ReadEnabledBucket.Builder<?>> builder)	Create a new instance of a bucket that support reading.

Method Summary

Modifier and Type	Method	Description
static ReadEnabledBucket.Builder<? extends ReadEnabledBucket.Builder<?>>	builder()	Returns a builder.
void	downloadFile(String pathInBucket, Path localPath)	Download a file from a bucket to a local filesystem.
String	downloadFileAsString(String pathInBucket)	Download a file from a bucket into a string.
protected String	extendPathInBucketDownToFilename(Path localPath, String pathInBucket)	Extends path in bucket down to filename.
String	getBucketFsName()
String	getBucketName()
protected HttpClient	getClient()	Get the http client.
String	getFullyQualifiedBucketName()	Get the fully qualified name of the bucket.
String	getReadPassword()	Get the read password for the bucket.
List<String>	listContents()	List the contents of a bucket.
List<String>	listContents(String path)	List the contents of a path inside a bucket.
List<String>	listContentsRecursively()	Recursively list the contents of a bucket.
List<String>	listContentsRecursively(String path)	Recursively list the contents of a path inside a bucket.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serviceName

protected final String serviceName

bucketFs name

bucketName

protected final String bucketName

bucket name

host

protected final String host

Host or IP address

port

protected final int port

port

readPassword

protected final String readPassword

read password

uploadHistory

protected final Map<String,Instant> uploadHistory

upload history

Constructor Detail

ReadEnabledBucket

protected ReadEnabledBucket(ReadEnabledBucket.Builder<? extends ReadEnabledBucket.Builder<?>> builder)

Create a new instance of a bucket that support reading.

Parameters:

builder - builder from which the bucket should be constructed

Method Detail

getBucketFsName

public String getBucketFsName()

Specified by:

getBucketFsName in interface ReadOnlyBucket

Returns:

name of the BucketFS filesystem this bucket belongs to

getBucketName

public String getBucketName()

Specified by:

getBucketName in interface ReadOnlyBucket

Returns:

name of the bucket

getFullyQualifiedBucketName

public String getFullyQualifiedBucketName()

Description copied from interface: ReadOnlyBucket

Get the fully qualified name of the bucket.

Specified by:

getFullyQualifiedBucketName in interface ReadOnlyBucket

Returns:

fully qualified name consisting of service name and bucket name

getReadPassword

public String getReadPassword()

Description copied from interface: ReadOnlyBucket

Get the read password for the bucket.

Specified by:

getReadPassword in interface ReadOnlyBucket

Returns:

read password

listContents

public List<String> listContents()
                          throws BucketAccessException

Description copied from interface: ReadOnlyBucket

List the contents of a bucket.

Specified by:

listContents in interface ReadOnlyBucket

Returns:

bucket contents

Throws:

BucketAccessException - if the contents are not accessible or the path is invalid

listContentsRecursively

public List<String> listContentsRecursively()
                                     throws BucketAccessException

Description copied from interface: ReadOnlyBucket

Recursively list the contents of a bucket.

Specified by:

listContentsRecursively in interface ReadOnlyBucket

Returns:

bucket contents

Throws:

BucketAccessException - if the contents are not accessible or the path is invalid

listContents

public List<String> listContents(String path)
                          throws BucketAccessException

Description copied from interface: ReadOnlyBucket

List the contents of a path inside a bucket.

Specified by:

listContents in interface ReadOnlyBucket

Parameters:

path - relative path from the bucket root

Returns:

list of file system entries

Throws:

BucketAccessException - if the contents are not accessible or the path is invalid

listContentsRecursively

public List<String> listContentsRecursively(String path)
                                     throws BucketAccessException

Description copied from interface: ReadOnlyBucket

Recursively list the contents of a path inside a bucket.

Specified by:

listContentsRecursively in interface ReadOnlyBucket

Parameters:

path - relative path from the bucket root

Returns:

list of file system entries

Throws:

BucketAccessException - if the contents are not accessible or the path is invalid

extendPathInBucketDownToFilename

protected String extendPathInBucketDownToFilename(Path localPath,
                                                  String pathInBucket)

Extends path in bucket down to filename.

Parameters:

localPath - localPath

pathInBucket - pathInBucket

Returns:

String

downloadFile

public void downloadFile(String pathInBucket,
                         Path localPath)
                  throws BucketAccessException

Description copied from interface: ReadOnlyBucket

Download a file from a bucket to a local filesystem.

Specified by:

downloadFile in interface ReadOnlyBucket

Parameters:

pathInBucket - path of the file in BucketFS

localPath - local path the file is downloaded to

Throws:

BucketAccessException - if the local file does not exist or is not accessible or if the download failed

downloadFileAsString

public String downloadFileAsString(String pathInBucket)
                            throws BucketAccessException

Description copied from interface: ReadOnlyBucket

Download a file from a bucket into a string.

Specified by:

downloadFileAsString in interface ReadOnlyBucket

Parameters:

pathInBucket - path of the file in BucketFS

Returns:

file contents as string

Throws:

BucketAccessException - if the local file does not exist or is not accessible or if the download failed

getClient

protected HttpClient getClient()

Get the http client.

Returns:

http client

toString

public String toString()

Overrides:

toString in class Object

builder

public static ReadEnabledBucket.Builder<? extends ReadEnabledBucket.Builder<?>> builder()

Returns a builder.

Returns:

builder