Interface ObjectStoreClient

All Known Implementing Classes:

ObjectStoreClientImpl

public interface ObjectStoreClient

Method Summary

Modifier and Type	Method	Description
void	abortAllTransfers()
DownloadBatchBuilder	buildDownloadBatch()
UploadBatchBuilder	buildUploadBatch()
boolean	checkObjectExists(String namespace, String objectName)
void	clearInactiveSessions()
DownloadSession	createDownloadSession(String namespace, String objectName, Path destinationFolderPath)
DownloadSession	createDownloadSession(String namespace, String objectName, Path destinationFolderPath, TransferProperties properties)
UploadSession	createUploadSession(String namespace, Path sourceFilePath)
UploadSession	createUploadSession(String namespace, Path sourceFilePath, TransferProperties properties)
UploadSession	createUploadSession(String namespace, Path sourceFilePath, String objectName)
UploadSession	createUploadSession(String namespace, Path sourceFilePath, String objectName, TransferProperties properties)
void	deleteNamespaceStorageConfiguration(String namespace)
void	deleteObjects(String namespace, ObjectPath... objectPaths)
void	deleteObjects(String namespace, Iterable<ObjectPath> objectPaths)
List<? extends TransferSession>	getActiveSessions()
List<? extends TransferSession>	getAllSessions()
int	getDownloadMaxBytesPerSecond()
List<ObjectPath>	getNamespaceObjectPaths(ObjectPathsRequest request)	Return all object paths that match the request.
Slice<ObjectPath>	getNamespaceObjectPaths(ObjectPathsSliceRequest request)
List<String>	getNamespaces()
List<NamespaceStorageConfiguration>	getNamespaceStorageConfigurations()
ObjectDetail	getObjectDetail(String namespace, String objectName)
int	getUploadMaxBytesPerSecond()
boolean	isDownloadsActive()
boolean	isUploadsActive()
NamespaceStorageConfiguration	putNamespaceStorageConfiguration(NamespaceStorageConfiguration namespaceStorageConfiguration)
void	setDownloadMaxBytesPerSecond(int downloadMaxBytesPerSecond)
void	setUploadMaxBytesPerSecond(int uploadMaxBytesPerSecond)
void	startTransfers()
void	stopTransfers()
Stream<ObjectPath>	streamNamespaceObjectPaths(ObjectPathsRequest request)

Method Details

getActiveSessions

List<? extends TransferSession> getActiveSessions()

getAllSessions

List<? extends TransferSession> getAllSessions()

isUploadsActive

boolean isUploadsActive()

isDownloadsActive

boolean isDownloadsActive()

getUploadMaxBytesPerSecond

int getUploadMaxBytesPerSecond()

setUploadMaxBytesPerSecond

void setUploadMaxBytesPerSecond(int uploadMaxBytesPerSecond)

getDownloadMaxBytesPerSecond

int getDownloadMaxBytesPerSecond()

setDownloadMaxBytesPerSecond

void setDownloadMaxBytesPerSecond(int downloadMaxBytesPerSecond)

createUploadSession

UploadSession createUploadSession(String namespace,
 Path sourceFilePath)
                           throws IOException

Throws:

IOException

createUploadSession

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

Throws:

IOException

createUploadSession

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

Throws:

IOException

createUploadSession

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

Throws:

IOException

createDownloadSession

DownloadSession createDownloadSession(String namespace,
 String objectName,
 Path destinationFolderPath)

createDownloadSession

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

startTransfers

void startTransfers()

stopTransfers

void stopTransfers()

clearInactiveSessions

void clearInactiveSessions()

abortAllTransfers

void abortAllTransfers()

getObjectDetail

ObjectDetail getObjectDetail(String namespace,
 String objectName)

checkObjectExists

boolean checkObjectExists(String namespace,
 String objectName)

getNamespaces

List<String> getNamespaces()

getNamespaceObjectPaths

List<ObjectPath> getNamespaceObjectPaths(ObjectPathsRequest request)

Return all object paths that match the request.

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

Parameters:

request - the request

Returns:

the object paths

streamNamespaceObjectPaths

Stream<ObjectPath> streamNamespaceObjectPaths(ObjectPathsRequest request)

getNamespaceObjectPaths

Slice<ObjectPath> getNamespaceObjectPaths(ObjectPathsSliceRequest request)

deleteObjects

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

deleteObjects

void deleteObjects(String namespace,
 ObjectPath... objectPaths)

putNamespaceStorageConfiguration

NamespaceStorageConfiguration putNamespaceStorageConfiguration(NamespaceStorageConfiguration namespaceStorageConfiguration)

deleteNamespaceStorageConfiguration

void deleteNamespaceStorageConfiguration(String namespace)

getNamespaceStorageConfigurations

List<NamespaceStorageConfiguration> getNamespaceStorageConfigurations()

buildUploadBatch

UploadBatchBuilder buildUploadBatch()

buildDownloadBatch

DownloadBatchBuilder buildDownloadBatch()