Class ObjectStoreClientImpl

java.lang.Object

co.yellowdog.platform.clients.objectstore.ObjectStoreClientImpl

All Implemented Interfaces:

ObjectStoreClient

public class ObjectStoreClientImpl
extends Object
implements ObjectStoreClient

Method Summary

Modifier and Type	Method	Description
void	abortAllTransfers()
DownloadBatchBuilder	buildDownloadBatch()
UploadBatchBuilder	buildUploadBatch()
boolean	checkObjectExists(@NonNull String namespace, @NonNull String objectName)
void	clearInactiveSessions()
static ObjectStoreClientImpl	create(@NonNull ServicesSchema servicesSchema, @NonNull RetryFactory retryFactory, @NonNull AuthenticationHeadersProvider authenticationHeadersProvider, @NonNull ObjectStoreClientConfigurationProperties configurationProperties, @NonNull SessionRequestIdGenerator sessionRequestIdGenerator, @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper, @NonNull UserAgent userAgent)
static ObjectStoreClientImpl	create(@NonNull ServicesSchema servicesSchema, @NonNull RetryFactory retryFactory, @NonNull AuthenticationHeadersProvider authenticationHeadersProvider, @NonNull ObjectStoreClientConfigurationProperties configurationProperties, @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper, @NonNull UserAgent userAgent)	Factory method for constructing an ObjectStoreClientImpl.
DownloadSession	createDownloadSession(@NonNull String namespace, @NonNull String objectName, @NonNull Path destinationFolderPath)
DownloadSession	createDownloadSession(@NonNull String namespace, @NonNull String objectName, @NonNull Path destinationFolderPath, @NonNull TransferProperties properties)
UploadSession	createUploadSession(@NonNull String namespace, @NonNull Path sourceFilePath)
UploadSession	createUploadSession(@NonNull String namespace, @NonNull Path sourceFilePath, @NonNull TransferProperties properties)
UploadSession	createUploadSession(@NonNull String namespace, @NonNull Path sourceFilePath, @NonNull String objectName)
UploadSession	createUploadSession(@NonNull String namespace, @NonNull Path sourceFilePath, @NonNull String objectName, @NonNull TransferProperties properties)
void	deleteNamespaceStorageConfiguration(@NonNull String namespace)
void	deleteObjects(@NonNull String namespace, ObjectPath... objectPaths)
void	deleteObjects(@NonNull String namespace, @NonNull Iterable<ObjectPath> objectPaths)
List<? extends TransferSession>	getActiveSessions()
List<? extends TransferSession>	getAllSessions()
int	getDownloadMaxBytesPerSecond()
List<ObjectPath>	getNamespaceObjectPaths(@NonNull ObjectPathsRequest request)	Return all object paths that match the request.
Slice<ObjectPath>	getNamespaceObjectPaths(@NonNull ObjectPathsSliceRequest request)
List<String>	getNamespaces()
List<NamespaceStorageConfiguration>	getNamespaceStorageConfigurations()
ObjectDetail	getObjectDetail(@NonNull String namespace, @NonNull String objectName)
int	getUploadMaxBytesPerSecond()
boolean	isDownloadsActive()
boolean	isUploadsActive()
NamespaceStorageConfiguration	putNamespaceStorageConfiguration(@NonNull NamespaceStorageConfiguration namespaceStorageConfiguration)
void	setDownloadMaxBytesPerSecond(int maxBytesPerSecond)
void	setUploadMaxBytesPerSecond(int maxBytesPerSecond)
void	startTransfers()
void	stopTransfers()
Stream<ObjectPath>	streamNamespaceObjectPaths(@NonNull ObjectPathsRequest request)

Methods inherited from class java.lang.Object

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

Method Details

create

public static ObjectStoreClientImpl create(@NonNull
 @NonNull ServicesSchema servicesSchema,
 @NonNull
 @NonNull RetryFactory retryFactory,
 @NonNull
 @NonNull AuthenticationHeadersProvider authenticationHeadersProvider,
 @NonNull
 @NonNull ObjectStoreClientConfigurationProperties configurationProperties,
 @NonNull
 @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 @NonNull
 @NonNull UserAgent userAgent)

Factory method for constructing an ObjectStoreClientImpl.

Parameters:

servicesSchema - The services schema to use for service URL endpoint addresses

retryFactory - The retry template factory to use

authenticationHeadersProvider - The authentication headers provider to use

objectMapper -

Returns:

a new instance of ObjectStoreClientImpl

create

public static ObjectStoreClientImpl create(@NonNull
 @NonNull ServicesSchema servicesSchema,
 @NonNull
 @NonNull RetryFactory retryFactory,
 @NonNull
 @NonNull AuthenticationHeadersProvider authenticationHeadersProvider,
 @NonNull
 @NonNull ObjectStoreClientConfigurationProperties configurationProperties,
 @NonNull
 @NonNull SessionRequestIdGenerator sessionRequestIdGenerator,
 @NonNull
 @NonNull com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 @NonNull
 @NonNull UserAgent userAgent)

getActiveSessions

public List<? extends TransferSession> getActiveSessions()

Specified by:

getActiveSessions in interface ObjectStoreClient

getAllSessions

public List<? extends TransferSession> getAllSessions()

Specified by:

getAllSessions in interface ObjectStoreClient

isUploadsActive

public boolean isUploadsActive()

Specified by:

isUploadsActive in interface ObjectStoreClient

isDownloadsActive

public boolean isDownloadsActive()

Specified by:

isDownloadsActive in interface ObjectStoreClient

getUploadMaxBytesPerSecond

public int getUploadMaxBytesPerSecond()

Specified by:

getUploadMaxBytesPerSecond in interface ObjectStoreClient

setUploadMaxBytesPerSecond

public void setUploadMaxBytesPerSecond(int maxBytesPerSecond)

Specified by:

setUploadMaxBytesPerSecond in interface ObjectStoreClient

getDownloadMaxBytesPerSecond

public int getDownloadMaxBytesPerSecond()

Specified by:

getDownloadMaxBytesPerSecond in interface ObjectStoreClient

setDownloadMaxBytesPerSecond

public void setDownloadMaxBytesPerSecond(int maxBytesPerSecond)

Specified by:

setDownloadMaxBytesPerSecond in interface ObjectStoreClient

createUploadSession

public UploadSession createUploadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull Path sourceFilePath)
                                  throws IOException

Specified by:

createUploadSession in interface ObjectStoreClient

Throws:

IOException

createUploadSession

public UploadSession createUploadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull Path sourceFilePath,
 @NonNull
 @NonNull TransferProperties properties)
                                  throws IOException

Specified by:

createUploadSession in interface ObjectStoreClient

Throws:

IOException

createUploadSession

public UploadSession createUploadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull Path sourceFilePath,
 @NonNull
 @NonNull String objectName)
                                  throws IOException

Specified by:

createUploadSession in interface ObjectStoreClient

Throws:

IOException

createUploadSession

public UploadSession createUploadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull Path sourceFilePath,
 @NonNull
 @NonNull String objectName,
 @NonNull
 @NonNull TransferProperties properties)
                                  throws IOException

Specified by:

createUploadSession in interface ObjectStoreClient

Throws:

IOException

createDownloadSession

public DownloadSession createDownloadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull String objectName,
 @NonNull
 @NonNull Path destinationFolderPath)

Specified by:

createDownloadSession in interface ObjectStoreClient

createDownloadSession

public DownloadSession createDownloadSession(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull String objectName,
 @NonNull
 @NonNull Path destinationFolderPath,
 @NonNull
 @NonNull TransferProperties properties)

Specified by:

createDownloadSession in interface ObjectStoreClient

startTransfers

public void startTransfers()

Specified by:

startTransfers in interface ObjectStoreClient

stopTransfers

public void stopTransfers()

Specified by:

stopTransfers in interface ObjectStoreClient

clearInactiveSessions

public void clearInactiveSessions()

Specified by:

clearInactiveSessions in interface ObjectStoreClient

abortAllTransfers

public void abortAllTransfers()

Specified by:

abortAllTransfers in interface ObjectStoreClient

getObjectDetail

public ObjectDetail getObjectDetail(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull String objectName)

Specified by:

getObjectDetail in interface ObjectStoreClient

checkObjectExists

public boolean checkObjectExists(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull String objectName)

Specified by:

checkObjectExists in interface ObjectStoreClient

getNamespaces

public List<String> getNamespaces()

Specified by:

getNamespaces in interface ObjectStoreClient

getNamespaceObjectPaths

public List<ObjectPath> getNamespaceObjectPaths(@NonNull
 @NonNull ObjectPathsRequest request)

Description copied from interface: ObjectStoreClient

Return all object paths that match the request.

For large numbers of objects, consider using either ObjectStoreClient.streamNamespaceObjectPaths(co.yellowdog.platform.interaction.objectstore.ObjectPathsRequest) or ObjectStoreClient.getNamespaceObjectPaths(ObjectPathsSliceRequest).

Specified by:

getNamespaceObjectPaths in interface ObjectStoreClient

Parameters:

request - the request

Returns:

the object paths

streamNamespaceObjectPaths

public Stream<ObjectPath> streamNamespaceObjectPaths(@NonNull
 @NonNull ObjectPathsRequest request)

Specified by:

streamNamespaceObjectPaths in interface ObjectStoreClient

getNamespaceObjectPaths

public Slice<ObjectPath> getNamespaceObjectPaths(@NonNull
 @NonNull ObjectPathsSliceRequest request)

Specified by:

getNamespaceObjectPaths in interface ObjectStoreClient

deleteObjects

public void deleteObjects(@NonNull
 @NonNull String namespace,
 @NonNull
 @NonNull Iterable<ObjectPath> objectPaths)

Specified by:

deleteObjects in interface ObjectStoreClient

deleteObjects

public void deleteObjects(@NonNull
 @NonNull String namespace,
 ObjectPath... objectPaths)

Specified by:

deleteObjects in interface ObjectStoreClient

putNamespaceStorageConfiguration

public NamespaceStorageConfiguration putNamespaceStorageConfiguration(@NonNull
 @NonNull NamespaceStorageConfiguration namespaceStorageConfiguration)

Specified by:

putNamespaceStorageConfiguration in interface ObjectStoreClient

deleteNamespaceStorageConfiguration

public void deleteNamespaceStorageConfiguration(@NonNull
 @NonNull String namespace)

Specified by:

deleteNamespaceStorageConfiguration in interface ObjectStoreClient

getNamespaceStorageConfigurations

public List<NamespaceStorageConfiguration> getNamespaceStorageConfigurations()

Specified by:

getNamespaceStorageConfigurations in interface ObjectStoreClient

buildUploadBatch

public UploadBatchBuilder buildUploadBatch()

Specified by:

buildUploadBatch in interface ObjectStoreClient

buildDownloadBatch

public DownloadBatchBuilder buildDownloadBatch()

Specified by:

buildDownloadBatch in interface ObjectStoreClient