IBMStorage Component

Properties   Methods   Events   Config Settings   Errors  

The IBMStorage component provides an easy way to interface with IBM Cloud's Object Storage service.

Syntax

nsoftware.CloudStorage.IBMStorage

Remarks

The IBM Cloud Object Storage service has an API that is compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses.

To use the IBMStorage component, you will first need to sign up for the IBM Cloud Object Storage service and obtain an AccessKey and a SecretKey. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your data store.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AccessKey Property (IBMStorage Component)

The access key to use for authentication.

Syntax

• C#
• VB.NET

public string AccessKey { get; set; }

Public Property AccessKey As String

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

AccessPolicy Property (IBMStorage Component)

The canned access policy to apply to a bucket or object.

Syntax

• C#
• VB.NET

public IBMStorageAccessPolicies AccessPolicy { get; set; }

enum IBMStorageAccessPolicies {
  ptPrivate,
  ptPublicRead,
  ptPublicReadWrite,
  ptAuthenticatedRead,
  ptBucketOwnerRead,
  ptBucketOwnerFullControl,
  ptNone
}

Public Property AccessPolicy As IbmstorageAccessPolicies

Enum IBMStorageAccessPolicies
  ptPrivate
  ptPublicRead
  ptPublicReadWrite
  ptAuthenticatedRead
  ptBucketOwnerRead
  ptBucketOwnerFullControl
  ptNone
End Enum

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

Valid values are:

Bucket Property (IBMStorage Component)

Selects a bucket.

Syntax

• C#
• VB.NET

public string Bucket { get; set; }

Public Property Bucket As String

Default Value

""

Remarks

This property selects a bucket, by name, for the component to operate against. It must be set before attempting most operations.

Buckets Property (IBMStorage Component)

A collection of buckets.

Syntax

• C#
• VB.NET

public S3BucketList Buckets { get; }

Public ReadOnly Property Buckets As S3BucketList

Remarks

This collection holds a list of S3Bucket items.

Calling ListBuckets will populate this collection.

This property is read-only and not available at design time.

ContentDisposition Property (IBMStorage Component)

Content disposition to send for an object.

Syntax

• C#
• VB.NET

public string ContentDisposition { get; set; }

Public Property ContentDisposition As String

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.

This property is not available at design time.

ContentType Property (IBMStorage Component)

Content type to send for an object.

Syntax

• C#
• VB.NET

public string ContentType { get; set; }

Public Property ContentType As String

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.

This property is not available at design time.

