# IBMStorage Component The IBMStorage component provides an easy way to interface with IBM Cloud's Object Storage service. ## Syntax ```text TcsIBMStorage ``` ## 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](#accesskey-property-ibmstorage-component) and a [SecretKey](#secretkey-property-ibmstorage-component). Then you can start creating buckets in your account using [CreateBucket](#createbucket-method-ibmstorage-component). 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](#createobject-method-ibmstorage-component). There are other methods such as [ListBuckets](#listbuckets-method-ibmstorage-component), [ListObjects](#listobjects-method-ibmstorage-component), [GetObject](#getobject-method-ibmstorage-component), [GetLink](#getlink-method-ibmstorage-component), [DeleteObject](#deleteobject-method-ibmstorage-component) 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.* | | | | --- | --- | | [AccessKey](#accesskey-property-ibmstorage-component) | The access key to use for authentication. | | [AccessPolicy](#accesspolicy-property-ibmstorage-component) | The canned access policy to apply to a bucket or object. | | [Bucket](#bucket-property-ibmstorage-component) | Selects a bucket. | | [Buckets](#buckets-property-ibmstorage-component) | A collection of buckets. | | [ContentDisposition](#contentdisposition-property-ibmstorage-component) | Content disposition to send for an object. | | [ContentType](#contenttype-property-ibmstorage-component) | Content type to send for an object. | | [EncryptionAlgorithm](#encryptionalgorithm-property-ibmstorage-component) | The encryption algorithm. | | [EncryptionPassword](#encryptionpassword-property-ibmstorage-component) | The encryption password. | | [Firewall](#firewall-property-ibmstorage-component) | A set of properties related to firewall access. | | [FollowRedirects](#followredirects-property-ibmstorage-component) | Determines what happens when the server issues a redirect. | | [Idle](#idle-property-ibmstorage-component) | The current status of the component. | | [LocalFile](#localfile-property-ibmstorage-component) | The location of the local file. | | [LocalHost](#localhost-property-ibmstorage-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [Metadata](#metadata-property-ibmstorage-component) | A collection of metadata items. | | [ObjectData](#objectdata-property-ibmstorage-component) | The data that was downloaded, or that should be uploaded. | | [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) | The delimiter string to use when listing objects. | | [ObjectMarker](#objectmarker-property-ibmstorage-component) | A marker indicating what page of objects to return next. | | [ObjectPrefix](#objectprefix-property-ibmstorage-component) | A prefix used to restrict the results returned when listing objects. | | [Objects](#objects-property-ibmstorage-component) | A collection of objects. | | [OtherHeaders](#otherheaders-property-ibmstorage-component) | Other headers as determined by the user (optional). | | [Overwrite](#overwrite-property-ibmstorage-component) | Determines if local files are overwritten. | | [ParsedHeaders](#parsedheaders-property-ibmstorage-component) | This property includes a collection of headers returned from the last request. | | [PartMarker](#partmarker-property-ibmstorage-component) | A marker indicating what page of parts to return next. | | [Parts](#parts-property-ibmstorage-component) | A collection of multipart upload parts. | | [Proxy](#proxy-property-ibmstorage-component) | A set of properties related to proxy access. | | [QueryParams](#queryparams-property-ibmstorage-component) | Additional query parameters to be included in the request. | | [Range](#range-property-ibmstorage-component) | The range of bytes to request. | | [Region](#region-property-ibmstorage-component) | The region the component will make requests against. | | [SecretKey](#secretkey-property-ibmstorage-component) | The secret key to use for authentication. | | [SSLAcceptServerCert](#sslacceptservercert-property-ibmstorage-component) | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-ibmstorage-component) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-ibmstorage-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-ibmstorage-component) | The server certificate for the last established connection. | | [StartByte](#startbyte-property-ibmstorage-component) | The byte offset from which to resume the upload or download. | | [Timeout](#timeout-property-ibmstorage-component) | The timeout for the component. | | [UseVirtualHosting](#usevirtualhosting-property-ibmstorage-component) | Determines which style request to use. | | [VersionId](#versionid-property-ibmstorage-component) | The object version to make requests against. | | [VersionMarker](#versionmarker-property-ibmstorage-component) | A marker indicating what page of object versions to return next. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AbortMultipartUpload](#abortmultipartupload-method-ibmstorage-component) | Aborts a multipart upload. | | [AddMetadata](#addmetadata-method-ibmstorage-component) | Adds a metadata item to the Metadata properties. | | [AddQueryParam](#addqueryparam-method-ibmstorage-component) | Adds a query parameter to the QueryParams properties. | | [BucketExists](#bucketexists-method-ibmstorage-component) | Checks whether the bucket exists. | | [CheckVersioningEnabled](#checkversioningenabled-method-ibmstorage-component) | Checks whether versioning is enabled for the currently selected bucket. | | [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) | Completes a multipart upload by assembling previously uploaded parts. | | [Config](#config-method-ibmstorage-component) | Sets or retrieves a configuration setting. | | [CopyObject](#copyobject-method-ibmstorage-component) | Copies an object. | | [CopyPart](#copypart-method-ibmstorage-component) | Copies the specified object as a part of a multipart upload. | | [CreateBucket](#createbucket-method-ibmstorage-component) | Creates a new bucket. | | [CreateObject](#createobject-method-ibmstorage-component) | Creates a new object in the currently selected bucket. | | [DeleteBucket](#deletebucket-method-ibmstorage-component) | Deletes a bucket. | | [DeleteObject](#deleteobject-method-ibmstorage-component) | Deletes an object. | | [DisableVersioning](#disableversioning-method-ibmstorage-component) | Disables versioning for the currently selected bucket. | | [DoEvents](#doevents-method-ibmstorage-component) | This method processes events from the internal message queue. | | [EnableVersioning](#enableversioning-method-ibmstorage-component) | Enables versioning for the currently selected bucket. | | [GetBucketLocation](#getbucketlocation-method-ibmstorage-component) | Gets a bucket's location. | | [GetLink](#getlink-method-ibmstorage-component) | Creates a link that provides access to an object for a specified amount of time. | | [GetObject](#getobject-method-ibmstorage-component) | Downloads an object. | | [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) | Gets an object's information and metadata. | | [Interrupt](#interrupt-method-ibmstorage-component) | This method interrupts the current method. | | [ListBuckets](#listbuckets-method-ibmstorage-component) | Lists all buckets in the account. | | [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) | Lists the current multipart uploads. | | [ListObjects](#listobjects-method-ibmstorage-component) | Lists the objects in a bucket. | | [ListParts](#listparts-method-ibmstorage-component) | Lists the parts in a multipart upload. | | [ListVersions](#listversions-method-ibmstorage-component) | Lists the object versions in a bucket. | | [Reset](#reset-method-ibmstorage-component) | Resets the component to its initial state. | | [ResetHeaders](#resetheaders-method-ibmstorage-component) | Resets all HTTP headers, cookies, and LocalFile. | | [SendCustomRequest](#sendcustomrequest-method-ibmstorage-component) | Sends a custom request to the server. | | [SetDownloadStream](#setdownloadstream-method-ibmstorage-component) | Sets the stream to which downloaded data will be written. | | [SetUploadStream](#setuploadstream-method-ibmstorage-component) | Sets the stream from which data is read when uploading. | | [StartMultipartUpload](#startmultipartupload-method-ibmstorage-component) | Starts a new manual multipart upload. | | [UpdateBucketACL](#updatebucketacl-method-ibmstorage-component) | Updates a bucket's canned access policy. | | [UpdateObjectACL](#updateobjectacl-method-ibmstorage-component) | Updates an object's canned access policy. | | [UploadPart](#uploadpart-method-ibmstorage-component) | Uploads a multipart upload part. | ## 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.* | | | | --- | --- | | [BucketList](#bucketlist-event-ibmstorage-component) | Fires once for each bucket returned when listing buckets. | | [EndTransfer](#endtransfer-event-ibmstorage-component) | Fired when a document finishes transferring. | | [Error](#error-event-ibmstorage-component) | Fired when information is available about errors during data delivery. | | [FragmentComplete](#fragmentcomplete-event-ibmstorage-component) | Fires after each part in an automatic multipart upload is complete. | | [Header](#header-event-ibmstorage-component) | Fired every time a header line comes in. | | [Log](#log-event-ibmstorage-component) | Fired once for each log message. | | [MetadataList](#metadatalist-event-ibmstorage-component) | Fires once for each metadata item returned when object information and metadata is retrieved. | | [ObjectList](#objectlist-event-ibmstorage-component) | Fires once for each object, object version, or multipart upload returned when listing such items. | | [PartList](#partlist-event-ibmstorage-component) | Fires once for every part returned when listing a multipart upload's parts. | | [PrefixList](#prefixlist-event-ibmstorage-component) | Fires once for each common prefix returned when listing objects. | | [Progress](#progress-event-ibmstorage-component) | Fires during an upload or download to indicate transfer progress. | | [SSLServerAuthentication](#sslserverauthentication-event-ibmstorage-component) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-ibmstorage-component) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-ibmstorage-component) | Fired when a document starts transferring (after the headers). | | [Transfer](#transfer-event-ibmstorage-component) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccumulatePages](#AccumulatePages) | Whether the component should accumulate subsequent pages of results when listing them. | | [AssumeRoleARN](#AssumeRoleARN) | Amazon Resource Name used when assuming a role for authentication. | | [AssumeRoleDuration](#AssumeRoleDuration) | The duration for role session in seconds. | | [AssumeRoleSessionName](#AssumeRoleSessionName) | Unique name for current role session. | | [AutoDetectSigningRegion](#AutoDetectSigningRegion) | Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. | | [AWSProfile](#AWSProfile) | The name of the AWS CLI profile that the component should use to obtain authentication and region information. | | [AWSProfileDir](#AWSProfileDir) | The location of the AWS CLI credentials and config files. | | [ContentRange](#ContentRange) | This contains the range of bytes of the current object that are being returned. | | [CopyPartRange](#CopyPartRange) | Specifies the range of bytes to copy when calling CopyPart. | | [DownloadTempFile](#DownloadTempFile) | The temporary file used when downloading encrypted data. | | [EncodeSlashInObjectName](#EncodeSlashInObjectName) | Whether or not to encode slashes in an object name. | | [EncryptionIV](#EncryptionIV) | The initialization vector to be used for encryption/decryption. | | [EncryptionKey](#EncryptionKey) | The key to use during encryption/decryption. | | [EncryptionPasswordKDF](#EncryptionPasswordKDF) | The KDF algorithm to use during password based encryption and decryption. | | [EnforceBucketNameRestrictions](#EnforceBucketNameRestrictions) | Whether or not to enforce bucket naming conventions. | | [ETag](#ETag) | The ETag for the object returned by the server. | | [FragmentSize](#FragmentSize) | The part size to use when uploading a new object. | | [IfMatch](#IfMatch) | Check to make sure the object has not been modified since the last request. | | [IncludeContentMD5](#IncludeContentMD5) | Whether an MD5 digest of a custom request's data should be included. | | [IncludeObjectMD5](#IncludeObjectMD5) | Whether an MD5 digest of a object's data should be included. | | [IncludePartMD5](#IncludePartMD5) | Whether an MD5 digest of a part's data should be included. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in the Log event. | | [MaxObjects](#MaxObjects) | The maximum number of results to return when listing objects. | | [MaxParts](#MaxParts) | The maximum number of results to return when listing parts. | | [Prefix\[i\]](#Prefix[i]) | The i'th common prefix returned. | | [PrefixCount](#PrefixCount) | The number of common prefixes returned. | | [ProgressAbsolute](#ProgressAbsolute) | Whether the component should track transfer progress absolutely. | | [ProgressStep](#ProgressStep) | How often the progress event should be fired, in terms of percentage. | | [RawRequest](#RawRequest) | Returns the data that was sent to the server. | | [RawResponse](#RawResponse) | Returns the data that was received from the server. | | [ResponseCacheControl](#ResponseCacheControl) | Sets the Cache-Control header of the response. | | [ResponseContentDisposition](#ResponseContentDisposition) | Sets the Content-Disposition header of the response. | | [ResponseContentEncoding](#ResponseContentEncoding) | Sets the Content-Encoding header of the response. | | [ResponseContentLanguage](#ResponseContentLanguage) | Sets the Content-Language header of the response. | | [ResponseContentType](#ResponseContentType) | Sets the Content-Type header of the response. | | [ResponseExpires](#ResponseExpires) | Sets the Expires header of the response. | | [ResumableUploadState](#ResumableUploadState) | Tracks upload state information during an automatic multipart upload. | | [SessionToken](#SessionToken) | The session token to send in the request when using temporary credentials. | | [SignCustomRequest](#SignCustomRequest) | Tells the component to sign the outgoing request. | | [SigningTime](#SigningTime) | A custom date to send to the component to use while signing all requests. | | [SimpleUploadLimit](#SimpleUploadLimit) | The maximum data size the component should attempt to upload directly when creating an object. | | [StorageClass](#StorageClass) | Specifies the storage class to be used for newly-created buckets. | | [StoreObjectData](#StoreObjectData) | Whether component stores object data or not. | | [StorePrefixList](#StorePrefixList) | Whether to store the common prefixes returned when listing objects. | | [TempPath](#TempPath) | The path to the directory where temporary files are created. | | [URL](#URL) | If set, the default URL will be overridden by this value. | | [UseEC2RoleCredentials](#UseEC2RoleCredentials) | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the component. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the component will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the component. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the component. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the component will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the component whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the component binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessKey Property ([IBMStorage](#ibmstorage-component) Component) The access key to use for authentication. ## Syntax *Delphi Syntax* ```text property AccessKey: String read get_AccessKey write set_AccessKey; ``` ## Default Value '' ## Remarks This property specifies the access key that should be used for authentication. Both this property and [SecretKey](#secretkey-property-ibmstorage-component) must be set before attempting any operations which connect to the server. # AccessPolicy Property ([IBMStorage](#ibmstorage-component) Component) The canned access policy to apply to a bucket or object. ## Syntax *Delphi Syntax* ```text property AccessPolicy: TcsAccessPolicies read get_AccessPolicy write set_AccessPolicy; TcsAccessPolicies = ( ptPrivate, ptPublicRead, ptPublicReadWrite, ptAuthenticatedRead, ptBucketOwnerRead, ptBucketOwnerFullControl, ptNone ); ``` ## Default Value ptPrivate ## 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](#copyobject-method-ibmstorage-component) (for the destination object) - [CreateBucket](#createbucket-method-ibmstorage-component) - [CreateObject](#createobject-method-ibmstorage-component) - [StartMultipartUpload](#startmultipartupload-method-ibmstorage-component) - [UpdateBucketACL](#updatebucketacl-method-ibmstorage-component) - [UpdateObjectACL](#updateobjectacl-method-ibmstorage-component) Valid values are: | | | | --- | --- | | ptPrivate (0) (default) | Owner gets full control, no one else has access. | | ptPublicRead (1) | Owner gets full control, everyone else gets read access. | | ptPublicReadWrite (2) | Owner gets full control, everyone else gets read/write access. | | ptAuthenticatedRead (3) | Owner gets full control, authenticated users get read access. | | ptBucketOwnerRead (4) | Only applicable for objects. Object owner gets full control, bucket owner gets read access. | | ptBucketOwnerFullControl (5) | Only applicable for objects. Both object and bucket owner get full control. | | ptNone (6) | (Instructs the component to not explicitly set a canned access policy for a bucket or object.) | # Bucket Property ([IBMStorage](#ibmstorage-component) Component) Selects a bucket. ## Syntax *Delphi Syntax* ```text property Bucket: String read get_Bucket write set_Bucket; ``` ## 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](#ibmstorage-component) Component) A collection of buckets. ## Syntax *Delphi Syntax* ```text property Buckets: TcsS3BucketList read get_Buckets; ``` ## Remarks This collection holds a list of [S3Bucket](#s3bucket-type) items. Calling [ListBuckets](#listbuckets-method-ibmstorage-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [S3Bucket](#s3bucket-type) type for a complete list of fields. # ContentDisposition Property ([IBMStorage](#ibmstorage-component) Component) Content disposition to send for an object. ## Syntax *Delphi Syntax* ```text property ContentDisposition: String read get_ContentDisposition write set_ContentDisposition; ``` ## Default Value '' ## Remarks This property can be set before calling [CreateObject](#createobject-method-ibmstorage-component) 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](#ibmstorage-component) Component) Content type to send for an object. ## Syntax *Delphi Syntax* ```text property ContentType: String read get_ContentType write set_ContentType; ``` ## Default Value '' ## Remarks This property can be set before calling [CreateObject](#createobject-method-ibmstorage-component) 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](#ibmstorage-component) Component) The encryption algorithm. ## Syntax *Delphi Syntax* ```text property EncryptionAlgorithm: TcsEncryptionAlgorithms read get_EncryptionAlgorithm write set_EncryptionAlgorithm; TcsEncryptionAlgorithms = ( eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 ); ``` ## Default Value eaAES ## 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: | Algorithm | Key Size | | --- | --- | | 0 (eaAES - default) | 256 | | 1 (eaBlowfish) | 448 | | 2 (eaCAST) | 128 | | 3 (eaDES) | 64 | | 4 (eaIDEA) | 128 | | 5 (eaRC2) | 128 | | 6 (eaRC4) | 2048 | | 7 (eaTEA) | 128 | | 8 (eaTripleDES) | 192 | | 9 (eaTwofish) | 256 | | 10 (eaRijndael) | 256 | | 11 (eaChaCha) | 256 | | 12 (eaXSalsa20) | 256 | # EncryptionPassword Property ([IBMStorage](#ibmstorage-component) Component) The encryption password. ## Syntax *Delphi Syntax* ```text property EncryptionPassword: String read get_EncryptionPassword write set_EncryptionPassword; ``` ## 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](#EncryptionKey) and [EncryptionIV](#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](#ibmstorage-component) Component) A set of properties related to firewall access. ## Syntax *Delphi Syntax* ```text property Firewall: TcsFirewall read get_Firewall write set_Firewall; ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the component will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # FollowRedirects Property ([IBMStorage](#ibmstorage-component) Component) Determines what happens when the server issues a redirect. ## Syntax *Delphi Syntax* ```text property FollowRedirects: TcsTFollowRedirects read get_FollowRedirects write set_FollowRedirects; TcsTFollowRedirects = ( frNever, frAlways, frSameScheme ); ``` ## Default Value frNever ## Remarks This property specifies how the component should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are: | | | | --- | --- | | frNever (0) (default) | Redirects are never followed; the component raises an exception instead. | | frAlways (1) | Redirects are always followed. | | frSameScheme (2) | Redirects are followed if the new URL has the same scheme as the originally requested URL; otherwise, the component raises an exception. | # Idle Property ([IBMStorage](#ibmstorage-component) Component) The current status of the component. ## Syntax *Delphi Syntax* ```text property Idle: Boolean read get_Idle; ``` ## 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](#ibmstorage-component) Component) The location of the local file. ## Syntax *Delphi Syntax* ```text property LocalFile: String read get_LocalFile write set_LocalFile; ``` ## Default Value '' ## Remarks This property specifies the location of a file on disk. This is used as the source file when calling [CreateObject](#createobject-method-ibmstorage-component) or [UploadPart](#uploadpart-method-ibmstorage-component); and as the destination file when calling [GetObject](#getobject-method-ibmstorage-component). Note: Setting this property to a non-empty value will discard any streams set using [SetDownloadStream](#setdownloadstream-method-ibmstorage-component) and [SetUploadStream](#setuploadstream-method-ibmstorage-component). Similarly, passing a non-null value to either of the aforementioned methods will clear this property. # LocalHost Property ([IBMStorage](#ibmstorage-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Delphi Syntax* ```text property LocalHost: String read get_LocalHost write set_LocalHost; ``` ## 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](#ibmstorage-component) Component) A collection of metadata items. ## Syntax *Delphi Syntax* ```text property Metadata: TcsS3MetadataList read get_Metadata write set_Metadata; ``` ## Remarks This collection holds a list of [S3Metadata](#s3metadata-type) items. This collection is populated when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) is called; and its items are used anytime [CreateObject](#createobject-method-ibmstorage-component), [CopyObject](#copyobject-method-ibmstorage-component), or [StartMultipartUpload](#startmultipartupload-method-ibmstorage-component) is called. This property is not available at design time. Please refer to the [S3Metadata](#s3metadata-type) type for a complete list of fields. # ObjectData Property ([IBMStorage](#ibmstorage-component) Component) The data that was downloaded, or that should be uploaded. ## Syntax *Delphi Syntax* ```text property ObjectData: String read get_ObjectData write set_ObjectData; property ObjectDataB: TBytes read get_ObjectDataB write set_ObjectDataB; ``` ## Default Value '' ## Remarks This property is populated with object data after calling [GetObject](#getobject-method-ibmstorage-component) if [SetDownloadStream](#setdownloadstream-method-ibmstorage-component) and [LocalFile](#localfile-property-ibmstorage-component) are not set. This property can also be set before calling [CreateObject](#createobject-method-ibmstorage-component) or [UploadPart](#uploadpart-method-ibmstorage-component); its data will be uploaded if [SetUploadStream](#setuploadstream-method-ibmstorage-component) and [LocalFile](#localfile-property-ibmstorage-component) are not set. This property is not available at design time. # ObjectDelimiter Property ([IBMStorage](#ibmstorage-component) Component) The delimiter string to use when listing objects. ## Syntax *Delphi Syntax* ```text property ObjectDelimiter: String read get_ObjectDelimiter write set_ObjectDelimiter; ``` ## Default Value '' ## Remarks If this property is non-empty when [ListObjects](#listobjects-method-ibmstorage-component) or [ListVersions](#listversions-method-ibmstorage-component) is called, any objects (or object versions) whose names contain the same string between the specified [ObjectPrefix](#objectprefix-property-ibmstorage-component) 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](#prefixlist-event-ibmstorage-component) event will fire once for each common prefix returned. If the [StorePrefixList](#StorePrefixList) configuration setting is enabled, the component will also populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) configuration settings ### Object Hierarchy Traversal By using the ObjectDelimiter and [ObjectPrefix](#objectprefix-property-ibmstorage-component) 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](#objectprefix-property-ibmstorage-component) to successively "deeper" values before calling [ListObjects](#listobjects-method-ibmstorage-component) or [ListVersions](#listversions-method-ibmstorage-component) for the following effect: | [ObjectPrefix](#objectprefix-property-ibmstorage-component) Value | ObjectDelimiter Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | This property is not available at design time. # ObjectMarker Property ([IBMStorage](#ibmstorage-component) Component) A marker indicating what page of objects to return next. ## Syntax *Delphi Syntax* ```text property ObjectMarker: String read get_ObjectMarker write set_ObjectMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListObjects](#listobjects-method-ibmstorage-component) is called if the results are paged and there are more pages. To list all objects, continue to call [ListObjects](#listobjects-method-ibmstorage-component) until this property returns empty string. Refer to [ListObjects](#listobjects-method-ibmstorage-component) for more information. This property is not available at design time. # ObjectPrefix Property ([IBMStorage](#ibmstorage-component) Component) A prefix used to restrict the results returned when listing objects. ## Syntax *Delphi Syntax* ```text property ObjectPrefix: String read get_ObjectPrefix write set_ObjectPrefix; ``` ## Default Value '' ## Remarks This property, if non-empty, is used to restrict the results returned by [ListObjects](#listobjects-method-ibmstorage-component) (or [ListVersions](#listversions-method-ibmstorage-component)) to only the objects (or object versions) whose names begin with the given value. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) 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](#objectdelimiter-property-ibmstorage-component) set to */*, we can set ObjectPrefix to successively "deeper" values before calling [ListObjects](#listobjects-method-ibmstorage-component) or [ListVersions](#listversions-method-ibmstorage-component) for the following effect: | ObjectPrefix Value | [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | This property is not available at design time. # Objects Property ([IBMStorage](#ibmstorage-component) Component) A collection of objects. ## Syntax *Delphi Syntax* ```text property Objects: TcsS3ObjectList read get_Objects; ``` ## Remarks This collection holds a list of [S3Object](#s3object-type) items. Calling [GetObjectInfo](#getobjectinfo-method-ibmstorage-component), [ListObjects](#listobjects-method-ibmstorage-component), [ListVersions](#listversions-method-ibmstorage-component), or [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [S3Object](#s3object-type) type for a complete list of fields. # OtherHeaders Property ([IBMStorage](#ibmstorage-component) Component) Other headers as determined by the user (optional). ## Syntax *Delphi Syntax* ```text property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders; ``` ## 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](#contenttype-property-ibmstorage-component) and From. The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by CRLF (*'#13#10'*) . 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](#ibmstorage-component) Component) Determines if local files are overwritten. ## Syntax *Delphi Syntax* ```text property Overwrite: Boolean read get_Overwrite write set_Overwrite; ``` ## Default Value false ## Remarks This property controls whether local files are overwritten when calling [GetObject](#getobject-method-ibmstorage-component). It is only applicable to local files. The default value is *False*. # ParsedHeaders Property ([IBMStorage](#ibmstorage-component) Component) This property includes a collection of headers returned from the last request. ## Syntax *Delphi Syntax* ```text property ParsedHeaders: TcsHeaderList read get_ParsedHeaders; ``` ## 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](#header-type) in this collection contains information describing that header. [MaxHeaders](#MaxHeaders) can be used to control the maximum number of headers saved. This property is read-only and not available at design time. Please refer to the [Header](#header-type) type for a complete list of fields. # PartMarker Property ([IBMStorage](#ibmstorage-component) Component) A marker indicating what page of parts to return next. ## Syntax *Delphi Syntax* ```text property PartMarker: String read get_PartMarker write set_PartMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListParts](#listparts-method-ibmstorage-component) is called if the results are paged and there are more pages. To list all parts, continue to call [ListParts](#listparts-method-ibmstorage-component) until this property returns empty string. Refer to [ListParts](#listparts-method-ibmstorage-component) for more information. This property is not available at design time. # Parts Property ([IBMStorage](#ibmstorage-component) Component) A collection of multipart upload parts. ## Syntax *Delphi Syntax* ```text property Parts: TcsS3PartList read get_Parts; ``` ## Remarks This collection holds a list of [S3Part](#s3part-type) items. Calling [ListParts](#listparts-method-ibmstorage-component) will populate this collection. This property is read-only and not available at design time. Please refer to the [S3Part](#s3part-type) type for a complete list of fields. # Proxy Property ([IBMStorage](#ibmstorage-component) Component) A set of properties related to proxy access. ## Syntax *Delphi Syntax* ```text property Proxy: TcsProxy read get_Proxy write set_Proxy; ``` ## Remarks This property contains fields describing the proxy through which the component will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # QueryParams Property ([IBMStorage](#ibmstorage-component) Component) Additional query parameters to be included in the request. ## Syntax *Delphi Syntax* ```text property QueryParams: TcsQueryParamList read get_QueryParams write set_QueryParams; ``` ## Remarks This is a collection of query parameters that will be added to the request. Parameters can be added via the [AddQueryParam](#addqueryparam-method-ibmstorage-component) method. Please refer to the [QueryParam](#queryparam-type) type for a complete list of fields. # Range Property ([IBMStorage](#ibmstorage-component) Component) The range of bytes to request. ## Syntax *Delphi Syntax* ```text property Range: String read get_Range write set_Range; ``` ## Default Value '' ## Remarks This property specifies the range of bytes to request from the server. If this property is non-empty when a [GetObject](#getobject-method-ibmstorage-component) 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](#startbyte-property-ibmstorage-component) property is greater than zero when [GetObject](#getobject-method-ibmstorage-component) 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](#startbyte-property-ibmstorage-component) 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](#ibmstorage-component) Component) The region the component will make requests against. ## Syntax *Delphi Syntax* ```text property Region: String read get_Region write set_Region; ``` ## 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: | Value | Region | | --- | --- | | Cross-Region | | | us (default) | US Cross Region | | dal.us | US Cross Region (Dallas Access Point) | | sjc.us | US Cross Region (San Jose Access Point) | | wdc.us | US Cross Region (Washington DC Access Point) | | eu | EU Cross Region | | ams.eu | EU Cross Region (Amsterdam Access Point) | | fra.eu | EU Cross Region (Frankfurt Access Point) | | mil.eu | EU Cross Region (Milan Access Point) | | ap | Asia Pacific Cross Region | | hkg.ap | Asia Pacific Cross Region (Hong Kong Access Point) | | seo.ap | Asia Pacific Cross Region (Seoul Access Point) | | tok.ap | Asia Pacific Cross Region (Tokyo Access Point) | | Regional | | | au-syd | Australia (Sydney) | | eu-de | EU (Germany) | | eu-gb | EU (United Kingdom) | | jp-tok | Japan (Tokyo) | | us-east | US (East) | | us-south | US (South) | | Single-Site | | | ams03 | Netherlands (Amsterdam) | | che01 | India (Chennai) | | hkg02 | Hong Kong | | mel01 | Australia (Melbourne) | | mex01 | Mexico (Mexico City) | | mil01 | Italy (Milan) | | mon01 | Canada (Montreal) | | osl01 | Norway (Oslo) | | par01 | France (Paris) | | sao01 | Brazil (Sao Paulo) | | seo01 | South Korea (Seoul) | | sjc04 | US (San Jose) | | sng01 | Singapore | | tor01 | Canada (Toronto) | 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](#ibmstorage-component) Component) The secret key to use for authentication. ## Syntax *Delphi Syntax* ```text property SecretKey: String read get_SecretKey write set_SecretKey; ``` ## Default Value '' ## Remarks This property specifies the secret key that should be used for authentication. Both this property and [AccessKey](#accesskey-property-ibmstorage-component) must be set before attempting any operations which connect to the server. # SSLAcceptServerCert Property ([IBMStorage](#ibmstorage-component) Component) Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax *Delphi Syntax* ```text property SSLAcceptServerCert: TcsCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert; ``` ## 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. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([IBMStorage](#ibmstorage-component) Component) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax *Delphi Syntax* ```text property SSLCert: TcsCertificate read get_SSLCert write set_SSLCert; ``` ## 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](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([IBMStorage](#ibmstorage-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Delphi Syntax* ```text property SSLProvider: TcsTSSLProviders read get_SSLProvider write set_SSLProvider; TcsTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal ); ``` ## Default Value sslpAutomatic ## 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: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** 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](#SSLEnabledProtocols), the component will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([IBMStorage](#ibmstorage-component) Component) The server certificate for the last established connection. ## Syntax *Delphi Syntax* ```text property SSLServerCert: TcsCertificate read get_SSLServerCert; ``` ## 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. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # StartByte Property ([IBMStorage](#ibmstorage-component) Component) The byte offset from which to resume the upload or download. ## Syntax *Delphi Syntax* ```text property StartByte: Int64 read get_StartByte write set_StartByte; ``` ## Default Value 0 ## Remarks This property specifies the byte offset from which to resume an automatic multipart upload initiated by [CreateObject](#createobject-method-ibmstorage-component), or a download initiated by [GetObject](#getobject-method-ibmstorage-component). 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](#createobject-method-ibmstorage-component) is called. Keep this in mind when resuming interrupted object uploads. This property is not available at design time. # Timeout Property ([IBMStorage](#ibmstorage-component) Component) The timeout for the component. ## Syntax *Delphi Syntax* ```text property Timeout: Integer read get_Timeout write set_Timeout; ``` ## 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](#doevents-method-ibmstorage-component) 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 raises 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](#ibmstorage-component) Component) Determines which style request to use. ## Syntax *Delphi Syntax* ```text property UseVirtualHosting: Boolean read get_UseVirtualHosting write set_UseVirtualHosting; ``` ## 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](#ibmstorage-component) Component) The object version to make requests against. ## Syntax *Delphi Syntax* ```text property VersionId: String read get_VersionId write set_VersionId; ``` ## 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](#copyobject-method-ibmstorage-component) (to copy *from* a specific object version) - [DeleteObject](#deleteobject-method-ibmstorage-component) - [GetLink](#getlink-method-ibmstorage-component) (to build a link for a specific object version) - [GetObject](#getobject-method-ibmstorage-component) - [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) - [SendCustomRequest](#sendcustomrequest-method-ibmstorage-component) - [UpdateObjectACL](#updateobjectacl-method-ibmstorage-component) Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. This property is not available at design time. # VersionMarker Property ([IBMStorage](#ibmstorage-component) Component) A marker indicating what page of object versions to return next. ## Syntax *Delphi Syntax* ```text property VersionMarker: String read get_VersionMarker write set_VersionMarker; ``` ## Default Value '' ## Remarks This property will be populated when [ListVersions](#listversions-method-ibmstorage-component) is called if the results are paged and there are more pages. To list all object versions, continue to call [ListVersions](#listversions-method-ibmstorage-component) until this property returns empty string. Refer to [ListVersions](#listversions-method-ibmstorage-component) for more information. This property is not available at design time. # AbortMultipartUpload Method ([IBMStorage](#ibmstorage-component) Component) Aborts a multipart upload. ## Syntax *Delphi Syntax* ```text procedure AbortMultipartUpload(ObjectName: String; UploadId: String); ``` ## 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](#ibmstorage-component) Component) Adds a metadata item to the Metadata properties. ## Syntax *Delphi Syntax* ```text procedure AddMetadata(Name: String; Value: String); ``` ## Remarks This method adds a metadata item to the [Metadata](#metadata-property-ibmstorage-component) 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](#ibmstorage-component) Component) Adds a query parameter to the QueryParams properties. ## Syntax *Delphi Syntax* ```text procedure AddQueryParam(Name: String; Value: String); ``` ## Remarks This method is used to add a query parameter to the [QueryParams](#queryparams-property-ibmstorage-component) collection. *Name* specifies the name of the parameter, and *Value* specifies the value of the parameter. All specified *Value*s will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters. # BucketExists Method ([IBMStorage](#ibmstorage-component) Component) Checks whether the bucket exists. ## Syntax *Delphi Syntax* ```text function BucketExists(): Boolean; ``` ## Remarks This method checks whether the bucket specified by [Bucket](#bucket-property-ibmstorage-component) exists, returning *True* if so or *False* if not. # CheckVersioningEnabled Method ([IBMStorage](#ibmstorage-component) Component) Checks whether versioning is enabled for the currently selected bucket. ## Syntax *Delphi Syntax* ```text function CheckVersioningEnabled(): Boolean; ``` ## Remarks This method can be used to check whether the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component) has versioning enabled. Note that if [Bucket](#bucket-property-ibmstorage-component) is empty, or refers to a bucket that does not exist, this method will always return *False* when queried. Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # CompleteMultipartUpload Method ([IBMStorage](#ibmstorage-component) Component) Completes a multipart upload by assembling previously uploaded parts. ## Syntax *Delphi Syntax* ```text procedure CompleteMultipartUpload(ObjectName: String; UploadId: String); ``` ## 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](#listparts-method-ibmstorage-component) internally to obtain the information needed to complete the multipart upload. This process does not alter the [Parts](#parts-property-ibmstorage-component) collection, nor does it cause the [PartList](#partlist-event-ibmstorage-component) event to fire. # Config Method ([IBMStorage](#ibmstorage-component) Component) Sets or retrieves a configuration setting. ## Syntax *Delphi Syntax* ```text function Config(ConfigurationString: String): String; ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-ibmstorage-component) 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](#config-settings-ibmstorage-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # CopyObject Method ([IBMStorage](#ibmstorage-component) Component) Copies an object. ## Syntax *Delphi Syntax* ```text procedure CopyObject(SrcObjectName: String; DestBucket: String; DestObjectName: String); ``` ## Remarks This method copies the object specified by *SrcObjectName* (in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component)) to the object specified by *DestObjectName* in *DestBucket*. If *DestBucket* is empty, the bucket specified by [Bucket](#bucket-property-ibmstorage-component) is used as the destination bucket. If the [VersionId](#versionid-property-ibmstorage-component) 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](#metadata-property-ibmstorage-component) 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](#startmultipartupload-method-ibmstorage-component), and then use the [CopyPart](#copypart-method-ibmstorage-component) method to create parts for said multipart upload using the source object's data. # CopyPart Method ([IBMStorage](#ibmstorage-component) Component) Copies the specified object as a part of a multipart upload. ## Syntax *Delphi Syntax* ```text procedure CopyPart(SrcObjectName: String; DestBucket: String; DestObjectName: String; DestPartNumber: Integer; DestUploadId: String); ``` ## Remarks This method copies data from the object specified by *SrcObjectName* (in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component)) 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](#uploadpart-method-ibmstorage-component) method's *PartNumber* and *UploadId* parameters. To copy a specific range of bytes from the source object, set the [CopyPartRange](#CopyPartRange) configuration setting before calling this method. # CreateBucket Method ([IBMStorage](#ibmstorage-component) Component) Creates a new bucket. ## Syntax *Delphi Syntax* ```text procedure CreateBucket(); ``` ## Remarks This method creates a new bucket using the name specified by the [Bucket](#bucket-property-ibmstorage-component) property. The bucket is created in the region specified by the [Region](#region-property-ibmstorage-component) property. # CreateObject Method ([IBMStorage](#ibmstorage-component) Component) Creates a new object in the currently selected bucket. ## Syntax *Delphi Syntax* ```text procedure CreateObject(ObjectName: String); ``` ## Remarks This method creates a new object named *Object* in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). If there are any metadata items present in the [Metadata](#metadata-property-ibmstorage-component) collection, they will included in the creation request. If [SetUploadStream](#setuploadstream-method-ibmstorage-component) has been used to set an upload stream, it will take priority as the data source. If [LocalFile](#localfile-property-ibmstorage-component) is set the file will be uploaded from the specified path. If [LocalFile](#localfile-property-ibmstorage-component) is not set the data in [ObjectData](#objectdata-property-ibmstorage-component) will be used. To encrypt the file before uploading it, set [EncryptionAlgorithm](#encryptionalgorithm-property-ibmstorage-component) and [EncryptionPassword](#encryptionpassword-property-ibmstorage-component). 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](#startmultipartupload-method-ibmstorage-component). ### Automatic Multipart Uploads If more than [SimpleUploadLimit](#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](#FragmentSize) configuration setting) and uploading them individually. To accomplish this, the component automatically makes calls to [StartMultipartUpload](#startmultipartupload-method-ibmstorage-component), [UploadPart](#uploadpart-method-ibmstorage-component), and [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) internally; tracks upload state information using the [ResumableUploadState](#ResumableUploadState) configuration setting; and tracks how much data has been uploaded using the [StartByte](#startbyte-property-ibmstorage-component) property. The [FragmentComplete](#fragmentcomplete-event-ibmstorage-component) 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](#ResumableUploadState) and [StartByte](#startbyte-property-ibmstorage-component) contain the same values as they did when the upload was interrupted. When an automatic multipart upload completes successfully, [ResumableUploadState](#ResumableUploadState) is cleared and [StartByte](#startbyte-property-ibmstorage-component) is reset to *0*. # DeleteBucket Method ([IBMStorage](#ibmstorage-component) Component) Deletes a bucket. ## Syntax *Delphi Syntax* ```text procedure DeleteBucket(); ``` ## Remarks This method deletes the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). 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](#ibmstorage-component) Component) Deletes an object. ## Syntax *Delphi Syntax* ```text procedure DeleteObject(ObjectName: String); ``` ## Remarks This method deletes the object specified by *ObjectName* in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). If the [VersionId](#versionid-property-ibmstorage-component) property is non-empty, this method deletes the specified version of the object instead. ### Deleting Versioned Objects If a bucket has versioning enabled (i.e., [CheckVersioningEnabled](#checkversioningenabled-method-ibmstorage-component) returns *True* when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a *delete marker*. 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](#listversions-method-ibmstorage-component), and explicitly interacted with by setting [VersionId](#versionid-property-ibmstorage-component) 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](#versionid-property-ibmstorage-component) 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](https://docs.aws.amazon.com/AmazonS3/latest/dev/DeletingObjectVersions.html), [Working with Delete Markers](https://docs.aws.amazon.com/AmazonS3/latest/dev/DeleteMarker.html), and [Removing Delete Markers](https://docs.aws.amazon.com/AmazonS3/latest/dev/RemDelMarker.html) articles for more information. # DisableVersioning Method ([IBMStorage](#ibmstorage-component) Component) Disables versioning for the currently selected bucket. ## Syntax *Delphi Syntax* ```text procedure DisableVersioning(); ``` ## Remarks This method can be used to disable versioning for the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # DoEvents Method ([IBMStorage](#ibmstorage-component) Component) This method processes events from the internal message queue. ## Syntax *Delphi Syntax* ```text procedure DoEvents(); ``` ## 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](#ibmstorage-component) Component) Enables versioning for the currently selected bucket. ## Syntax *Delphi Syntax* ```text procedure EnableVersioning(); ``` ## Remarks This method can be used to enable versioning for the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). Refer to Amazon's [Versioning](https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html) documentation for more information about versioning. # GetBucketLocation Method ([IBMStorage](#ibmstorage-component) Component) Gets a bucket's location. ## Syntax *Delphi Syntax* ```text function GetBucketLocation(): String; ``` ## Remarks This method retrieves and returns the location (i.e., region) of the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). # GetLink Method ([IBMStorage](#ibmstorage-component) Component) Creates a link that provides access to an object for a specified amount of time. ## Syntax *Delphi Syntax* ```text function GetLink(ObjectName: String; Expires: Integer): 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](#bucket-property-ibmstorage-component). If the [VersionId](#versionid-property-ibmstorage-component) 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](#ibmstorage-component) Component) Downloads an object. ## Syntax *Delphi Syntax* ```text procedure GetObject(ObjectName: String); ``` ## Remarks This methods downloads the object specified by *ObjectName* in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). If the [VersionId](#versionid-property-ibmstorage-component) property is non-empty, the specified version of the object is downloaded instead. The [Range](#range-property-ibmstorage-component) property can be used to download a specific range of bytes from the object. If a stream has been specified using [SetDownloadStream](#setdownloadstream-method-ibmstorage-component), the object data will be sent through it. If a stream is not specified, and [LocalFile](#localfile-property-ibmstorage-component) is set, the object data will be saved to the specified location; otherwise, the object data will be held by [ObjectData](#objectdata-property-ibmstorage-component). To download and decrypt an encrypted object, set [EncryptionAlgorithm](#encryptionalgorithm-property-ibmstorage-component) and [EncryptionPassword](#encryptionpassword-property-ibmstorage-component) before calling this method. ### Download Notes In the simplest use-case, downloading an object looks like this: ```text s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name); ``` **Resuming Downloads** The component also supports resuming failed downloads by using the [StartByte](#startbyte-property-ibmstorage-component) property. If a download is interrupted, set [StartByte](#startbyte-property-ibmstorage-component) to the appropriate offset before calling this method to resume the download. ```text 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](#localfile-property-ibmstorage-component) was set in the initial download attempt. If [LocalFile](#localfile-property-ibmstorage-component) is set when beginning an encrypted download, the component creates a temporary file in [TempPath](#TempPath) to hold the encrypted data until the download is complete. If the download is interrupted, [DownloadTempFile](#DownloadTempFile) will be populated with the path of the temporary file that holds the partial data. To resume, [DownloadTempFile](#DownloadTempFile) must be populated, along with [StartByte](#startbyte-property-ibmstorage-component), 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](#localfile-property-ibmstorage-component). ```text 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](#ibmstorage-component) Component) Gets an object's information and metadata. ## Syntax *Delphi Syntax* ```text procedure GetObjectInfo(ObjectName: String); ``` ## Remarks This method gets information and metadata for the object specified by *Object* in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). If the [VersionId](#versionid-property-ibmstorage-component) property is non-empty, information and metadata for the specified version of the object is retrieved instead. Calling this method will fire the [ObjectList](#objectlist-event-ibmstorage-component) and [MetadataList](#metadatalist-event-ibmstorage-component) events, and will re-populate the [Objects](#objects-property-ibmstorage-component) and [Metadata](#metadata-property-ibmstorage-component) collection properties. # Interrupt Method ([IBMStorage](#ibmstorage-component) Component) This method interrupts the current method. ## Syntax *Delphi Syntax* ```text procedure Interrupt(); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListBuckets Method ([IBMStorage](#ibmstorage-component) Component) Lists all buckets in the account. ## Syntax *Delphi Syntax* ```text procedure ListBuckets(); ``` ## Remarks This method lists all buckets in the account. Calling this method will fire the [BucketList](#bucketlist-event-ibmstorage-component) event once for each bucket, and will also populate the [Buckets](#buckets-property-ibmstorage-component) collection. # ListMultipartUploads Method ([IBMStorage](#ibmstorage-component) Component) Lists the current multipart uploads. ## Syntax *Delphi Syntax* ```text procedure ListMultipartUploads(); ``` ## Remarks This method lists the current multipart uploads in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). Before calling this method, the [ObjectPrefix](#objectprefix-property-ibmstorage-component) property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) property can also be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-ibmstorage-component) event once for each multipart upload, and will also populate the [Objects](#objects-property-ibmstorage-component) collection. If there are still more multipart uploads available to list when this method returns, the [ObjectMarker](#objectmarker-property-ibmstorage-component) property will be populated. Continue to call this method until [ObjectMarker](#objectmarker-property-ibmstorage-component) is empty to accumulate all pages of results in the [Objects](#objects-property-ibmstorage-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Objects](#objects-property-ibmstorage-component) collection every time a page of results is returned. # ListObjects Method ([IBMStorage](#ibmstorage-component) Component) Lists the objects in a bucket. ## Syntax *Delphi Syntax* ```text procedure ListObjects(); ``` ## Remarks This method lists the objects in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). Before calling this method, the [ObjectPrefix](#objectprefix-property-ibmstorage-component) property may be set in order to restrict the results to only the objects whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) property can also be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-ibmstorage-component) event once for each object, and will also populate the [Objects](#objects-property-ibmstorage-component) collection. It may also fire the [PrefixList](#prefixlist-event-ibmstorage-component) event, and populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#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](#objectmarker-property-ibmstorage-component) property will be populated. Continue to call this method until [ObjectMarker](#objectmarker-property-ibmstorage-component) is empty to accumulate all pages of results in the [Objects](#objects-property-ibmstorage-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Objects](#objects-property-ibmstorage-component) collection every time a page of results is returned. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) and [ObjectPrefix](#objectprefix-property-ibmstorage-component) 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](#objectdelimiter-property-ibmstorage-component) set to */*, we can set [ObjectPrefix](#objectprefix-property-ibmstorage-component) to successively "deeper" values before calling ListObjects or [ListVersions](#listversions-method-ibmstorage-component) for the following effect: | [ObjectPrefix](#objectprefix-property-ibmstorage-component) Value | [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # ListParts Method ([IBMStorage](#ibmstorage-component) Component) Lists the parts in a multipart upload. ## Syntax *Delphi Syntax* ```text procedure ListParts(ObjectName: String; UploadId: String); ``` ## Remarks This method lists the parts in the multipart upload of *ObjectName* specified by *UploadId*. The [MaxParts](#MaxParts) configuration setting may be used to limit the number of results returned. Calling this method will fire the [PartList](#partlist-event-ibmstorage-component) event once for each part, and will also populate the [Parts](#parts-property-ibmstorage-component) collection. If there are still more parts available to list when this method returns, the [PartMarker](#partmarker-property-ibmstorage-component) property will be populated. Continue to call this method until [PartMarker](#partmarker-property-ibmstorage-component) is empty to accumulate all pages of results in the [Parts](#parts-property-ibmstorage-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Parts](#parts-property-ibmstorage-component) 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](#completemultipartupload-method-ibmstorage-component); the component will automatically collect the necessary information internally. Refer to [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) for more information. # ListVersions Method ([IBMStorage](#ibmstorage-component) Component) Lists the object versions in a bucket. ## Syntax *Delphi Syntax* ```text procedure ListVersions(); ``` ## Remarks This method lists the object versions in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component). Before calling this method, the [ObjectPrefix](#objectprefix-property-ibmstorage-component) property may be set in order to restrict the results to only the object versions whose names begin with a given string. The [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) property can also be used to further tune the results returned. The [MaxObjects](#MaxObjects) configuration setting may be used to limit the number of results returned. Calling this method will fire the [ObjectList](#objectlist-event-ibmstorage-component) event once for each object version, and will also populate the [Objects](#objects-property-ibmstorage-component) collection. It may also fire the [PrefixList](#prefixlist-event-ibmstorage-component) event, and populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#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](#versionmarker-property-ibmstorage-component) property will be populated. Continue to call this method until [VersionMarker](#versionmarker-property-ibmstorage-component) is empty to accumulate all pages of results in the [Objects](#objects-property-ibmstorage-component) collection. Alternatively, the [AccumulatePages](#AccumulatePages) configuration setting can be disabled to clear the [Objects](#objects-property-ibmstorage-component) collection every time a page of results is returned. ### Object Hierarchy Traversal By using the [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) and [ObjectPrefix](#objectprefix-property-ibmstorage-component) 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](#objectdelimiter-property-ibmstorage-component) set to */*, we can set [ObjectPrefix](#objectprefix-property-ibmstorage-component) to successively "deeper" values before calling [ListObjects](#listobjects-method-ibmstorage-component) or ListVersions for the following effect: | [ObjectPrefix](#objectprefix-property-ibmstorage-component) Value | [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) Value | Objects Returned | Prefixes Returned | | --- | --- | --- | --- | | (empty) | / | (none) | MyCompany/ | | MyCompany/ | / | MyCompany/ | MyCompany/Department1/ MyCompany/Department2/ | | MyCompany/Department2/ | / | MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) | # Reset Method ([IBMStorage](#ibmstorage-component) Component) Resets the component to its initial state. ## Syntax *Delphi Syntax* ```text procedure Reset(); ``` ## Remarks This method resets the component to its initial state. # ResetHeaders Method ([IBMStorage](#ibmstorage-component) Component) Resets all HTTP headers, cookies, and LocalFile. ## Syntax *Delphi Syntax* ```text procedure ResetHeaders(); ``` ## Remarks Resets all the HTTP headers as well as [LocalFile](#localfile-property-ibmstorage-component) to '' (empty string), and clears the [Metadata](#metadata-property-ibmstorage-component) and [QueryParams](#queryparams-property-ibmstorage-component) 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](#ibmstorage-component) Component) Sends a custom request to the server. ## Syntax *Delphi Syntax* ```text procedure SendCustomRequest(HttpMethod: String; ObjectName: String; RequestBody: String); ``` ## 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](#region-property-ibmstorage-component), and [UseVirtualHosting](#usevirtualhosting-property-ibmstorage-component) for the base URL. - Alternatively, if a custom URL has been specified using the [URL](#URL) configuration setting, it is used directly, and these properties are ignored. - [Bucket](#bucket-property-ibmstorage-component) (if non-empty) - *ObjectName* (if non-empty) - [VersionId](#versionid-property-ibmstorage-component) (if both it and *ObjectName* are non-empty) - [QueryParams](#queryparams-property-ibmstorage-component) 2. Adds request headers from: - [ContentDisposition](#contentdisposition-property-ibmstorage-component) - [ContentType](#contenttype-property-ibmstorage-component) - [OtherHeaders](#otherheaders-property-ibmstorage-component) - [ProductToken](#ProductToken) - [SessionToken](#SessionToken) - [UserToken](#UserToken) 3. Signs the request (unless the [SignCustomRequest](#SignCustomRequest) configuration setting is disabled). 4. Sends the request, including *RequestBody* if non-empty. 5. Stores the response headers in the [ParsedHeaders](#parsedheaders-property-ibmstorage-component) collection; and the response body in the stream specified using [SetDownloadStream](#setdownloadstream-method-ibmstorage-component), the specified [LocalFile](#localfile-property-ibmstorage-component), or [ObjectData](#objectdata-property-ibmstorage-component) (using the same logic as [GetObject](#getobject-method-ibmstorage-component)). If the response body is XML data, the [XPath](#XPath), [XText](#XText), and other **X*** configuration settings can then be used to navigate and extract information from it. # SetDownloadStream Method ([IBMStorage](#ibmstorage-component) Component) Sets the stream to which downloaded data will be written. ## Syntax *Delphi Syntax* ```text procedure SetDownloadStream(DownloadStream: TStream); ``` ## 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](#localfile-property-ibmstorage-component) to be cleared. Similarly, setting [LocalFile](#localfile-property-ibmstorage-component) to a non-empty value will discard any stream set using this method. # SetUploadStream Method ([IBMStorage](#ibmstorage-component) Component) Sets the stream from which data is read when uploading. ## Syntax *Delphi Syntax* ```text procedure SetUploadStream(UploadStream: TStream); ``` ## 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](#localfile-property-ibmstorage-component) to be cleared. Similarly, setting [LocalFile](#localfile-property-ibmstorage-component) to a non-empty value will discard any stream set using this method. # StartMultipartUpload Method ([IBMStorage](#ibmstorage-component) Component) Starts a new manual multipart upload. ## Syntax *Delphi Syntax* ```text function StartMultipartUpload(ObjectName: String): String; ``` ## Remarks This method starts a new "manual" multipart upload for an object named *ObjectName*, in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component), and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the [CreateObject](#createobject-method-ibmstorage-component) method. This upload Id can then be used to call the following methods: - [UploadPart](#uploadpart-method-ibmstorage-component) - [CopyPart](#copypart-method-ibmstorage-component) - [ListParts](#listparts-method-ibmstorage-component) - [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) - [AbortMultipartUpload](#abortmultipartupload-method-ibmstorage-component) If there are any metadata items present in the [Metadata](#metadata-property-ibmstorage-component) 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](#completemultipartupload-method-ibmstorage-component). Multipart uploads never expire, they must be explicitly completed or aborted using [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) or [AbortMultipartUpload](#abortmultipartupload-method-ibmstorage-component). The [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) method can be used to retrieve a list of current multipart uploads. # UpdateBucketACL Method ([IBMStorage](#ibmstorage-component) Component) Updates a bucket's canned access policy. ## Syntax *Delphi Syntax* ```text procedure UpdateBucketACL(); ``` ## Remarks This method updates the canned access policy of the bucket selected by [Bucket](#bucket-property-ibmstorage-component) to the value specified by [AccessPolicy](#accesspolicy-property-ibmstorage-component) # UpdateObjectACL Method ([IBMStorage](#ibmstorage-component) Component) Updates an object's canned access policy. ## Syntax *Delphi Syntax* ```text procedure UpdateObjectACL(ObjectName: String); ``` ## Remarks This method updates the caned access policy of the objects specified by *ObjectName*, in the bucket currently selected by [Bucket](#bucket-property-ibmstorage-component), to the value specified by [AccessPolicy](#accesspolicy-property-ibmstorage-component). If the [VersionId](#versionid-property-ibmstorage-component) property is non-empty, the canned access policy of the specified version of the object is updated instead. # UploadPart Method ([IBMStorage](#ibmstorage-component) Component) Uploads a multipart upload part. ## Syntax *Delphi Syntax* ```text procedure UploadPart(ObjectName: String; PartNumber: Integer; UploadId: String); ``` ## 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](#setuploadstream-method-ibmstorage-component), [LocalFile](#localfile-property-ibmstorage-component), or [ObjectData](#objectdata-property-ibmstorage-component) (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](#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](#ibmstorage-component) Component) Fires once for each bucket returned when listing buckets. ## Syntax *Delphi Syntax* ```text type TBucketListEvent = procedure ( Sender: TObject; const BucketName: String; const CreationDate: String; const OwnerId: String; const OwnerName: String ) of Object; property OnBucketList: TBucketListEvent read FOnBucketList write FOnBucketList; ``` ## Remarks This event fires once for each bucket returned when [ListBuckets](#listbuckets-method-ibmstorage-component) 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](#ibmstorage-component) Component) Fired when a document finishes transferring. ## Syntax *Delphi Syntax* ```text type TEndTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnEndTransfer: TEndTransferEvent read FOnEndTransfer write FOnEndTransfer; ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then 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](#ibmstorage-component) Component) Fired when information is available about errors during data delivery. ## Syntax *Delphi Syntax* ```text type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object; property OnError: TErrorEvent read FOnError write FOnError; ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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](#trappable-errors-ibmstorage-component) section. # FragmentComplete Event ([IBMStorage](#ibmstorage-component) Component) Fires after each part in an automatic multipart upload is complete. ## Syntax *Delphi Syntax* ```text type TFragmentCompleteEvent = procedure ( Sender: TObject; FragmentNumber: Integer; FragmentCount: Integer; var Interrupt: Boolean ) of Object; property OnFragmentComplete: TFragmentCompleteEvent read FOnFragmentComplete write FOnFragmentComplete; ``` ## Remarks If, when [CreateObject](#createobject-method-ibmstorage-component) is called, more than [SimpleUploadLimit](#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](#createobject-method-ibmstorage-component) for more information. # Header Event ([IBMStorage](#ibmstorage-component) Component) Fired every time a header line comes in. ## Syntax *Delphi Syntax* ```text type THeaderEvent = procedure ( Sender: TObject; const Field: String; const Value: String ) of Object; property OnHeader: THeaderEvent read FOnHeader write FOnHeader; ``` ## 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](#ibmstorage-component) Component) Fired once for each log message. ## Syntax *Delphi Syntax* ```text type TLogEvent = procedure ( Sender: TObject; LogLevel: Integer; const Message: String; const LogType: String ) of Object; property OnLog: TLogEvent read FOnLog write FOnLog; ``` ## Remarks This event is fired once for each log message generated by the component. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | 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](#ibmstorage-component) Component) Fires once for each metadata item returned when object information and metadata is retrieved. ## Syntax *Delphi Syntax* ```text type TMetadataListEvent = procedure ( Sender: TObject; const Name: String; const Value: String ) of Object; property OnMetadataList: TMetadataListEvent read FOnMetadataList write FOnMetadataList; ``` ## Remarks This event fires once for each metadata item returned when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) 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](#ibmstorage-component) Component) Fires once for each object, object version, or multipart upload returned when listing such items. ## Syntax *Delphi Syntax* ```text type TObjectListEvent = procedure ( Sender: TObject; const BucketName: String; const ObjectName: String; const LastModified: String; Size: Int64; const ETag: String; const OwnerId: String; const OwnerName: String; const UploadId: String; const VersionId: String; LatestVersion: Boolean; Deleted: Boolean ) of Object; property OnObjectList: TObjectListEvent read FOnObjectList write FOnObjectList; ``` ## Remarks This event fires once for each object, object version, or multipart upload returned when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component), [ListObjects](#listobjects-method-ibmstorage-component), [ListVersions](#listversions-method-ibmstorage-component), or [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) 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](#listmultipartuploads-method-ibmstorage-component) is called. *Size* reflects the size, in bytes, of the object. Not applicable when [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) is called. *ETag* reflects the object's ETag. Not applicable when [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) is called. *OwnerId* and *OwnerName* reflect the Id and display name of the object's owner, respectively. Not applicable when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) is called. *UploadId* reflects the Id of the multipart upload. Only applicable when [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component) is called. *VersionId* reflects the Id of the object version (note that the string *null* is a valid version Id). Only applicable when [ListVersions](#listversions-method-ibmstorage-component) is called, or when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) is called while [VersionId](#versionid-property-ibmstorage-component) is non-empty; empty in all other cases. *LatestVersion* indicates whether this is the latest object version. Only applicable when [ListVersions](#listversions-method-ibmstorage-component) is called; *True* in all other cases. *Deleted* indicates whether this object version is a delete marker (refer to [DeleteObject](#deleteobject-method-ibmstorage-component) for more information). Only applicable when [ListVersions](#listversions-method-ibmstorage-component) is called, or when [GetObjectInfo](#getobjectinfo-method-ibmstorage-component) is called while [VersionId](#versionid-property-ibmstorage-component) is non-empty; *False* in all other cases. # PartList Event ([IBMStorage](#ibmstorage-component) Component) Fires once for every part returned when listing a multipart upload's parts. ## Syntax *Delphi Syntax* ```text type TPartListEvent = procedure ( Sender: TObject; PartNumber: Integer; const ObjectName: String; const LastModified: String; Size: Int64; const ETag: String; const OwnerId: String; const OwnerName: String ) of Object; property OnPartList: TPartListEvent read FOnPartList write FOnPartList; ``` ## Remarks This event fires once for each multipart upload part returned when [ListParts](#listparts-method-ibmstorage-component) 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](#ibmstorage-component) Component) Fires once for each common prefix returned when listing objects. ## Syntax *Delphi Syntax* ```text type TPrefixListEvent = procedure ( Sender: TObject; const BucketName: String; const Prefix: String ) of Object; property OnPrefixList: TPrefixListEvent read FOnPrefixList write FOnPrefixList; ``` ## Remarks This event fires once for each common prefix returned when [ListObjects](#listobjects-method-ibmstorage-component) or [ListVersions](#listversions-method-ibmstorage-component) is called when [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) is non-empty. Refer to [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) for more information. *BucketName* reflects the name of the bucket that the prefix is in. *Prefix* is the common prefix. # Progress Event ([IBMStorage](#ibmstorage-component) Component) Fires during an upload or download to indicate transfer progress. ## Syntax *Delphi Syntax* ```text type TProgressEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; TotalBytes: Int64; PercentDone: Integer ) of Object; property OnProgress: TProgressEvent read FOnProgress write FOnProgress; ``` ## 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](#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](#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](#ibmstorage-component) Component) Fired after the server presents its certificate to the client. ## Syntax *Delphi Syntax* ```text type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; const CertEncoded: String; const CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object; property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication; ``` ## 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](#ibmstorage-component) Component) Fired when secure connection progress messages are available. ## Syntax *Delphi Syntax* ```text type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object; property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus; ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([IBMStorage](#ibmstorage-component) Component) Fired when a document starts transferring (after the headers). ## Syntax *Delphi Syntax* ```text type TStartTransferEvent = procedure ( Sender: TObject; Direction: Integer ) of Object; property OnStartTransfer: TStartTransferEvent read FOnStartTransfer write FOnStartTransfer; ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then 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](#ibmstorage-component) Component) Fired while a document transfers (delivers document). ## Syntax *Delphi Syntax* ```text type TTransferEvent = procedure ( Sender: TObject; Direction: Integer; BytesTransferred: Int64; PercentDone: Integer; const Text: String; const TextB: TBytes ) of Object; property OnTransfer: TTransferEvent read FOnTransfer write FOnTransfer; ``` ## 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. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [Encoded](#Certificate_f_Encoded) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [Subject](#Certificate_f_Subject) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *TBytes* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) properties also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *Boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *Integer (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *TBytes* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) property denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) property to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **StoreType** *TcsCertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The component supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the component will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr component by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *Integer (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) property for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". ## Constructors > *Delphi Syntax* ```text constructor Create(); ``` Creates a instance whose properties can be set. > *Delphi Syntax* ```text constructor Create(valEncoded: TBytes); ``` Parses * Encoded * as an X.509 public key. > *Delphi Syntax* ```text constructor Create(valStoreType: TcsCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. > *Delphi Syntax* ```text constructor Create(valStoreType: TcsCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # 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](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **FirewallType** *TcsFirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. **Port** *Integer* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) property for details. NOTE: This property is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) property for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this property and the [Password](#Firewall_f_Password) property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the component raises an exception. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` # 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](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value). The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *String* *Default Value: ""* This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *String* *Default Value: ""* This property contains the [Header](#header-type) contents. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valField: String; valValue: 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](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *TcsProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are set, the component will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *Boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *False*. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. **Port** *Integer* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) property for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) property is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *TcsProxySSLTypes* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) properties are used to authenticate through NTLM negotiation. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valServer: String; valPort: Integer); ``` *Delphi Syntax* ```text constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String); ``` # QueryParam Type A query parameter to send in the request. ## Remarks This type represents a query parameter to send in the request. The following fields are available: - [Name](#QueryParam_f_Name) - [Value](#QueryParam_f_Value) ## Fields **Name** *String* *Default Value: ""* The name of the query parameter. This property specifies the name of the query parameter. **Value** *String* *Default Value: ""* The value of the query parameter. This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # S3Bucket Type This type represents a bucket. ## Remarks This type represents a bucket. The following fields are available: - [CreationDate](#S3Bucket_f_CreationDate) - [Name](#S3Bucket_f_Name) - [OwnerDisplayName](#S3Bucket_f_OwnerDisplayName) - [OwnerId](#S3Bucket_f_OwnerId) ## Fields **CreationDate** *String (read-only)* *Default Value: ""* The property includes the creation date of the bucket. This property reflects the creation date of the bucket. **Name** *String (read-only)* *Default Value: ""* The property contains the name of the bucket. This property reflects the name of the bucket. **OwnerDisplayName** *String (read-only)* *Default Value: ""* The property contains the display name of the bucket's owner. This property reflects the display name of the bucket's owner. **OwnerId** *String (read-only)* *Default Value: ""* The property contains the Id of the bucket's owner. This property reflects the Id of the bucket's owner. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valCreationDate: String; valOwnerId: String; valOwnerDisplayName: String); ``` # S3Metadata Type This type represents Amazon's Simple Storage Service (S3) metadata item. ## Remarks This type represents an S3 metadata item. The following fields are available: - [Name](#S3Metadata_f_Name) - [Value](#S3Metadata_f_Value) ## Fields **Name** *String* *Default Value: ""* The property contains the name of the metadata item. This property specifies the name of the metadata item. The server stores metadata names in lowercase. NOTE: The component will automatically prepend the service-appropriate prefix (e.g., *x-amz-meta-*, *x-goog-meta-*) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated. **Value** *String* *Default Value: ""* This property contains the value of the metadata item. This property specifies the value of the metadata item. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valValue: String); ``` # S3Object Type This type represents an object. ## Remarks This type represents an object. The following fields are available: - [Deleted](#S3Object_f_Deleted) - [ETag](#S3Object_f_ETag) - [LastModified](#S3Object_f_LastModified) - [LatestVersion](#S3Object_f_LatestVersion) - [Name](#S3Object_f_Name) - [OwnerDisplayName](#S3Object_f_OwnerDisplayName) - [OwnerId](#S3Object_f_OwnerId) - [Size](#S3Object_f_Size) - [StorageClass](#S3Object_f_StorageClass) - [UploadId](#S3Object_f_UploadId) - [VersionId](#S3Object_f_VersionId) ## Fields **Deleted** *Boolean (read-only)* *Default Value: False* This property specifies whether this object version is a delete marker. This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information. This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; *False* in all other cases. **ETag** *String (read-only)* *Default Value: ""* This property contains the ETag of the object. This property reflects the ETag of the object. An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified. This is not applicable when ListMultipartUploads is called. **LastModified** *String (read-only)* *Default Value: ""* This property contains the last modified time of the object. This property reflects the last modified time of the object. This is not applicable when ListMultipartUploads is called. **LatestVersion** *Boolean (read-only)* *Default Value: True* This property specifies whether this is the latest object version. This property indicates whether this object version is the latest version available. This is applicable only when ListVersions is called.; *True* in all other cases. **Name** *String (read-only)* *Default Value: ""* This property contains the name (key) of the object. This property reflects the name (key) of the object. **OwnerDisplayName** *String (read-only)* *Default Value: ""* This property contains the display name of the object's owner. This property reflects the display name of the object's owner. This is not applicable when GetObjectInfo is called. **OwnerId** *String (read-only)* *Default Value: ""* This property contains the Id of the object's owner. This property reflects the Id of the object's owner. This is not applicable when GetObjectInfo is called. **Size** *Int64 (read-only)* *Default Value: 0* This property contains the size of the object. This property reflects the size of the object in bytes. This is not applicable when ListMultipartUploads is called. **StorageClass** *String (read-only)* *Default Value: ""* This property contains the storage class of the object. This property reflects the storage class of the object. **UploadId** *String (read-only)* *Default Value: ""* This property contains the upload Id of the multipart upload. This property reflects the upload Id of the multipart upload. It is applicable only when ListMultipartUploads is called. **VersionId** *String (read-only)* *Default Value: ""* This property contains the Id of the object version. This property reflects the Id of the object version. NOTE: The string *null* is a valid version Id. This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valName: String; valLastModified: String; valSize: Int64; valStorageClass: String; valETag: String; valOwnerId: String; valOwnerDisplayName: String; valUploadId: String); ``` # S3Part Type This type represents a multipart upload part. ## Remarks This type represents a multipart upload part. The following fields are available: - [ETag](#S3Part_f_ETag) - [LastModified](#S3Part_f_LastModified) - [ObjectName](#S3Part_f_ObjectName) - [OwnerDisplayName](#S3Part_f_OwnerDisplayName) - [OwnerId](#S3Part_f_OwnerId) - [PartNumber](#S3Part_f_PartNumber) - [Size](#S3Part_f_Size) ## Fields **ETag** *String (read-only)* *Default Value: ""* This property contains the ETag of the part. This property reflects the ETag of the part. **LastModified** *String (read-only)* *Default Value: ""* This property contains the last modified time of the part. This property reflects the last modified time of the part. **ObjectName** *String (read-only)* *Default Value: ""* This property contains the name (key) of the object that the part was uploaded for. This property reflects the name (key) of the object that the part was uploaded for. **OwnerDisplayName** *String (read-only)* *Default Value: ""* This property contains the display name of the part's owner. This property reflects the display name of the part's owner. **OwnerId** *String (read-only)* *Default Value: ""* This property contains the Id of the part's owner. This property reflects the Id of the part's owner. **PartNumber** *Integer (read-only)* *Default Value: 0* This property contains the number of the part. This property reflects the number of the part. **Size** *Int64 (read-only)* *Default Value: 0* This property contains the size of the part. This property reflects the size of the part in bytes. ## Constructors *Delphi Syntax* ```text constructor Create(); ``` *Delphi Syntax* ```text constructor Create(valPartNumber: Integer; valObjectName: String; valLastModified: String; valSize: Int64; valETag: String; valOwnerId: String; valOwnerDisplayName: String); ``` # Config Settings ([IBMStorage](#ibmstorage-component) Component) The component accepts one or more of the following *configuration settings*. Configuration 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](#config-method-ibmstorage-component) method. ### IBMStorage Config Settings **AccumulatePages**: Whether the component should accumulate subsequent pages of results when listing them.This setting controls how the component behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties. **AssumeRoleARN**: Amazon Resource Name used when assuming a role for authentication.The Amazon Resource Name that will be assumed by the component. Must be set along side [AssumeRoleSessionName](#AssumeRoleSessionName). **AssumeRoleDuration**: The duration for role session in seconds.The duration of the role session in seconds. The minimum is 900 seconds (15 minutes) and the maximum is 43200 (12 hours). As a note, the maximum value may be lower based on restriction placed by the role administrator. If the duration is outside of the range the request will fail. This setting is optional but [AssumeRoleARN](#AssumeRoleARN) and [AssumeRoleSessionName](#AssumeRoleSessionName) are required for assuming a role. **AssumeRoleSessionName**: Unique name for current role session.The unique session name to identify a session within a role. Must be set along side [AssumeRoleARN](#AssumeRoleARN). **AutoDetectSigningRegion**: Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process.When set to *True* (default) the component will automatically try to extract the region from the base URL. When set to *False* the region provided in the [Region](#region-property-ibmstorage-component) property will be used in the signed header for the HMAC signature. **AWSProfile**: The name of the AWS CLI profile that the component should use to obtain authentication and region information.This setting, if non-empty, must contain the name of the AWS CLI profile whose authentication and (optionally) region information the component should use to communicate with the server. To use the default profile, set this setting to *default*. Refer to the following pages of the AWS CLI documentation for more information about AWS profiles, and the *credentials* and *config* files used to store them: - [Configuration and Credential File Settings](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html) - [Named Profiles](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html) - [Using an IAM Role](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html) The component supports key-based credential profiles; i.e., those which include the *aws_access_key_id*, *aws_secret_access_key*, and (optionally) *aws_session_token* elements. Role-based profiles are not supported at this time. In addition to the authentication-related elements mentioned above, the component also supports the *region* element, if it is present in the specified profile. The component searches for the specified profile's information in the *credentials* and *config* files. The [AWSProfileDir](#AWSProfileDir) setting can be used to configure the directory where the component looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur. Note: If the profile specified using this setting includes credential information, the [UseEC2RoleCredentials](#UseEC2RoleCredentials) setting will be ignored (if it is enabled). **AWSProfileDir**: The location of the AWS CLI credentials and config files.This setting specifies the directory that the component should check when attempting to locate the AWS CLI *credentials* and *config* files. This setting is only used if the [AWSProfile](#AWSProfile) setting is non-empty. By default, this setting is empty, which will cause the component to check the default location used by the AWS CLI: an *.aws* directory in the current user's home directory; i.e., *%UserProfile%\.aws* (Windows) or *~/.aws* (Linux/macOS). **ContentRange**: This contains the range of bytes of the current object that are being returned.When implementing chunked and resumable object downloads by setting the [Range](#range-property-ibmstorage-component) property, this configuration will contain the returned range of bytes and the total count of bytes for the specified object. This configuration will be populated after a call to [GetObject](#getobject-method-ibmstorage-component) **CopyPartRange**: Specifies the range of bytes to copy when calling CopyPart.This setting optionally specifies the range of bytes to copy from the source object when calling [CopyPart](#copypart-method-ibmstorage-component). By default the entire object is copied as the new part. When set, this setting dictates the 0-based range of bytes to copy in the format *[first]-[last]*. For example: *2048-4096*. **DownloadTempFile**: The temporary file used when downloading encrypted data.This setting specifies the temporary file used when downloading encrypted data. When downloading encrypted data with [LocalFile](#localfile-property-ibmstorage-component) set, the component will automatically create a temporary file at [TempPath](#TempPath) to hold the encrypted file contents. When the download is complete, the data is decrypted to [LocalFile](#localfile-property-ibmstorage-component). If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details. **EncodeSlashInObjectName**: Whether or not to encode slashes in an object name.When set to *True* (default) the component will URL encode any slashes in an object name when signing a request. This is what Amazon's S3 service expects. Other S3 clones may vary slightly from this rule, requiring that slashes are not encoded. Set this to *False* to accommodate. **EncryptionIV**: The initialization vector to be used for encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the component will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-ibmstorage-component). This setting accepts a hex encoded value. **EncryptionKey**: The key to use during encryption/decryption.When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the component will derive this value automatically from [EncryptionPassword](#encryptionpassword-property-ibmstorage-component). This setting accepts a hex encoded value. **EncryptionPasswordKDF**: The KDF algorithm to use during password based encryption and decryption.This setting specified the Key Derivation Function (KDF) used to derive a key from the specified [EncryptionPassword](#encryptionpassword-property-ibmstorage-component). Possible values are: - 0 (default) - PBKDF1 - 1 - PBKDF2 Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used. **EnforceBucketNameRestrictions**: Whether or not to enforce bucket naming conventions.When set to *False* (default) the component will not enforce the bucket naming restrictions. US based buckets are not subject to the same name restrictions as other locations. When set to *True* the component will enforce the following restrictions: - Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes. - Bucket names must start with a number or letter. - Bucket names must be between 3 and 63 characters long. - Bucket names should not end with a dash. - Bucket names cannot contain two adjacent periods. - Bucket names cannot contain dashes next to periods. - Bucket names must not be formatted as an IP address (eg: 192.168.5.4). **ETag**: The ETag for the object returned by the server.This contains the ETag for the object returned after [GetObject](#getobject-method-ibmstorage-component), [CreateObject](#createobject-method-ibmstorage-component) or [CompleteMultipartUpload](#completemultipartupload-method-ibmstorage-component) is called. The [ETag](#ETag) is used to determine if the object has changed since the last operation on the file. Set the [IfMatch](#IfMatch) config to the [ETag](#ETag) to ensure a new version of the object does not already exist on the server. **FragmentSize**: The part size to use when uploading a new object.If, when [CreateObject](#createobject-method-ibmstorage-component) is called, more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data are present, the component will automatically split the upload data up into parts and perform a multipart upload. This setting specifies the part size to use. Valid values are *5242880* (5MB) to *2147483647* (2GB). The default is *26214400* (25MB). Note that applications may need to increase this setting's value in order to upload very large objects; Amazon only allows 10000 parts to be uploaded for any given multipart upload. If the amount of upload data provided when creating an object is less than [SimpleUploadLimit](#SimpleUploadLimit) bytes, it will be uploaded directly, so this setting will not apply. **IfMatch**: Check to make sure the object has not been modified since the last request.When implementing chunked and resumable object downloads, the [IfMatch](#IfMatch) config is used to determine if the object has changed since the last chunk was downloaded. Set the [IfMatch](#IfMatch) config to the [ETag](#ETag) of the previous request to tell the component to make sure the object has not changed before a call to [GetObject](#getobject-method-ibmstorage-component). **IncludeContentMD5**: Whether an MD5 digest of a custom request's data should be included.If set to *True*, the component will include an MD5 digest of the *RequestBody* passed to [SendCustomRequest](#sendcustomrequest-method-ibmstorage-component) when the request is submitted. The default value is *False*. Note that this setting is only applicable if the [SignCustomRequest](#SignCustomRequest) setting is *True*; it is ignored otherwise. **IncludeObjectMD5**: Whether an MD5 digest of a object's data should be included.If set to *True*, the component will include an MD5 digest of an object's data when it is created using [CreateObject](#createobject-method-ibmstorage-component). (If the component performs an automatic multipart upload, MD5 digests of the individual parts' data will be sent instead, even if [IncludePartMD5](#IncludePartMD5) is *False*.) The default value is *False*. **IncludePartMD5**: Whether an MD5 digest of a part's data should be included.If set to *True*, the component will include an MD5 digest of a part's data when it is uploaded using [UploadPart](#uploadpart-method-ibmstorage-component). The default value is *False*. **MaskSensitiveData**: Whether sensitive data is masked in the Log event.This setting controls whether sensitive information is masked when the [Log](#log-event-ibmstorage-component) event fires. For instance, the Authorization header in the request contains the Access Key Id. The default value is *True*. **MaxObjects**: The maximum number of results to return when listing objects.This setting specifies the maximum number of results that should be returned by a call to [ListObjects](#listobjects-method-ibmstorage-component) or [ListMultipartUploads](#listmultipartuploads-method-ibmstorage-component). If this setting is *-1* (default), the server's default (*1000*) is used. Acceptable values are *1* to *1000* (inclusive). **MaxParts**: The maximum number of results to return when listing parts.This setting specifies the maximum number of results that should be returned by a call to [ListParts](#listparts-method-ibmstorage-component). If this setting is *-1* (default), the server's default (*1000*) is used. Acceptable values are *1* to *1000* (inclusive). **Prefix[i]**: The i'th common prefix returned.When [StorePrefixList](#StorePrefixList) is enabled, this setting can be used to retrieve the common prefixes returned by the most recent [ListObjects](#listobjects-method-ibmstorage-component) request. Refer to that method, as well as the [ObjectDelimiter](#objectdelimiter-property-ibmstorage-component) property, for more information. Valid values for *i* are from *0* to *([PrefixCount](#PrefixCount) - 1)*. **PrefixCount**: The number of common prefixes returned.When [StorePrefixList](#StorePrefixList) is enabled, this setting reflects the number of common prefixes returned by the most recent [ListObjects](#listobjects-method-ibmstorage-component) request. This setting is always *-1* when [StorePrefixList](#StorePrefixList) is disabled. **ProgressAbsolute**: Whether the component should track transfer progress absolutely.This setting controls whether the component tracks upload and download progress absolutely or relatively, with regards to the values reported via the [Progress](#progress-event-ibmstorage-component) event when an interrupted transfer is resumed. If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the [Progress](#progress-event-ibmstorage-component) event will account for the data that was successfully transferred before the interruption. If this setting is disabled, then the component will treat resumed transfers as "new" transfers, and the values reported by the [Progress](#progress-event-ibmstorage-component) event will start at *0* rather than from the number of bytes already transferred. Refer to the [Progress](#progress-event-ibmstorage-component) event for more information. **ProgressStep**: How often the progress event should be fired, in terms of percentage.This setting controls how often the component will fire the [Progress](#progress-event-ibmstorage-component) event during an upload or download, in terms of percentage. Valid values are *0* to *99*, inclusive. The default value, *1*, will cause the [Progress](#progress-event-ibmstorage-component) event to fire each time the event's *PercentDone* parameter value increases by one percent. Setting this setting to *0* will cause the [Progress](#progress-event-ibmstorage-component) event to fire *every* time data is transferred. Note that the [Progress](#progress-event-ibmstorage-component) event will *always* fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if *PercentDone* cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the component will behave as if this setting were *0* for the duration of the transfer. **RawRequest**: Returns the data that was sent to the server.This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes. **RawResponse**: Returns the data that was received from the server.This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes. **ResponseCacheControl**: Sets the Cache-Control header of the response.If specified, this determines the *Cache-Control* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResponseContentDisposition**: Sets the Content-Disposition header of the response.If specified, this determines the *Content-Disposition* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResponseContentEncoding**: Sets the Content-Encoding header of the response.If specified, this determines the *Content-Encoding* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResponseContentLanguage**: Sets the Content-Language header of the response.If specified, this determines the *Content-Language* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResponseContentType**: Sets the Content-Type header of the response.If specified, this determines the *Content-Type* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResponseExpires**: Sets the Expires header of the response.If specified, this determines the *Expires* header returned by the server. Note that this is only applicable when calling [GetLink](#getlink-method-ibmstorage-component). **ResumableUploadState**: Tracks upload state information during an automatic multipart upload.If, when [CreateObject](#createobject-method-ibmstorage-component) is called, more than [SimpleUploadLimit](#SimpleUploadLimit) bytes of upload data are present, the component will automatically split the upload data up into parts and perform a multipart upload. This setting keeps track of upload state information needed to resume the upload if it's interrupted. Refer to [CreateObject](#createobject-method-ibmstorage-component) for more information. **SessionToken**: The session token to send in the request when using temporary credentials.When using temporary credentials, AWS requires you to send the session token provided with the temporary access and secret key in every request. **SignCustomRequest**: Tells the component to sign the outgoing request.By default, this configuration is *True*, and when [SendCustomRequest](#sendcustomrequest-method-ibmstorage-component) is called the component will sign the specified request to authenticate with the service. If set to *False*, the request will be sent as is, without signing. **SigningTime**: A custom date to send to the component to use while signing all requests.The SigningTime config can be used to send a custom value for the signature date that is used while signing all requests. This is often used if a machine has not been patched or is sending incorrect date values while attempting to connect. This value must be provided as a traditional Unix timestamp. A Unix timestamp is the number of seconds since the Unix Epoch (00:00:00 January 1, 1970 UTC). An example value for the timestamp would be *1236626334*. **SimpleUploadLimit**: The maximum data size the component should attempt to upload directly when creating an object.When [CreateObject](#createobject-method-ibmstorage-component) is called, the component will automatically split the upload data into parts and perform a multipart upload if its size is greater than the amount specified by this setting. If the upload data size is less than or equal to the amount specified by this setting, it will be uploaded directly in the object creation request. Valid values are *-1* to *5368709120* (5GB), inclusive. The default is *104857600* (100MB). If this setting is set to *0*, the component will *always* perform a multipart upload when creating an object; if it is set to *-1*, the component will *never* perform a multipart upload. **StorageClass**: Specifies the storage class to be used for newly-created buckets.This setting specifies the storage class to use for newly-create buckets; it is used when constructing [CreateBucket](#createbucket-method-ibmstorage-component) requests. By default, this setting is empty, causing new buckets to be created with the *standard* storage class. Setting it to a different storage class (e.g., *smart*) will cause newly-created buckets to use the specified storage class instead. Refer to IBM Cloud's Object Storage documentation for more information. **StoreObjectData**: Whether component stores object data or not.This configuration setting can be used to instruct the component whether or not to create a local copy of the data to upload when setting the [ObjectData](#objectdata-property-ibmstorage-component) property. When set to *False*, the component will store the data address and length only. This cuts down on the memory usage of the component when uploading files. The default value for this setting is *True*. **StorePrefixList**: Whether to store the common prefixes returned when listing objects.If this setting is enabled, the component will populate the [PrefixCount](#PrefixCount) and [Prefix\[i\]](#Prefix[i]) settings anytime [ListObjects](#listobjects-method-ibmstorage-component) is called. By default, this setting is disabled. **TempPath**: The path to the directory where temporary files are created.This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to [DownloadTempFile](#DownloadTempFile) and DownloadFile for more information. **URL**: If set, the default URL will be overridden by this value.By default, the component uses the service's URL. Setting this config will override this value. **UseEC2RoleCredentials**: Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.When the component is running within an Amazon EC2 instance, this setting can be set to authenticate requests using the IAM role attached to the instance using temporary credentials obtained from the instance metadata service. The IMDSv2 protocol is used by default. Please see the [IMDSVersion](#IMDSVersion) configuration setting for more information. In order for the component to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "[Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)" page in the Amazon IAM documentation for more information. By default, this setting is *False*. When set to *True* the component will do the following before each request: 1. Make a request against the EC2 instance to get the name of the role attached to it. 2. Make a request against the metadata service to initiate a session. The request returns a token that must be included in subsequent requests. 3. Parse the response, automatically populating the [AccessKey](#accesskey-property-ibmstorage-component) and [SecretKey](#secretkey-property-ibmstorage-component) properties and the [SessionToken](#SessionToken) configuration setting. 4. Execute the original request using the temporary security credentials that were acquired. Note: This setting is ignored if the [AWSProfile](#AWSProfile) setting is set to a profile that includes credential information. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the component adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The component only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms. When True, the component adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to [LocalFile](#localfile-property-ibmstorage-component). When set to True, downloaded data will be appended to [LocalFile](#localfile-property-ibmstorage-component). This may be used in conjunction with [Range](#range-property-ibmstorage-component) to resume a failed download. This is applicable only when [LocalFile](#localfile-property-ibmstorage-component) is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form 'Basic [encoded-user-password]'. **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-ibmstorage-component) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the component.If set to True, the URL passed to the component will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the component will perform a GET on the new location.The default value is False. If set to True, the component will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the component.This property specifies the HTTP version used by the component. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *True*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *False*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-ibmstorage-component) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | 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). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-ibmstorage-component) is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*'#13#10'*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the component beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by components that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by components that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the component.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. When *True* (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use [Timeout](#timeout-property-ibmstorage-component) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the component whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by components that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the component raises an exception. NOTE: This setting is provided for use by components that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-ibmstorage-component) setting 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 value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. If the component is connected, the [LocalHost](#localhost-property-ibmstorage-component) setting 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). **LocalPort**: The port in the local host where the component binds. This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the component will use IPv4 exclusively. When set to *1*, the component will use IPv6 exclusively. To instruct the component to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-ibmstorage-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the component will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the component is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-ibmstorage-component) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component raises an exception. When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component raises an exception. When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-ibmstorage-component) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the component will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the component will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-ibmstorage-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-ibmstorage-component) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the component when the [SSLProvider](#sslprovider-property-ibmstorage-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-ibmstorage-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ibmstorage-component) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ibmstorage-component) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ibmstorage-component) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-ibmstorage-component) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-ibmstorage-component) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **UseFIPSCompliantAPI**: Tells the component whether or not to use FIPS certified APIs.When set to *True*, the component will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *True*. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the component will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the component to use the internal implementation instead of using the system security libraries. This setting is set to *False* by default on all platforms. # Trappable Errors ([IBMStorage](#ibmstorage-component) Component) ### Common Errors | | | | --- | --- | | 600 | A server error occurred, and/or the component was unable to process the server's response. Please refer to the error message for more information. | | 601 | An unsupported operation or action was attempted. | | 602 | The [RawRequest](#RawRequest) or [RawResponse](#RawResponse) configuration setting was queried without first setting the TransferredRequest configuration setting to ON. | | 603 | The login credentials specified were invalid. Please refer to the error message for more information. | | 604 | An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified. | | 605 | An invalid index was specified. | | 606 | An upload was aborted by the user before it could finish. | | 607 | The specified resource is a folder and cannot be downloaded. | | 608 | A download failed because the specified [LocalFile](#localfile-property-ibmstorage-component) already exists and [Overwrite](#overwrite-property-ibmstorage-component) is False. | | 609 | The component could not resume a download or upload. Please refer to the error message for more information. | | 610 | An encrypted download could not be resumed because the [DownloadTempFile](#DownloadTempFile) configuration setting is not set. | | 611 | An exception occurred while working with the specified [LocalFile](#localfile-property-ibmstorage-component) (or the current value of [LocalFile](#localfile-property-ibmstorage-component) is invalid). Please refer to the error message for more information. | | 612 | An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information. | The component may also return one of the following error codes, which are inherited from other components. ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | The component may also return one of the following error codes, which are inherited from other components. ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-ibmstorage-component) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the component is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |