StorageProvider

Method Summary
	deleteObject(String key) Deletes objects from cloud storage
	deleteObjects(DataList keysVersions) Deletes list of objects from cloud storage
StoredObject	downloadObject(String key) Downloads object from cloud storage. Returns null if the object does not exist.
Data	getAuthData(Data data) Returns information that can be used in a web pal for posting a file directly to a bucket. Currently works only with AWS S3.
String	getAuthUrl(String filename, int expires) Returns an authenticated URL and querystring for the specified file. This works only with storage type of AWS S3. It allows access to an object via a URL for the specified amount of time.
String	getBucket() Returns the bucket or container name of this provider.
String	getCDNEndpoint(boolean secure) Returns CDN endpoint, if any.
String	getEncryptionType() Returns the encryptionType of this provider.
Inspector	getInspector(String fileKey) Returns an Inspector for analyzing the stored object identified by fileKey. Currently works only on AWS S3.
String	getName() Returns name of this provider
String	getRegion() Returns region of this provider if applicable.
String	getType() Returns type of this provider
DataList	listFolders(String prefix, String delimiter, int size) Returns a list of folders within this container
StorageProviderDataList	listObjects(String prefix, String delimiter, String marker, int size) Lists objects available in cloud storage. Pagination applies if you use a marker. Marker can be obtained from StorageProviderDataList.getMarker() after an initial empty call. Start position is 1-based. Max list size is 500
Data	uploadObject(boolean encrypt, String key, File file) Uploads file into cloud storage
Data	uploadPublic(String key, File file) Uploads file into cloud storage and gives it public access. Currently works with AWS-S3 and provides a public-read ACL to the object. You should only use this method for files intended to be accessible over the public Internet.

Method Detail

deleteObject(String key)

Deletes objects from cloud storage

Parameters:

String key - storage key of the object. Required parameter.

Since: 02-13-2012

top

deleteObjects(DataList keysVersions)

Deletes list of objects from cloud storage

Parameters:

DataList keysVersions - list of keys and optionally versions. Columns: key,version. Version column is optional. Required parameter.

Since: 02-13-2012

top

StoredObject downloadObject(String key)

Downloads object from cloud storage. Returns null if the object does not exist.

Parameters:

String key - storage key of the object. Required parameter.

Returns: StoredObject

Since: 02-13-2012

top

Data getAuthData(Data data)

Returns information that can be used in a web pal for posting a file directly to a bucket. Currently works only with AWS S3.

Parameters:

Data data Required parameter.

Returns: Data

Since: 11-26-2020

top

String getAuthUrl(String filename, int expires)

Returns an authenticated URL and querystring for the specified file. This works only with storage type of AWS S3. It allows access to an object via a URL for the specified amount of time.

Parameters:

String filename - The name of the remote file. Required parameter.
int expires - How long in seconds before the link expires. Maximum allowed size of parameter: 604800

Returns: String

Since: 01-14-2020

top

String getBucket()

Returns the bucket or container name of this provider.

Returns: String

Since: 01-14-2020

top

String getCDNEndpoint(boolean secure)

Returns CDN endpoint, if any.

Parameters:

boolean secure

Returns: String

Since: 01-07-2021

top

String getEncryptionType()

Returns the encryptionType of this provider.

Returns: String

Since: 08-07-2024

top

Inspector getInspector(String fileKey)

Returns an Inspector for analyzing the stored object identified by fileKey. Currently works only on AWS S3.

Parameters:

String fileKey Required parameter.

Returns: Inspector

Since: 10-12-2022

top

String getName()

Returns name of this provider

Returns: String

Since: 02-13-2012

top

String getRegion()

Returns region of this provider if applicable.

Returns: String

Since: 01-14-2020

top

String getType()

Returns type of this provider

Returns: String

Since: 02-13-2012

top

DataList listFolders(String prefix, String delimiter, int size)

Returns a list of folders within this container

Parameters:

String prefix - optional key prefix to narrow results.
String delimiter - optional key delimiter to narrow results and navigate hierarchically, default '/'.
int size - page size. Maximum allowed size of parameter: 1000

Returns: DataList

DataList Name: folders
DataList Fields: folder

Since: 03-30-2023

top

StorageProviderDataList listObjects(String prefix, String delimiter, String marker, int size)

Lists objects available in cloud storage. Pagination applies if you use a marker. Marker can be obtained from StorageProviderDataList.getMarker() after an initial empty call. Start position is 1-based. Max list size is 500

Parameters:

String prefix - optional key prefix to narrow results.
String delimiter - optional key delimiter to narrow results and navigate hierarchically.
String marker - marker obtained from the first request or subsequent requests.
int size - page size. Maximum allowed size of parameter: 500

Returns: StorageProviderDataList

DataList Name: objects
DataList Fields: key, length, objectId, tag, lastModified

Since: 09-19-2016

top

Data uploadObject(boolean encrypt, String key, File file)

Uploads file into cloud storage

Parameters:

boolean encrypt - encrypt using provider password. Required parameter.
String key - storage key of the object. Required parameter.
File file - file with content to upload. Required parameter.

Returns: Data

Since: 09-19-2016

top

Data uploadPublic(String key, File file)

Uploads file into cloud storage and gives it public access. Currently works with AWS-S3 and provides a public-read ACL to the object. You should only use this method for files intended to be accessible over the public Internet.

Parameters:

String key - storage key of the object. Required parameter.
File file - file with content to upload. Required parameter.

Returns: Data

Since: 10-26-2022

top

API Date: Dec 03, 2024 10:24 AM