EncryptionAlgorithm Property (IBMStorage Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public IBMStorageEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum IBMStorageEncryptionAlgorithms {
  eaAES,
  eaBlowfish,
  eaCAST,
  eaDES,
  eaIDEA,
  eaRC2,
  eaRC4,
  eaTEA,
  eaTripleDES,
  eaTwofish,
  eaRijndael,
  eaChaCha,
  eaXSalsa20
}

Public Property EncryptionAlgorithm As IbmstorageEncryptionAlgorithms

Enum IBMStorageEncryptionAlgorithms
  eaAES
  eaBlowfish
  eaCAST
  eaDES
  eaIDEA
  eaRC2
  eaRC4
  eaTEA
  eaTripleDES
  eaTwofish
  eaRijndael
  eaChaCha
  eaXSalsa20
End Enum

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

EncryptionPassword Property (IBMStorage Component)

The encryption password.

Syntax

• C#
• VB.NET

public string EncryptionPassword { get; set; }

Public Property EncryptionPassword As String

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.

The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Firewall Property (IBMStorage Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FollowRedirects Property (IBMStorage Component)

Determines what happens when the server issues a redirect.

Syntax

• C#
• VB.NET

public IBMStorageFollowRedirects FollowRedirects { get; set; }

enum IBMStorageFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Public Property FollowRedirects As IbmstorageFollowRedirects

Enum IBMStorageFollowRedirects
  frNever
  frAlways
  frSameScheme
End Enum

Default Value

0

Remarks

This property specifies how the component should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:

Idle Property (IBMStorage Component)

The current status of the component.

Syntax

• C#
• VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

LocalFile Property (IBMStorage Component)

The location of the local file.

Syntax

• C#
• VB.NET

public string LocalFile { get; set; }

Public Property LocalFile As String

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

LocalHost Property (IBMStorage Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Metadata Property (IBMStorage Component)

A collection of metadata items.

Syntax

• C#
• VB.NET

public S3MetadataList Metadata { get; }

Public Property Metadata As S3MetadataList

Remarks

This collection holds a list of S3Metadata items.

This collection is populated when GetObjectInfo is called; and its items are used anytime CreateObject, CopyObject, or StartMultipartUpload is called.

This property is not available at design time.

ObjectData Property (IBMStorage Component)

The data that was downloaded, or that should be uploaded.

Syntax

• C#
• VB.NET

public string ObjectData { get; set; }
public byte[] ObjectDataB { get; set; }

Public Property ObjectData As String
Public Property ObjectDataB As Byte()

Default Value

""

Remarks

This property is populated with object data after calling GetObject if SetDownloadStream and LocalFile are not set.

This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

ObjectDelimiter Property (IBMStorage Component)

The delimiter string to use when listing objects.

Syntax

• C#
• VB.NET

public string ObjectDelimiter { get; set; }

Public Property ObjectDelimiter As String

Default Value

""

Remarks

If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the component will also populate the PrefixCount and Prefix[i] configuration settings

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

ObjectMarker Property (IBMStorage Component)

A marker indicating what page of objects to return next.

Syntax

• C#
• VB.NET

public string ObjectMarker { get; set; }

Public Property ObjectMarker As String

Default Value

""

Remarks

This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns empty string.

Refer to ListObjects for more information.

This property is not available at design time.

ObjectPrefix Property (IBMStorage Component)

A prefix used to restrict the results returned when listing objects.

Syntax

• C#
• VB.NET

public string ObjectPrefix { get; set; }

Public Property ObjectPrefix As String

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Objects Property (IBMStorage Component)

A collection of objects.

Syntax

• C#
• VB.NET

public S3ObjectList Objects { get; }

Public ReadOnly Property Objects As S3ObjectList

Remarks

This collection holds a list of S3Object items.

Calling GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads will populate this collection.

This property is read-only and not available at design time.

OtherHeaders Property (IBMStorage Component)

Other headers as determined by the user (optional).

Syntax

• C#
• VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the component beyond what is provided.

This property is not available at design time.

Overwrite Property (IBMStorage Component)

Determines if local files are overwritten.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is false.

ParsedHeaders Property (IBMStorage Component)

This property includes a collection of headers returned from the last request.

Syntax

• C#
• VB.NET

public HeaderList ParsedHeaders { get; }

Public ReadOnly Property ParsedHeaders As HeaderList

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to count -1.

This property is read-only and not available at design time.

PartMarker Property (IBMStorage Component)

A marker indicating what page of parts to return next.

Syntax

• C#
• VB.NET

public string PartMarker { get; set; }

Public Property PartMarker As String

Default Value

""

Remarks

This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.

Refer to ListParts for more information.

This property is not available at design time.

Parts Property (IBMStorage Component)

A collection of multipart upload parts.

Syntax

• C#
• VB.NET

public S3PartList Parts { get; }

Public ReadOnly Property Parts As S3PartList

Remarks

This collection holds a list of S3Part items.

Calling ListParts will populate this collection.

This property is read-only and not available at design time.

Proxy Property (IBMStorage Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QueryParams Property (IBMStorage Component)

Additional query parameters to be included in the request.

Syntax

• C#
• VB.NET

public QueryParamList QueryParams { get; }

Public Property QueryParams As QueryParamList

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Range Property (IBMStorage Component)

The range of bytes to request.

Syntax

• C#
• VB.NET

public string Range { get; set; }

Public Property Range As String

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the component will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Region Property (IBMStorage Component)

The region the component will make requests against.

Syntax

• C#
• VB.NET

public string Region { get; set; }

Public Property Region As String

Default Value

"us"

Remarks

This property control which region the component will make requests against. By default the component uses us, the US cross region. This property should be changed to create or access resources in other regions.

Regions:

Note that private. or direct. may optionally be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

The component will always convert this property's value to lowercase. If this property is cleared, the component will reset it to the default value.

SecretKey Property (IBMStorage Component)

The secret key to use for authentication.

Syntax

• C#
• VB.NET

public string SecretKey { get; set; }

Public Property SecretKey As String

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

SSLAcceptServerCert Property (IBMStorage Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (IBMStorage Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (IBMStorage Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C#
• VB.NET

public IBMStorageSSLProviders SSLProvider { get; set; }

enum IBMStorageSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As IbmstorageSSLProviders

Enum IBMStorageSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (IBMStorage Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

StartByte Property (IBMStorage Component)

The byte offset from which to resume the upload or download.

Syntax

• C#
• VB.NET

public long StartByte { get; set; }

Public Property StartByte As Long

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.

When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when CreateObject is called. Keep this in mind when resuming interrupted object uploads.

This property is not available at design time.

Timeout Property (IBMStorage Component)

The timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

UseVirtualHosting Property (IBMStorage Component)

Determines which style request to use.

Syntax

• C#
• VB.NET

public bool UseVirtualHosting { get; set; }

Public Property UseVirtualHosting As Boolean

Default Value

True

Remarks

If set to true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.us.cloud-object-storage.appdomain.cloud/yourobject. If false, the component will use the path-style request: http://s3.us.cloud-object-storage.appdomain.cloud/yourbucket/yourobject.

Note: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions.

This property is not available at design time.

VersionId Property (IBMStorage Component)

The object version to make requests against.

Syntax

• C#
• VB.NET

public string VersionId { get; set; }

Public Property VersionId As String

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

VersionMarker Property (IBMStorage Component)

A marker indicating what page of object versions to return next.

Syntax

• C#
• VB.NET

public string VersionMarker { get; set; }

Public Property VersionMarker As String

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

AbortMultipartUpload Method (IBMStorage Component)

Aborts a multipart upload.

Syntax

• C#
• VB.NET

public void AbortMultipartUpload(string objectName, string uploadId);

Async Version
public async Task AbortMultipartUpload(string objectName, string uploadId);
public async Task AbortMultipartUpload(string objectName, string uploadId, CancellationToken cancellationToken);

Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String)

Async Version
Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) As Task
Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)

If this method is called successfully, the specified UploadId will no longer be valid.

AddMetadata Method (IBMStorage Component)

Adds a metadata item to the Metadata properties.

Syntax

• C#
• VB.NET

public void AddMetadata(string name, string value);

Async Version
public async Task AddMetadata(string name, string value);
public async Task AddMetadata(string name, string value, CancellationToken cancellationToken);

Public Sub AddMetadata(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddMetadata(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddMetadata(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method adds a metadata item to the Metadata collection. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The component will take care of prepending it when sending metadata to the server.

AddQueryParam Method (IBMStorage Component)

Adds a query parameter to the QueryParams properties.

Syntax

• C#
• VB.NET

public void AddQueryParam(string name, string value);

Async Version
public async Task AddQueryParam(string name, string value);
public async Task AddQueryParam(string name, string value, CancellationToken cancellationToken);

Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String)

Async Version
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String) As Task
Public Sub AddQueryParam(ByVal Name As String, ByVal Value As String, cancellationToken As CancellationToken) As Task

Remarks

This method is used to add a query parameter to the QueryParams collection. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.

BucketExists Method (IBMStorage Component)

Checks whether the bucket exists.

Syntax

• C#
• VB.NET

public bool BucketExists();

Async Version
public async Task<bool> BucketExists();
public async Task<bool> BucketExists(CancellationToken cancellationToken);

Public Function BucketExists() As Boolean

Async Version
Public Function BucketExists() As Task(Of Boolean)
Public Function BucketExists(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.

CheckVersioningEnabled Method (IBMStorage Component)

Checks whether versioning is enabled for the currently selected bucket.

Syntax

• C#
• VB.NET

public bool CheckVersioningEnabled();

Async Version
public async Task<bool> CheckVersioningEnabled();
public async Task<bool> CheckVersioningEnabled(CancellationToken cancellationToken);

Public Function CheckVersioningEnabled() As Boolean

Async Version
Public Function CheckVersioningEnabled() As Task(Of Boolean)
Public Function CheckVersioningEnabled(cancellationToken As CancellationToken) As Task(Of Boolean)

Remarks

This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return false when queried.

Refer to Amazon's Versioning documentation for more information about versioning.

CompleteMultipartUpload Method (IBMStorage Component)

Completes a multipart upload by assembling previously uploaded parts.

Syntax

• C#
• VB.NET

public void CompleteMultipartUpload(string objectName, string uploadId);

Async Version
public async Task CompleteMultipartUpload(string objectName, string uploadId);
public async Task CompleteMultipartUpload(string objectName, string uploadId, CancellationToken cancellationToken);

Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String)

Async Version
Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) As Task
Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts collection, nor does it cause the PartList event to fire.

Config Method (IBMStorage Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyObject Method (IBMStorage Component)

Copies an object.

Syntax

• C#
• VB.NET

public void CopyObject(string srcObjectName, string destBucket, string destObjectName);

Async Version
public async Task CopyObject(string srcObjectName, string destBucket, string destObjectName);
public async Task CopyObject(string srcObjectName, string destBucket, string destObjectName, CancellationToken cancellationToken);

Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String)

Async Version
Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String) As Task
Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.

If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If there are any metadata items present in the Metadata collection, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may only be copied to buckets that exist within the same region.
• Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.

CopyPart Method (IBMStorage Component)

Copies the specified object as a part of a multipart upload.

Syntax

• C#
• VB.NET

public void CopyPart(string srcObjectName, string destBucket, string destObjectName, int destPartNumber, string destUploadId);

Async Version
public async Task CopyPart(string srcObjectName, string destBucket, string destObjectName, int destPartNumber, string destUploadId);
public async Task CopyPart(string srcObjectName, string destBucket, string destObjectName, int destPartNumber, string destUploadId, CancellationToken cancellationToken);

Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String)

Async Version
Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String) As Task
Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String, cancellationToken As CancellationToken) As Task

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

CreateBucket Method (IBMStorage Component)

Creates a new bucket.

Syntax

• C#
• VB.NET

public void CreateBucket();

Async Version
public async Task CreateBucket();
public async Task CreateBucket(CancellationToken cancellationToken);

Public Sub CreateBucket()

Async Version
Public Sub CreateBucket() As Task
Public Sub CreateBucket(cancellationToken As CancellationToken) As Task

Remarks

This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.

CreateObject Method (IBMStorage Component)

Creates a new object in the currently selected bucket.

Syntax

• C#
• VB.NET

public void CreateObject(string objectName);

Async Version
public async Task CreateObject(string objectName);
public async Task CreateObject(string objectName, CancellationToken cancellationToken);

Public Sub CreateObject(ByVal ObjectName As String)

Async Version
Public Sub CreateObject(ByVal ObjectName As String) As Task
Public Sub CreateObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata collection, they will included in the creation request.

If SetUploadStream has been used to set an upload stream, it will take priority as the data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the component will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the component automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.

DeleteBucket Method (IBMStorage Component)

Deletes a bucket.

Syntax

• C#
• VB.NET

public void DeleteBucket();

Async Version
public async Task DeleteBucket();
public async Task DeleteBucket(CancellationToken cancellationToken);

Public Sub DeleteBucket()

Async Version
Public Sub DeleteBucket() As Task
Public Sub DeleteBucket(cancellationToken As CancellationToken) As Task

Remarks

This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.

DeleteObject Method (IBMStorage Component)

Deletes an object.

Syntax

• C#
• VB.NET

public void DeleteObject(string objectName);

Async Version
public async Task DeleteObject(string objectName);
public async Task DeleteObject(string objectName, CancellationToken cancellationToken);

Public Sub DeleteObject(ByVal ObjectName As String)

Async Version
Public Sub DeleteObject(ByVal ObjectName As String) As Task
Public Sub DeleteObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.

If the VersionId property is non-empty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

DisableVersioning Method (IBMStorage Component)

Disables versioning for the currently selected bucket.

Syntax

• C#
• VB.NET

public void DisableVersioning();

Async Version
public async Task DisableVersioning();
public async Task DisableVersioning(CancellationToken cancellationToken);

Public Sub DisableVersioning()

Async Version
Public Sub DisableVersioning() As Task
Public Sub DisableVersioning(cancellationToken As CancellationToken) As Task

Remarks

This method can be used to disable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

DoEvents Method (IBMStorage Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

EnableVersioning Method (IBMStorage Component)

Enables versioning for the currently selected bucket.

Syntax

• C#
• VB.NET

public void EnableVersioning();

Async Version
public async Task EnableVersioning();
public async Task EnableVersioning(CancellationToken cancellationToken);

Public Sub EnableVersioning()

Async Version
Public Sub EnableVersioning() As Task
Public Sub EnableVersioning(cancellationToken As CancellationToken) As Task

Remarks

This method can be used to enable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

GetBucketLocation Method (IBMStorage Component)

Gets a bucket's location.

Syntax

• C#
• VB.NET

public string GetBucketLocation();

Async Version
public async Task<string> GetBucketLocation();
public async Task<string> GetBucketLocation(CancellationToken cancellationToken);

Public Function GetBucketLocation() As String

Async Version
Public Function GetBucketLocation() As Task(Of String)
Public Function GetBucketLocation(cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.

GetLink Method (IBMStorage Component)

Creates a link that provides access to an object for a specified amount of time.

Syntax

• C#
• VB.NET

public string GetLink(string objectName, int expires);

Async Version
public async Task<string> GetLink(string objectName, int expires);
public async Task<string> GetLink(string objectName, int expires, CancellationToken cancellationToken);

Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer) As String

Async Version
Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer) As Task(Of String)
Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.

GetObject Method (IBMStorage Component)

Downloads an object.

Syntax

• C#
• VB.NET

public void GetObject(string objectName);

Async Version
public async Task GetObject(string objectName);
public async Task GetObject(string objectName, CancellationToken cancellationToken);

Public Sub GetObject(ByVal ObjectName As String)

Async Version
Public Sub GetObject(ByVal ObjectName As String) As Task
Public Sub GetObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.

If a stream has been specified using SetDownloadStream, the object data will be sent through it. If a stream is not specified, and LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Resuming Downloads

The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

GetObjectInfo Method (IBMStorage Component)

Gets an object's information and metadata.

Syntax

• C#
• VB.NET

public void GetObjectInfo(string objectName);

Async Version
public async Task GetObjectInfo(string objectName);
public async Task GetObjectInfo(string objectName, CancellationToken cancellationToken);

Public Sub GetObjectInfo(ByVal ObjectName As String)

Async Version
Public Sub GetObjectInfo(ByVal ObjectName As String) As Task
Public Sub GetObjectInfo(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects and Metadata collection properties.

Interrupt Method (IBMStorage Component)

This method interrupts the current method.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListBuckets Method (IBMStorage Component)

Lists all buckets in the account.

Syntax

• C#
• VB.NET

public void ListBuckets();

Async Version
public async Task ListBuckets();
public async Task ListBuckets(CancellationToken cancellationToken);

Public Sub ListBuckets()

Async Version
Public Sub ListBuckets() As Task
Public Sub ListBuckets(cancellationToken As CancellationToken) As Task

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets collection.

ListMultipartUploads Method (IBMStorage Component)

Lists the current multipart uploads.

Syntax

• C#
• VB.NET

public void ListMultipartUploads();

Async Version
public async Task ListMultipartUploads();
public async Task ListMultipartUploads(CancellationToken cancellationToken);

Public Sub ListMultipartUploads()

Async Version
Public Sub ListMultipartUploads() As Task
Public Sub ListMultipartUploads(cancellationToken As CancellationToken) As Task

Remarks

This method lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects collection.

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects collection every time a page of results is returned.

ListObjects Method (IBMStorage Component)

Lists the objects in a bucket.

Syntax

• C#
• VB.NET

public void ListObjects();

Async Version
public async Task ListObjects();
public async Task ListObjects(CancellationToken cancellationToken);

Public Sub ListObjects()

Async Version
Public Sub ListObjects() As Task
Public Sub ListObjects(cancellationToken As CancellationToken) As Task

Remarks

This method lists the objects in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object, and will also populate the Objects collection. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects collection every time a page of results is returned.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ListParts Method (IBMStorage Component)

Lists the parts in a multipart upload.

Syntax

• C#
• VB.NET

public void ListParts(string objectName, string uploadId);

Async Version
public async Task ListParts(string objectName, string uploadId);
public async Task ListParts(string objectName, string uploadId, CancellationToken cancellationToken);

Public Sub ListParts(ByVal ObjectName As String, ByVal UploadId As String)

Async Version
Public Sub ListParts(ByVal ObjectName As String, ByVal UploadId As String) As Task
Public Sub ListParts(ByVal ObjectName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

Calling this method will fire the PartList event once for each part, and will also populate the Parts collection.

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Parts collection every time a page of results is returned.

Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the component will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.

ListVersions Method (IBMStorage Component)

Lists the object versions in a bucket.

Syntax

• C#
• VB.NET

public void ListVersions();

Async Version
public async Task ListVersions();
public async Task ListVersions(CancellationToken cancellationToken);

Public Sub ListVersions()

Async Version
Public Sub ListVersions() As Task
Public Sub ListVersions(cancellationToken As CancellationToken) As Task

Remarks

This method lists the object versions in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects collection. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects collection. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects collection every time a page of results is returned.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Reset Method (IBMStorage Component)

Resets the component to its initial state.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method resets the component to its initial state.

ResetHeaders Method (IBMStorage Component)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

• C#
• VB.NET

public void ResetHeaders();

Async Version
public async Task ResetHeaders();
public async Task ResetHeaders(CancellationToken cancellationToken);

Public Sub ResetHeaders()

Async Version
Public Sub ResetHeaders() As Task
Public Sub ResetHeaders(cancellationToken As CancellationToken) As Task

Remarks

Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

SendCustomRequest Method (IBMStorage Component)

Sends a custom request to the server.

Syntax

• C#
• VB.NET

public void SendCustomRequest(string httpMethod, string objectName, string requestBody);

Async Version
public async Task SendCustomRequest(string httpMethod, string objectName, string requestBody);
public async Task SendCustomRequest(string httpMethod, string objectName, string requestBody, CancellationToken cancellationToken);

Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String)

Async Version
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String) As Task
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String, cancellationToken As CancellationToken) As Task

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the component does the following:

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
   • Bucket (if non-empty)
   • ObjectName (if non-empty)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParams
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • ProductToken
   • SessionToken
   • UserToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeaders collection; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ObjectData (using the same logic as GetObject).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

