Package com.exasol.bucketfs

Class WriteEnabledBucket

java.lang.Object

com.exasol.bucketfs.ReadEnabledBucket

com.exasol.bucketfs.WriteEnabledBucket

All Implemented Interfaces:

ReadOnlyBucket, UnsynchronizedBucket

Direct Known Subclasses:

SyncAwareBucket

public class WriteEnabledBucket
extends ReadEnabledBucket
implements UnsynchronizedBucket

An abstraction for a bucket inside Exasol's BucketFS.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.exasol.bucketfs.ReadEnabledBucket

bucketName, host, port, readPassword, serviceName, uploadHistory

Fields inherited from interface com.exasol.bucketfs.UnsynchronizedBucket

SUPPORTED_ARCHIVE_EXTENSIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteEnabledBucket(WriteEnabledBucket.Builder<? extends WriteEnabledBucket.Builder<?>> builder)

Method Summary

Modifier and Type	Method	Description
static WriteEnabledBucket.Builder<? extends WriteEnabledBucket.Builder<?>>	builder()	Create builder for a WriteEnabledBucket.
protected BucketAccessException	createUploadInterruptedException(URI uri)	Create UploadInterruptedException.
protected BucketAccessException	createUploadIoException(URI uri, IOException exception)	Create UploadIoException.
void	deleteFileNonBlocking(String filenameInBucket)	Delete a file from BucketFS.
String	getWritePassword()	Get the write password for the bucket.
protected void	recordUploadInHistory(String pathInBucket)	Record the upload in the internal upload history of this bucket object.
void	setUploadNecessityCheckStrategy(UploadNecessityCheckStrategy uploadNecessityCheckStrategy)	Set an UploadNecessityCheckStrategy.
UploadResult	uploadFileNonBlocking(Path localPath, String pathInBucket)	Upload a file to the bucket.
void	uploadInputStreamNonBlocking(Supplier<InputStream> inputStreamSupplier, String pathInBucket)	Upload the contents of an input stream to the bucket non-blocking.
void	uploadStringContentNonBlocking(String content, String pathInBucket)	Upload the contents of a string to the bucket.
protected void	uploadWithBodyPublisher(URI uri, HttpRequest.BodyPublisher publisher, String what)	Upload with body publisher.

Methods inherited from class com.exasol.bucketfs.ReadEnabledBucket

downloadFile, downloadFileAsString, extendPathInBucketDownToFilename, getBucketFsName, getBucketName, getClient, getFullyQualifiedBucketName, getReadPassword, listContents, listContents, listContentsRecursively, listContentsRecursively, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exasol.bucketfs.ReadOnlyBucket

downloadFile, downloadFileAsString, getBucketFsName, getBucketName, getFullyQualifiedBucketName, getReadPassword, listContents, listContents, listContentsRecursively, listContentsRecursively

Constructor Detail

WriteEnabledBucket

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

Parameters:

builder - builder

Method Detail

getWritePassword

public String getWritePassword()

Description copied from interface: UnsynchronizedBucket

Get the write password for the bucket.

Specified by:

getWritePassword in interface UnsynchronizedBucket

Returns:

write password.

uploadFileNonBlocking

public UploadResult uploadFileNonBlocking(Path localPath,
                                          String pathInBucket)
                                   throws BucketAccessException,
                                          FileNotFoundException

Description copied from interface: UnsynchronizedBucket

Upload a file to the bucket.

Upload a file from a given local path to a URI pointing to a BucketFS bucket. If the bucket URI ends in a slash, that URI is interpreted as a directory inside the bucket and the original filename is appended.

This call immediately returns without checking whether or not the file is actually synchronized in the in BucketFS.

Specified by:

uploadFileNonBlocking in interface UnsynchronizedBucket

Parameters:

localPath - path of the file to be uploaded

pathInBucket - path inside the bucket

Returns:

UploadResult describing the status of the upload

Throws:

BucketAccessException - if the file cannot be uploaded to the given URI

FileNotFoundException - in case the source file is not found

uploadWithBodyPublisher

protected void uploadWithBodyPublisher(URI uri,
                                       HttpRequest.BodyPublisher publisher,
                                       String what)
                                throws BucketAccessException

Upload with body publisher.

Parameters:

uri - uri

publisher - publisher

what - what

Throws:

BucketAccessException - BucketAccessException

createUploadIoException

protected BucketAccessException createUploadIoException(URI uri,
                                                        IOException exception)

Create UploadIoException.

Parameters:

uri - uri

exception - exception

Returns:

BucketAccessException

createUploadInterruptedException

protected BucketAccessException createUploadInterruptedException(URI uri)

Create UploadInterruptedException.

Parameters:

uri - uri

Returns:

BucketAccessException

recordUploadInHistory

protected void recordUploadInHistory(String pathInBucket)

Record the upload in the internal upload history of this bucket object.

This is mainly necessary to work around issues with detecting repeated uploads. Under certain circumstances they need to be delayed and the upload history helps with that.

Parameters:

pathInBucket - path in the bucket to which an upload happened.

uploadStringContentNonBlocking

public void uploadStringContentNonBlocking(String content,
                                           String pathInBucket)
                                    throws BucketAccessException,
                                           TimeoutException

Description copied from interface: UnsynchronizedBucket

Upload the contents of a string to the bucket.

This method is intended for writing small objects in BucketFS dynamically like for example configuration files. For large payload use UnsynchronizedBucket.uploadFileNonBlocking(Path, String) instead.

This call immediately returns without checking whether or not the file is actually synchronized in the in BucketFS.

Specified by:

uploadStringContentNonBlocking in interface UnsynchronizedBucket

Parameters:

content - string to write

pathInBucket - path inside the bucket

Throws:

BucketAccessException - if the file cannot be uploaded to the given URI

TimeoutException - if synchronization takes too long

uploadInputStreamNonBlocking

public void uploadInputStreamNonBlocking(Supplier<InputStream> inputStreamSupplier,
                                         String pathInBucket)
                                  throws BucketAccessException,
                                         TimeoutException

Description copied from interface: UnsynchronizedBucket

Upload the contents of an input stream to the bucket non-blocking.

Specified by:

uploadInputStreamNonBlocking in interface UnsynchronizedBucket

Parameters:

inputStreamSupplier - supplier that provides the input stream

pathInBucket - path inside the bucket

Throws:

BucketAccessException - if the file cannot be uploaded to the given URI

TimeoutException - if synchronization takes too long

builder

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

Create builder for a WriteEnabledBucket.

Returns:

builder

deleteFileNonBlocking

public void deleteFileNonBlocking(String filenameInBucket)
                           throws BucketAccessException

Description copied from interface: UnsynchronizedBucket

Delete a file from BucketFS.

Warning: If you try to upload a file shortly (less than about 30s) after you deleted it, the upload will fail with access denied.

Specified by:

deleteFileNonBlocking in interface UnsynchronizedBucket

Parameters:

filenameInBucket - file path

Throws:

BucketAccessException - if delete failed

setUploadNecessityCheckStrategy

public void setUploadNecessityCheckStrategy(UploadNecessityCheckStrategy uploadNecessityCheckStrategy)

Description copied from interface: UnsynchronizedBucket

Set an UploadNecessityCheckStrategy.

This class uses the strategy during file upload to decide if the file should really be uploaded.

Specified by:

setUploadNecessityCheckStrategy in interface UnsynchronizedBucket

Parameters:

uploadNecessityCheckStrategy - strategy to use from now on