Package com.totvs.tjf.storage

Interface StorageService

public interface StorageService

Implementations of this interface provides supports to a cloud storage service

Method Summary

Modifier and Type	Method	Description
void	createBucket(String bucketName, Property... properties)	Creates a Bucket
String	createDeleteSignedUrl(String bucketName, String blobName, String expiresIn, Property... properties)	Creates a delete signed url
String	createDownloadSignedUrl(String bucketName, String blobName, String expiresIn, Property... properties)	Creates a download signed url
String	createUploadSignedUrl(String bucketName, String blobName, String type, String expiresIn, Property... properties)	Creates a upload signed url
void	deleteBucket(String bucketName, Property... properties)	Deletes a Bucket
void	deleteObject(String bucketName, String name, Property... properties)	Deletes an object
boolean	hasBucket(String bucketName, Property... properties)	Checks if the Bucket exists
String[]	listObjects(String bucketName, String startsWith, Property... properties)	List object's names based on an optional prefix string
byte[]	loadObject(String bucketName, String blobname, Property... properties)	Loads the object's content
List<com.google.cloud.storage.Blob>	loadObjectsByIds(String bucketName, List<String> blobIds, Property... properties)	Loads the content of all ids informed
List<com.google.cloud.storage.Blob>	loadObjectsByIds(List<com.google.cloud.storage.BlobId> blobIds, Property... properties)	Loads the content of all ids informed
void	saveObject(String bucketName, String name, String type, byte[] content, Property... properties)	Saves an object

Method Detail

createBucket

void createBucket(String bucketName,
                  Property... properties)
           throws IOException

Creates a Bucket

Parameters:

bucketName - the bucket's name

properties - specific connection properties

Throws:

IOException - an IO exception of this operation

hasBucket

boolean hasBucket(String bucketName,
                  Property... properties)
           throws IOException

Checks if the Bucket exists

Parameters:

bucketName - the bucket's name

properties - specific connection properties

Returns:

boolean true if buckets exists or false if not

Throws:

IOException - an IO exception of this operation

deleteBucket

void deleteBucket(String bucketName,
                  Property... properties)
           throws IOException,
                  ObjectNotFoundException

Deletes a Bucket

Parameters:

bucketName - the bucket's name

properties - specific connection properties

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

saveObject

void saveObject(String bucketName,
                String name,
                String type,
                byte[] content,
                Property... properties)
         throws IOException,
                ObjectNotFoundException

Saves an object

Parameters:

bucketName - the bucket's name

name - the object's name

type - the object's mime type

content - the object's content

properties - specific connection properties

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

loadObject

byte[] loadObject(String bucketName,
                  String blobname,
                  Property... properties)
           throws IOException,
                  ObjectNotFoundException

Loads the object's content

Parameters:

bucketName - the bucket's name

blobname - the object's name

properties - specific connection properties

Returns:

byte[] the object's content

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

loadObjectsByIds

List<com.google.cloud.storage.Blob> loadObjectsByIds(String bucketName,
                                                     List<String> blobIds,
                                                     Property... properties)
                                              throws IOException

Loads the content of all ids informed

Parameters:

bucketName - the bucket's name

blobIds - list[string] of the object's ids

properties - specific connection properties

Returns:

multitype:Blob a list of all the objects content

Throws:

IOException - an IO exception of this operation

loadObjectsByIds

List<com.google.cloud.storage.Blob> loadObjectsByIds(List<com.google.cloud.storage.BlobId> blobIds,
                                                     Property... properties)
                                              throws IOException

Loads the content of all ids informed

Parameters:

blobIds - list[BlobId] of the object's ids

properties - specific connection properties

Returns:

multitype:Blob a list of all the objects content

Throws:

IOException - an IO exception of this operation

deleteObject

void deleteObject(String bucketName,
                  String name,
                  Property... properties)
           throws IOException,
                  ObjectNotFoundException

Deletes an object

Parameters:

bucketName - the bucket's name

name - the object's name

properties - specific connection properties

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

listObjects

String[] listObjects(String bucketName,
                     String startsWith,
                     Property... properties)
              throws IOException,
                     ObjectNotFoundException

List object's names based on an optional prefix string

Parameters:

bucketName - the bucket's name

startsWith - a prefix string

properties - specific connection properties

Returns:

string[] a list of object's names

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

createDownloadSignedUrl

String createDownloadSignedUrl(String bucketName,
                               String blobName,
                               String expiresIn,
                               Property... properties)
                        throws IOException,
                               ObjectNotFoundException

Creates a download signed url

Parameters:

bucketName - the bucket's name

blobName - the object's name

expiresIn - the url expiration

properties - specific connection properties

Returns:

the signed url

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

createDeleteSignedUrl

String createDeleteSignedUrl(String bucketName,
                             String blobName,
                             String expiresIn,
                             Property... properties)
                      throws IOException,
                             ObjectNotFoundException

Creates a delete signed url

Parameters:

bucketName - the bucket's name

blobName - the object's name

expiresIn - the url expiration

properties - specific connection properties

Returns:

string the signed url

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception

createUploadSignedUrl

String createUploadSignedUrl(String bucketName,
                             String blobName,
                             String type,
                             String expiresIn,
                             Property... properties)
                      throws IOException,
                             ObjectNotFoundException

Creates a upload signed url

Parameters:

bucketName - the bucket's name

blobName - the object's name

type - the object's mimetype

properties - specific connection properties

expiresIn - the url expiration

Returns:

string the signed url

Throws:

IOException - an IO exception of this operation

ObjectNotFoundException - an object not found exception