SetDownloadStream Method (IBMStorage Component)

Sets the stream to which downloaded data will be written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

SetUploadStream Method (IBMStorage Component)

Sets the stream from which data is read when uploading.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

StartMultipartUpload Method (IBMStorage Component)

Starts a new manual multipart upload.

Syntax

• C#
• VB.NET

public string StartMultipartUpload(string objectName);

Async Version
public async Task<string> StartMultipartUpload(string objectName);
public async Task<string> StartMultipartUpload(string objectName, CancellationToken cancellationToken);

Public Function StartMultipartUpload(ByVal ObjectName As String) As String

Async Version
Public Function StartMultipartUpload(ByVal ObjectName As String) As Task(Of String)
Public Function StartMultipartUpload(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method starts a new "manual" multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the CreateObject method. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If there are any metadata items present in the Metadata collection, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

UpdateBucketACL Method (IBMStorage Component)

Updates a bucket's canned access policy.

Syntax

• C#
• VB.NET

public void UpdateBucketACL();

Async Version
public async Task UpdateBucketACL();
public async Task UpdateBucketACL(CancellationToken cancellationToken);

Public Sub UpdateBucketACL()

Async Version
Public Sub UpdateBucketACL() As Task
Public Sub UpdateBucketACL(cancellationToken As CancellationToken) As Task

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

UpdateObjectACL Method (IBMStorage Component)

Updates an object's canned access policy.

Syntax

• C#
• VB.NET

public void UpdateObjectACL(string objectName);

Async Version
public async Task UpdateObjectACL(string objectName);
public async Task UpdateObjectACL(string objectName, CancellationToken cancellationToken);

Public Sub UpdateObjectACL(ByVal ObjectName As String)

Async Version
Public Sub UpdateObjectACL(ByVal ObjectName As String) As Task
Public Sub UpdateObjectACL(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.

UploadPart Method (IBMStorage Component)

Uploads a multipart upload part.

Syntax

• C#
• VB.NET

public void UploadPart(string objectName, int partNumber, string uploadId);

Async Version
public async Task UploadPart(string objectName, int partNumber, string uploadId);
public async Task UploadPart(string objectName, int partNumber, string uploadId, CancellationToken cancellationToken);

Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String)

Async Version
Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String) As Task
Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String, cancellationToken As CancellationToken) As Task

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.

The data to upload is taken from either the stream set using SetUploadStream, LocalFile, or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is true, the component will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.

BucketList Event (IBMStorage Component)

Fires once for each bucket returned when listing buckets.

Syntax

• C#
• VB.NET

public event OnBucketListHandler OnBucketList;

public delegate void OnBucketListHandler(object sender, IBMStorageBucketListEventArgs e);

public class IBMStorageBucketListEventArgs : EventArgs {
  public string BucketName { get; }
  public string CreationDate { get; }
  public string OwnerId { get; }
  public string OwnerName { get; }
}

Public Event OnBucketList As OnBucketListHandler

Public Delegate Sub OnBucketListHandler(sender As Object, e As IBMStorageBucketListEventArgs)

Public Class IBMStorageBucketListEventArgs Inherits EventArgs
  Public ReadOnly Property BucketName As String
  Public ReadOnly Property CreationDate As String
  Public ReadOnly Property OwnerId As String
  Public ReadOnly Property OwnerName As String
End Class

Remarks

This event fires once for each bucket returned when ListBuckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

EndTransfer Event (IBMStorage Component)

This event fires when a document finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, IBMStorageEndTransferEventArgs e);

public class IBMStorageEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As IBMStorageEndTransferEventArgs)

Public Class IBMStorageEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IBMStorage Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, IBMStorageErrorEventArgs e);

