IRISLIB database
Client Class Reference
Inheritance diagram for Client:
Collaboration diagram for Client:

Public Member Functions

_.Library.Boolean BlobExists (_.Library.String bucketName, _.Library.String blobName)
 Test if a blob exists.
 
_.Library.Boolean BucketExists (_.Library.String bucketName)
 Test if a bucket exists.
 
 Close ()
 Close storage client and disconnect Java gateway.
 
 CreateBucket (_.Library.String bucketName)
 Create a new bucket.
 
 DeleteBlob (_.Library.String bucketName, _.Library.String blobName)
 Delete a blob from the cloud.
 
 DeleteBucket (_.Library.String bucketName)
 Delete a bucket from the cloud.
 
 DownloadBlobToFile (_.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
 Download a blob from the cloud to a file.
 
_.Stream.Object DownloadBlobToStream (_.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding)
 Download a blob from the cloud to a stream. More...
 
_.Library.String DownloadBlobToString (_.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding)
 Download a blob from the cloud to a string. More...
 
_.Net.Cloud.Storage.BlobInfo GetBlobInfo (_.Library.String bucketName, _.Library.String blobName)
 Get blob info.
 
_.Net.Cloud.Storage.BucketInfo GetBucketInfo (_.Library.String bucketName)
 Get bucket info.
 
_.Library.Boolean IsBucketPublicAccessible (_.Library.String bucketName)
 Test if a bucket is public accessible.
 
_.Library.ListOfObjects ListBlobs (_.Library.String bucketName, _.Library.String blobNamePrefix, _.Library.String blobNamePattern)
 List all blobs within a bucket, filtered by blobNamePrefix and blobNamePattern. More...
 
_.Library.ListOfObjects ListBuckets ()
 List all buckets.
 
 UploadBlobFromFile (_.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
 Upload a file blob to the cloud.
 
 UploadBlobFromStream (_.Library.String bucketName, _.Library.String blobName, _.Stream.Object stream)
 Upload a binary or character stream blob to the cloud. More...
 
 UploadBlobFromString (_.Library.String bucketName, _.Library.String blobName, _.Library.String content)
 Upload a string blob to the cloud. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Static Public Member Functions

_.Net.Cloud.Storage.Client CreateClient (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.Status sc, _.Library.String endPoint)
 Factory method to create a cloud storage client. More...
 
_.Library.Status SingleDownloadBlobToFile (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
 Single method to download blob to file.
 
_.Library.Status SingleDownloadBlobToStream (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding, _.Stream.Object toStream)
 Single method to download blob to stream.
 
_.Library.Status SingleDownloadBlobToString (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String blobEncoding, _.Library.String toString)
 Single method to download blob to string.
 
_.Library.Status SingleUploadBlobFromFile (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String filePath)
 Single method to upload blob from file.
 
_.Library.Status SingleUploadBlobFromStream (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Stream.Object stream)
 Single method to upload blob from stream.
 
_.Library.Status SingleUploadBlobFromString (_.Library.RawString javaServer, _.Library.Integer storageProvider, _.Library.String credentialsFile, _.Library.String region, _.Library.String endPoint, _.Library.String bucketName, _.Library.String blobName, _.Library.String content)
 Single method to upload blob from string.
 

Public Attributes

 gateway
 Connection to a Java Gateway. More...
 
 jclient
 Remote Java client object to Azure, Google or S3. More...
 

Static Private Member Functions

_.External.JavaGateway __CreateGateway (_.Library.RawString javaServer)
 Create a Java gateway connection.
 
_.Stream.TmpBinary __ToUTF8 (_.Stream.Object stream)
 Convert a stream to binary stream encoded in UTF-8.
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Function Documentation

◆ CreateClient()

_.Net.Cloud.Storage.Client CreateClient ( _.Library.RawString  javaServer,
_.Library.Integer  storageProvider,
_.Library.String  credentialsFile,
_.Library.String  region,
_.Library.Status  sc,
_.Library.String  endPoint 
)
static

Factory method to create a cloud storage client.

javaServer: Java gateway name, default to default Java gateway. storageProvider: Specify storage provider. 0: Amazon S3, 1: Azure Blob, 2: Google Cloud Storage. credentialsFile: File name containing credentials for specific storage provider. region: Cloud storage region for specific storage provider. sc: returning status code. endPoint: Optional PrivateLink endpoint

◆ DownloadBlobToStream()

_.Stream.Object DownloadBlobToStream ( _.Library.String  bucketName,
_.Library.String  blobName,
_.Library.String  blobEncoding 
)

Download a blob from the cloud to a stream.

blobEncoding name follows Java convention If blobEncoding = "", the returning stream is GlobalBinarayStream; otherwise, it is GlobalCharacterStream.

◆ DownloadBlobToString()

_.Library.String DownloadBlobToString ( _.Library.String  bucketName,
_.Library.String  blobName,
_.Library.String  blobEncoding 
)

Download a blob from the cloud to a string.

blobEncoding: Blob content encoding, the name follows Java convention. If blobEncoding = "", treat the blob content as encoded in UTF-8.

◆ ListBlobs()

_.Library.ListOfObjects ListBlobs ( _.Library.String  bucketName,
_.Library.String  blobNamePrefix,
_.Library.String  blobNamePattern 
)

List all blobs within a bucket, filtered by blobNamePrefix and blobNamePattern.

bucketName: bucket name blobNamePrefix: blob name prefix, used to filter the result on the server. blobNamePattern: blob name pattern, used to filter the result by the client. Support wild cards "?" and "*".

◆ UploadBlobFromStream()

UploadBlobFromStream ( _.Library.String  bucketName,
_.Library.String  blobName,
_.Stream.Object  stream 
)

Upload a binary or character stream blob to the cloud.

For character stream, its content is converted to UTF-8 first, then uploaded as binary stream.

◆ UploadBlobFromString()

UploadBlobFromString ( _.Library.String  bucketName,
_.Library.String  blobName,
_.Library.String  content 
)

Upload a string blob to the cloud.

String content will be encoded as UTF-8

Member Data Documentation

◆ gateway

gateway

Connection to a Java Gateway.

 

◆ jclient

jclient

Remote Java client object to Azure, Google or S3.