public class IBMStorageErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As IBMStorageErrorEventArgs)

Public Class IBMStorageErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (IBMStorage Component)

Fires after each part in an automatic multipart upload is complete.

Syntax

• C#
• VB.NET

public event OnFragmentCompleteHandler OnFragmentComplete;

public delegate void OnFragmentCompleteHandler(object sender, IBMStorageFragmentCompleteEventArgs e);

public class IBMStorageFragmentCompleteEventArgs : EventArgs {
  public int FragmentNumber { get; }
  public int FragmentCount { get; }
  public bool Interrupt { get; set; }
}

Public Event OnFragmentComplete As OnFragmentCompleteHandler

Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As IBMStorageFragmentCompleteEventArgs)

Public Class IBMStorageFragmentCompleteEventArgs Inherits EventArgs
  Public ReadOnly Property FragmentNumber As Integer
  Public ReadOnly Property FragmentCount As Integer
  Public Property Interrupt As Boolean
End Class

Remarks

If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the component will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Refer to CreateObject for more information.

Header Event (IBMStorage Component)

Fired every time a header line comes in.

Syntax

• C#
• VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, IBMStorageHeaderEventArgs e);

public class IBMStorageHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As IBMStorageHeaderEventArgs)

Public Class IBMStorageHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (IBMStorage Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, IBMStorageLogEventArgs e);

public class IBMStorageLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As IBMStorageLogEventArgs)

Public Class IBMStorageLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event is fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MetadataList Event (IBMStorage Component)

Fires once for each metadata item returned when object information and metadata is retrieved.

Syntax

• C#
• VB.NET

public event OnMetadataListHandler OnMetadataList;

public delegate void OnMetadataListHandler(object sender, IBMStorageMetadataListEventArgs e);

public class IBMStorageMetadataListEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
}

Public Event OnMetadataList As OnMetadataListHandler

Public Delegate Sub OnMetadataListHandler(sender As Object, e As IBMStorageMetadataListEventArgs)

Public Class IBMStorageMetadataListEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
End Class

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (IBMStorage Component)

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

• C#
• VB.NET

public event OnObjectListHandler OnObjectList;

public delegate void OnObjectListHandler(object sender, IBMStorageObjectListEventArgs e);

public class IBMStorageObjectListEventArgs : EventArgs {
  public string BucketName { get; }
  public string ObjectName { get; }
  public string LastModified { get; }
  public long Size { get; }
  public string ETag { get; }
  public string OwnerId { get; }
  public string OwnerName { get; }
  public string UploadId { get; }
  public string VersionId { get; }
  public bool LatestVersion { get; }
  public bool Deleted { get; }
}

Public Event OnObjectList As OnObjectListHandler

Public Delegate Sub OnObjectListHandler(sender As Object, e As IBMStorageObjectListEventArgs)

Public Class IBMStorageObjectListEventArgs Inherits EventArgs
  Public ReadOnly Property BucketName As String
  Public ReadOnly Property ObjectName As String
  Public ReadOnly Property LastModified As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ETag As String
  Public ReadOnly Property OwnerId As String
  Public ReadOnly Property OwnerName As String
  Public ReadOnly Property UploadId As String
  Public ReadOnly Property VersionId As String
  Public ReadOnly Property LatestVersion As Boolean
  Public ReadOnly Property Deleted As Boolean
End Class

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.

PartList Event (IBMStorage Component)

Fires once for every part returned when listing a multipart upload's parts.

Syntax

• C#
• VB.NET

public event OnPartListHandler OnPartList;

public delegate void OnPartListHandler(object sender, IBMStoragePartListEventArgs e);

public class IBMStoragePartListEventArgs : EventArgs {
  public int PartNumber { get; }
  public string ObjectName { get; }
  public string LastModified { get; }
  public long Size { get; }
  public string ETag { get; }
  public string OwnerId { get; }
  public string OwnerName { get; }
}

Public Event OnPartList As OnPartListHandler

Public Delegate Sub OnPartListHandler(sender As Object, e As IBMStoragePartListEventArgs)

Public Class IBMStoragePartListEventArgs Inherits EventArgs
  Public ReadOnly Property PartNumber As Integer
  Public ReadOnly Property ObjectName As String
  Public ReadOnly Property LastModified As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property ETag As String
  Public ReadOnly Property OwnerId As String
  Public ReadOnly Property OwnerName As String
End Class

Remarks

This event fires once for each multipart upload part returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

PrefixList Event (IBMStorage Component)

Fires once for each common prefix returned when listing objects.

Syntax

• C#
• VB.NET

public event OnPrefixListHandler OnPrefixList;

public delegate void OnPrefixListHandler(object sender, IBMStoragePrefixListEventArgs e);

public class IBMStoragePrefixListEventArgs : EventArgs {
  public string BucketName { get; }
  public string Prefix { get; }
}

Public Event OnPrefixList As OnPrefixListHandler

Public Delegate Sub OnPrefixListHandler(sender As Object, e As IBMStoragePrefixListEventArgs)

Public Class IBMStoragePrefixListEventArgs Inherits EventArgs
  Public ReadOnly Property BucketName As String
  Public ReadOnly Property Prefix As String
End Class

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (IBMStorage Component)

Fires during an upload or download to indicate transfer progress.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, IBMStorageProgressEventArgs e);

public class IBMStorageProgressEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public long TotalBytes { get; }
  public int PercentDone { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As IBMStorageProgressEventArgs)

Public Class IBMStorageProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property TotalBytes As Long
  Public ReadOnly Property PercentDone As Integer
End Class

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (IBMStorage Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, IBMStorageSSLServerAuthenticationEventArgs e);

public class IBMStorageSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As IBMStorageSSLServerAuthenticationEventArgs)

Public Class IBMStorageSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IBMStorage Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, IBMStorageSSLStatusEventArgs e);

public class IBMStorageSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As IBMStorageSSLStatusEventArgs)

Public Class IBMStorageSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IBMStorage Component)

This event fires when a document starts transferring (after the headers).

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, IBMStorageStartTransferEventArgs e);

public class IBMStorageStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As IBMStorageStartTransferEventArgs)

Public Class IBMStorageStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (IBMStorage Component)

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, IBMStorageTransferEventArgs e);

public class IBMStorageTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As IBMStorageTransferEventArgs)

Public Class IBMStorageTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

• C#
• VB.NET

public Header();

Public Header()

• C#
• VB.NET

public Header(string field, string value);

Public Header(ByVal Field As String, ByVal Value As String)

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)