S3 Class
Properties Methods Events Config Settings Errors
The S3 class provides an easy-to-use interface for Amazon S3 and other S3-compatible services.
Syntax
ipworks.S3
Remarks
The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using Secure Sockets Layer/Transport Layer Security (TLS/SSL). S3-like services allow you to store arbitrary data objects in various buckets and to access them from anywhere with an internet connection.
A brief synopsis follows, but please refer to Amazon's S3 documentation for more information about the general capabilities of S3.
S3 supports the following providers:
- Amazon S3
- Backblaze B2
- Cloudflare R2
- Digital Ocean Spaces
- Google Cloud Storage
- IBM Cloud Object Storage
- Linode Object Storage
- Oort DSS
- Oracle Cloud Object Storage
- Seagate Lyve Cloud
- Wasabi
- And more!
A "custom provider" option also allows you to interact with any S3-compatible API by specifying its base URL.
Getting Started
To begin, use the ServiceProvider property to select the S3 service provider to use. Then, use the AccessKey and SecretKey properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider.
Working with Buckets
S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account:
- Creating and deleting buckets: CreateBucket and DeleteBucket
- Checking whether a bucket exists, and its location: BucketExists and GetBucketLocation
- Listing buckets: ListBuckets
- Updating a bucket's canned ACL: UpdateBucketACL
Working with Objects
Once the desired buckets are ready, the following methods can be used to interact with objects:
- Creating, downloading, and deleting objects: CreateObject, GetObject, DeleteObject
- Copying objects: CopyObject
- Listing objects, or getting information about a single object: ListObjects, GetObjectInfo
- Updating an object's canned ACL: UpdateObjectACL
Working with Multipart Uploads
For S3 providers that support them, multipart uploads make it possible to upload very large objects in multiple parts.
- Starting, completing, and aborting multipart uploads: StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload
- Listing multipart uploads: ListMultipartUploads
- Uploading and copying parts: UploadPart, CopyPart
- Listing parts: ListParts
Cloudflare R2 Notes
The Cloudflare R2 service provider possesses the following unique requirements and characteristics:
- In addition to needing an AccessKey and SecretKey, a CloudflareAccountID is also required to work with this provider.
- The Region property is automatically set to "auto" when this service provider is selected, which is the only valid value.
- ListParts is not supported natively by Cloudflare R2, which means that the behavior of CompleteMultipartUpload changes when using this provider. Instead, calling UploadPart or CopyPart populates the LastPartInfo and PartInfo[i] configuration settings. CompleteMultipartUpload will then use the values in PartInfo[i] to complete the multipart upload.
Other Features
The S3 class also supports a variety of other features, including the following:
- Versioning support
- Object metadata manipulation
- Presigned link generation
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccessKey | This property includes the access key to use for authentication. |
AccessPolicy | This property includes the canned access policy to apply to a bucket or object. |
Bucket | This property selects a bucket. |
Buckets | This property includes the collection of buckets. |
ContentDisposition | This property includes content disposition to send for an object. |
ContentType | This property includes the content type to send for an object. |
EncryptionAlgorithm | This property includes the encryption algorithm. |
EncryptionPassword | This property includes the encryption password. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | This property determines what happens when the server issues a redirect. |
Idle | The current status of the class. |
LocalFile | This property includes the location of the local file. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Metadata | This property includes a collection of metadata items. |
ObjectData | This property includes the data that were downloaded or that should be uploaded. |
ObjectDelimiter | This property includes the delimiter string to use when listing objects. |
ObjectMarker | This property includes a marker indicating what page of objects to return next. |
ObjectPrefix | This property includes a prefix used to restrict the results returned when listing objects. |
Objects | This property includes a collection of objects. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | This property determines if local files are overwritten. |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
PartMarker | This property includes a marker indicating what page of parts to return next. |
Parts | This property includes a collection of multipart upload parts. |
Proxy | A set of properties related to proxy access. |
QueryParams | This property includes the additional query parameters to be included in the request. |
Range | This property includes the range of bytes to request. |
Region | This property includes the region the class will make requests against. |
SecretKey | This property includes the secret key to use for authentication. |
ServiceProvider | This property includes the S3 service provider to use. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
StartByte | This property includes the byte offset from which to resume the upload or download. |
Timeout | A timeout for the class. |
UseSSL | This method includes whether to use SSL/TLS when connecting. |
UseVirtualHosting | This property determines which URL style to use when making requests. |
VersionId | This property includes the object version to make requests against. |
VersioningEnabled | This property includes controls whether versioning is enabled for the currently selected bucket. |
VersionMarker | This property includes a marker indicating what page of object versions to return next. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AbortMultipartUpload | This method aborts a multipart upload. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | This method adds a query parameter to the QueryParams properties. |
AppendObject | This method appends data to the end of the existing object specified by ObjectName . |
BucketExists | This method checks whether the bucket exists. |
CheckVersioningEnabled | This method checks whether versioning is enabled for the currently selected bucket. |
CompleteMultipartUpload | This method completes a multipart upload by assembling previously uploaded parts. |
Config | Sets or retrieves a configuration setting. |
CopyObject | This method copies an object. |
CopyPart | This method copies the specified object as a part of a multipart upload. |
CreateBucket | This method creates a new bucket. |
CreateObject | This method creates a new object in the currently selected bucket. |
DeleteBucket | This method deletes a bucket. |
DeleteObject | This method deletes an object. |
DisableVersioning | This method disables versioning for the currently selected bucket. |
DoEvents | Processes events from the internal message queue. |
EnableVersioning | This method enables versioning for the currently selected bucket. |
GetBucketLocation | This method gets a bucket's location. |
GetLink | This method creates a link that provides access to an object for a specified amount of time. |
GetObject | This method downloads an object. |
GetObjectInfo | This method gets an object's information and metadata. |
Interrupt | Interrupt the current method. |
ListBuckets | This method lists all buckets in the account. |
ListMultipartUploads | This method lists the current multipart uploads. |
ListObjects | This method lists the objects in a bucket. |
ListParts | This method lists the parts in a multipart upload. |
ListVersions | This method lists the object versions in a bucket. |
Reset | This method resets the class to its initial state. |
ResetHeaders | This method resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | This method sends a custom request to the server. |
SetDownloadStream | This method sets the stream to which downloaded data will be written. |
SetUploadStream | This method sets the stream from which data are read when uploading. |
StartMultipartUpload | This method starts a new manual multipart upload. |
UpdateBucketACL | This method updates a bucket's canned access policy. |
UpdateObjectACL | This method updates an object's canned access policy. |
UploadPart | This method uploads a multipart upload part. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BucketList | This event fires once for each bucket returned when listing buckets. |
EndTransfer | This event fires when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
FragmentComplete | This event fires after each part in an automatic multipart upload is complete. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
MetadataList | This event fires once for each metadata item returned when object information and metadata are retrieved. |
ObjectList | This event fires once for each object, object version, or multipart upload returned when listing such items. |
PartList | This event fires once for every part returned when listing a multipart upload's parts. |
PrefixList | This event fires once for each common prefix returned when listing objects. |
Progress | This event fires during an upload or download to indicate transfer progress. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
ADFSAuthScheme | The authentication scheme to use with the ADFS STS endpoint. |
ADFSPassword | The password to use if the auth scheme is set to NTLM. |
ADFSRelyingParty | The endpoint to request the SAML Response from. |
ADFSSTSEndpoint | The endpoint to request the SAML Response from. |
ADFSUser | The username to use if the auth scheme is set to NTLM. |
AssumeRoleARN | Amazon Resource Name used when assuming a role for authentication. |
AssumeRoleDuration | The duration for role session in seconds. |
AssumeRolePrincipalARN | The Amazon Resource Name of the SAML provider. |
AssumeRoleSessionName | Unique name for current role session. |
AutoDetectSigningRegion | Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. |
AWSProfile | The name of the AWS CLI profile that the class should use to obtain authentication and region information. |
AWSProfileDir | The location of the AWS CLI credentials and config files. |
CloudflareAccountID | The Cloudflare R2 account ID to use. |
ContentRange | This contains the range of bytes of the current object that are being returned. |
CopyPartRange | Specifies the range of bytes to copy when calling CopyPart. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncodeSlashInObjectName | Whether or not to encode slashes in an object name. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
EnforceBucketNameRestrictions | Whether or not to enforce bucket naming conventions. |
ETag | The ETag for the object returned by the server. |
ForceDeleteNonEmptyBuckets | Forces buckets to be deleted even if they aren't empty. |
FragmentSize | The part size to use when uploading a new object. |
GoogleProjectId | The Google project Id to send when using OAuth 2.0 to authenticate to Google Storage. |
IfMatch | Check to make sure the object has not been modified since the last request. |
IMDSv2SessionTokenDuration | The maximum duration of the session token. |
IMDSVersion | The version of Instance Metadata Service to use when accessing role credentials. |
IncludeContentMD5 | Whether an MD5 digest of a custom request's data should be included. |
IncludeObjectMD5 | Whether an MD5 digest of a object's data should be included. |
IncludePartMD5 | Whether an MD5 digest of a part's data should be included. |
LastPartInfo | The part number and part ETag of the last CopyPart or UploadPart request. |
MaskSensitive | Whether sensitive data is masked in the Log event. |
MaxObjects | The maximum number of results to return when listing objects. |
MaxParts | The maximum number of results to return when listing parts. |
OAuthAuthorization | The OAuth 2.0 authorization token to use to authenticate to Google Storage. |
OracleNamespace | The Oracle Cloud Object Storage namespace to use. |
PartInfo[i] | The i'th part number and part ETag corresponding to a part of a multipart upload. |
PartInfoCount | The number of items in the PartInfo collection. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixes returned. |
ProgressAbsolute | Whether the class should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
ResponseCacheControl | Sets the Cache-Control header of the response. |
ResponseContentDisposition | Sets the Content-Disposition header of the response. |
ResponseContentEncoding | Sets the Content-Encoding header of the response. |
ResponseContentLanguage | Sets the Content-Language header of the response. |
ResponseContentType | Sets the Content-Type header of the response. |
ResponseExpires | Sets the Expires header of the response. |
ResumableUploadState | Tracks upload state information during an automatic multipart upload. |
SendObjectACLs | Whether to include object-level ACL headers when making requests. |
ServiceProviderURL | The base URL to use when communicating with a service provider. |
SessionToken | The session token to send in the request when using temporary credentials. |
SignatureVersion | The signature version standard to use in all API requests. |
SignCustomRequest | Tells the class to sign the outgoing request. |
SigningTime | A custom date to send to the class to use while signing all requests. |
SimpleUploadLimit | The maximum data size the class should attempt to upload directly when creating an object. |
StorageClass | Specifies the storage class to be used for the uploaded object. |
StorePrefixList | Whether to store the common prefixes returned when listing objects. |
TempPath | The path to the directory where temporary files are created. |
UseEC2RoleCredentials | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (S3 Class)
This property includes the access key to use for authentication.
Syntax
public String getAccessKey(); public void setAccessKey(String accessKey);
Default Value
""
Remarks
This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations that connect to the server.
AccessPolicy Property (S3 Class)
This property includes the canned access policy to apply to a bucket or object.
Syntax
public int getAccessPolicy(); public void setAccessPolicy(int accessPolicy); Enumerated values: public final static int ptPrivate = 0; public final static int ptPublicRead = 1; public final static int ptPublicReadWrite = 2; public final static int ptAuthenticatedRead = 3; public final static int ptBucketOwnerRead = 4; public final static int ptBucketOwnerFullControl = 5; public final static int ptNone = 6;
Default Value
0
Remarks
This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:
- CopyObject (for the destination object)
- CreateBucket
- CreateObject
- StartMultipartUpload
- UpdateBucketACL
- UpdateObjectACL
The valid values are as follows:
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) | Applicable only to objects. Object owner gets full control. Bucket owner gets read access. |
ptBucketOwnerFullControl (5) | Applicable only to objects. Both object and bucket owner get full control. |
ptNone (6) | Instructs the class to not explicitly set a canned access policy for a bucket or object. |
Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or they have additional restrictions. Refer to the provider's documentation for more information.
Bucket Property (S3 Class)
This property selects a bucket.
Syntax
public String getBucket(); public void setBucket(String bucket);
Default Value
""
Remarks
This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.
Buckets Property (S3 Class)
This property includes the collection of buckets.
Syntax
public S3BucketList getBuckets();
Remarks
This collection holds a list of S3Bucket items.
Calling ListBuckets will populate this collection.
This property is read-only and not available at design time.
Please refer to the S3Bucket type for a complete list of fields.ContentDisposition Property (S3 Class)
This property includes content disposition to send for an object.
Syntax
public String getContentDisposition(); public void setContentDisposition(String contentDisposition);
Default Value
""
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server any time the object is downloaded.
This property is not available at design time.
ContentType Property (S3 Class)
This property includes the content type to send for an object.
Syntax
public String getContentType(); public void setContentType(String contentType);
Default Value
""
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server any time the object is downloaded.
This property is not available at design time.
EncryptionAlgorithm Property (S3 Class)
This property includes the encryption algorithm.
Syntax
public int getEncryptionAlgorithm(); public void setEncryptionAlgorithm(int encryptionAlgorithm); Enumerated values: public final static int eaAES = 0; public final static int eaBlowfish = 1; public final static int eaCAST = 2; public final static int eaDES = 3; public final static int eaIDEA = 4; public final static int eaRC2 = 5; public final static int eaRC4 = 6; public final static int eaTEA = 7; public final static int eaTripleDES = 8; public final static int eaTwofish = 9; public final static int eaRijndael = 10; public final static int eaChaCha = 11; public final static int eaXSalsa20 = 12;
Default Value
0
Remarks
This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are as follows:
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 (S3 Class)
This property includes the encryption password.
Syntax
public String getEncryptionPassword(); public void setEncryptionPassword(String encryptionPassword);
Default Value
""
Remarks
If this property is populated when CreateObject or GetObject is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.
The class uses the specified value 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.
It is also possible, however, to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, for example, the data need to be encrypted or decrypted by another utility that generates Key and IV values differently.
This property is not available at design time.
Firewall Property (S3 Class)
A set of properties related to firewall access.
Syntax
public Firewall getFirewall(); public void setFirewall(Firewall firewall);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Please refer to the Firewall type for a complete list of fields.FollowRedirects Property (S3 Class)
This property determines what happens when the server issues a redirect.
Syntax
public int getFollowRedirects(); public void setFollowRedirects(int followRedirects); Enumerated values: public final static int frNever = 0; public final static int frAlways = 1; public final static int frSameScheme = 2;
Default Value
0
Remarks
This property specifies how the class should behave when the server returns a redirect response (e.g., "Object Moved"). Valid values are as follows:
frNever (0) (default) | Redirects are never followed; the class throws 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 class throws an exception. |
Idle Property (S3 Class)
The current status of the class.
Syntax
public boolean isIdle();
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
LocalFile Property (S3 Class)
This property includes the location of the local file.
Syntax
public String getLocalFile(); public void setLocalFile(String localFile);
Default Value
""
Remarks
This property specifies the location of a file on a disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.
Note: Setting this property to a nonempty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.
LocalHost Property (S3 Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
public String getLocalHost(); public void setLocalHost(String localHost);
Default Value
""
Remarks
The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class 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 multi-homed 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 (S3 Class)
This property includes a collection of metadata items.
Syntax
public S3MetadataList getMetadata(); public void setMetadata(S3MetadataList metadata);
Remarks
This collection holds a list of S3Metadata items.
This collection is populated when GetObjectInfo is called; and its items are used any time CreateObject, CopyObject, or StartMultipartUpload is called.
This property is not available at design time.
Please refer to the S3Metadata type for a complete list of fields.ObjectData Property (S3 Class)
This property includes the data that were downloaded or that should be uploaded.
Syntax
public byte[] getObjectData(); public void setObjectData(byte[] objectData);
Default Value
""
Remarks
This property is populated with object data after calling GetObject if SetDownloadStream and LocalFile are not set.
This property also can be set before calling CreateObject or UploadPart; its data will be uploaded if SetUploadStream and LocalFile are not set.
This property is not available at design time.
ObjectDelimiter Property (S3 Class)
This property includes the delimiter string to use when listing objects.
Syntax
public String getObjectDelimiter(); public void setObjectDelimiter(String objectDelimiter);
Default Value
""
Remarks
If this property is nonempty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a common prefix element, which is returned in place of the individual objects.
The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class also will populate the PrefixCount and Prefix[i] configuration settings.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix 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 (S3 Class)
This property includes a marker indicating what page of objects to return next.
Syntax
public String getObjectMarker(); public void setObjectMarker(String objectMarker);
Default Value
""
Remarks
This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns an empty string.
Refer to ListObjects for more information.
Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.
This property is not available at design time.
ObjectPrefix Property (S3 Class)
This property includes a prefix used to restrict the results returned when listing objects.
Syntax
public String getObjectPrefix(); public void setObjectPrefix(String objectPrefix);
Default Value
""
Remarks
This property, if nonempty, is used to restrict the results returned by ListObjects (or ListVersions) to only those objects (or object versions) whose names begin with the given value.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix 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.
Objects Property (S3 Class)
This property includes a collection of objects.
Syntax
public S3ObjectList getObjects();
Remarks
This collection holds a list of S3Object items.
Calling GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads will populate this collection.
This property is read-only and not available at design time.
Please refer to the S3Object type for a complete list of fields.OtherHeaders Property (S3 Class)
This property includes other headers as determined by the user (optional).
Syntax
public String getOtherHeaders(); public void setOtherHeaders(String 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 and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
This property is not available at design time.
Overwrite Property (S3 Class)
This property determines if local files are overwritten.
Syntax
public boolean isOverwrite(); public void setOverwrite(boolean overwrite);
Default Value
False
Remarks
This property controls whether local files are overwritten when calling GetObject. It is applicable only to local files. The default value is false.
ParsedHeaders Property (S3 Class)
This property includes a collection of headers returned from the last request.
Syntax
public HeaderList getParsedHeaders();
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
This collection is indexed from 0 to size -1.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.PartMarker Property (S3 Class)
This property includes a marker indicating what page of parts to return next.
Syntax
public String getPartMarker(); public void setPartMarker(String partMarker);
Default Value
""
Remarks
This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.
Refer to ListParts for more information.
Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them. Also, this property is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
This property is not available at design time.
Parts Property (S3 Class)
This property includes a collection of multipart upload parts.
Syntax
public S3PartList getParts();
Remarks
This collection holds a list of S3Part items.
Calling ListParts will populate this collection.
Note: This property is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
This property is read-only and not available at design time.
Please refer to the S3Part type for a complete list of fields.Proxy Property (S3 Class)
A set of properties related to proxy access.
Syntax
public Proxy getProxy(); public void setProxy(Proxy proxy);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
Please refer to the Proxy type for a complete list of fields.QueryParams Property (S3 Class)
This property includes the additional query parameters to be included in the request.
Syntax
public S3QueryParamList getQueryParams(); public void setQueryParams(S3QueryParamList queryParams);
Remarks
This is a collection of query parameters that will be added to the request. Parameters can be added using the AddQueryParam method.
Please refer to the S3QueryParam type for a complete list of fields.Range Property (S3 Class)
This property includes the range of bytes to request.
Syntax
public String getRange(); public void setRange(String range);
Default Value
""
Remarks
This property specifies the range of bytes to request from the server. If this property is nonempty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.
Following are the two valid formats for this property's value:
- StartByte-
- StartByte-EndByte
Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is nonempty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously downloaded data at the start of the specified range are not downloaded again when the download is resumed.
This property is not available at design time.
Region Property (S3 Class)
This property includes the region the class will make requests against.
Syntax
public String getRegion(); public void setRegion(String region);
Default Value
"us-east-1"
Remarks
This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.
Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime ServiceProvider changes. The custom service provider's "default region" is an empty string (i.e., setting ServiceProvider to spCustom (255) will clear this property).
Note: When the custom service provider is selected, the class uses the base URL specified by the ServiceProviderURL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value any time it generates a request URL. Refer to the ServiceProviderURL setting's documentation for more information.
Amazon S3 Regions
Value | Region |
us-east-1 (Default) | US East (Northern Virginia) |
us-east-2 | US East (Ohio) |
us-west-1 | US West (Northern California) |
us-west-2 | US West (Oregon) |
ap-east-1 | Asia Pacific (Hong Kong) |
ap-northeast-1 | Asia Pacific (Tokyo) |
ap-northeast-2 | Asia Pacific (Seoul) |
ap-northeast-3 | Asia Pacific (Osaka-Local) |
ap-south-1 | Asia Pacific (Mumbai) |
ap-southeast-1 | Asia Pacific (Singapore) |
ap-southeast-2 | Asia Pacific (Sydney) |
ca-central-1 | Canada (Central) |
cn-north-1 | China (Beijing) |
cn-northwest-1 | China (Ningxia) |
eu-central-1 | Europe (Frankfurt) |
eu-north-1 | Europe (Stockholm) |
eu-south-1 | Europe (Milan) |
eu-west-1 | Europe (Ireland) |
eu-west-2 | Europe (London) |
eu-west-3 | Europe (Paris) |
me-south-1 | Middle East (Bahrain) |
sa-east-1 | South America (Sao Paulo) |
Alibaba Cloud Object Storage Regions
Value | Region |
oss-ap-northeast-1 | Japan (Tokyo) |
oss-ap-south-1 | India (Mumbai) |
oss-ap-southeast-1 | Singapore |
oss-ap-southeast-2 | Australia (Sydney) |
oss-ap-southeast-3 | Malaysia (Kuala Lumpur) |
oss-ap-southeast-5 | Indonesia (Jakarta) |
oss-cn-beijing (default) | China (Beijing) |
oss-cn-chengdu | China (Chengdu) |
oss-cn-hangzhou | China (Hangzhou) |
oss-cn-heyuan | China (Heyuan) |
oss-cn-hongkong | China (Hong Kong) |
oss-cn-huhehaote | China (Hohhot) |
oss-cn-qingdao | China (Qingdao) |
oss-cn-shanghai | China (Shanghai) |
oss-cn-shenzhen | China (Shenzhen) |
oss-cn-zhangjiakou | China (Zhangjiakou) |
oss-eu-central-1 | Germany (Frankfurt) |
oss-eu-west-1 | UK (London) |
oss-me-east-1 | UAE (Dubai) |
oss-us-east-1 | US (Virginia) |
oss-us-west-1 | US (Silicon Valley) |
Backblaze B2 Regions
All Backblaze B2 region strings take the form us-west-###, where ### is a three-digit number. By default, the class uses us-west-000.
To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value, which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.
Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a nonmaster application key if necessary.
Cloudflare R2 Regions
By default, the class uses auto. This is the only valid value for this service provider.
Digital Ocean Spaces Regions
Value | Region |
ams2 | Amsterdam 2 |
ams3 | Amsterdam 3 |
blr1 | Bangalore 1 |
fra1 | Frankfurt 1 |
lon1 | London 1 |
nyc1 | New York 1 |
nyc2 | New York 2 |
nyc3 (Default) | New York 3 |
sfo1 | San Francisco 1 |
sfo2 | San Francisco 2 |
sgp1 | Singapore 1 |
tor1 | Toronto 1 |
Google Cloud Storage Regions
Value | Region |
us* (Default) | Multiple U.S. data centers |
us-central1 | US Central (Iowa) |
us-east1 | US East (South Carolina) |
us-east4 | US East (Northern Virginia) |
us-west1 | US West (Oregon) |
us-west2 | US West (Los Angeles) |
asia* | Multiple Asia data centers |
asia-east1 | Asia East (Taiwan) |
asia-east2 | Asia East (Hong Kong) |
asia-northeast1 | Asia Northeast (Tokyo) |
asia-south1 | Asia South (Mumbai) |
asia-southeast1 | Asia Southeast (Singapore) |
australia-southeast1 | Australia Southeast (Sydney) |
eu* | Multiple EU data centers |
europe-north1 | Europe North (Finland) |
europe-west1 | Europe West (Belgium) |
europe-west2 | Europe West (London) |
europe-west3 | Europe West (Frankfurt) |
europe-west4 | Europe West (Netherlands) |
northamerica-northeast1 | Canada (Montreal) |
southamerica-east1 | Brazil (Sao Paulo) |
Huawei Cloud Object Storage Regions
Value | Region |
af-south-1 | Johannesburg |
ap-southeast-1 | Hong Kong |
ap-southeast-2 | Bangkok |
ap-southeast-3 | Singapore |
cn-east-2 | Shanghai |
cn-east-3 | Shanghai |
cn-north-1 (default) | Beijing |
cn-north-4 | Beijing |
cn-south-1 | Guangzhou |
la-south-2 | Santiago |
na-mexico-1 | Mexico City |
sa-argentina-1 | Buenos Aires |
sa-brazil-1 | Sao Paulo |
sa-chile-1 | Santiago |
sa-peru-1 | Lima |
IBM Cloud Object Storage 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 oint) |
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: Optionally, private. or direct. may be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.
Linode Object Storage Regions
Value | Region |
us-east-1 (default) | US East (Newark) |
eu-central-1 | EU Central (Frankfurt) |
Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following nonstandard behaviors:
- Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
- The ListBuckets method will return only those buckets located in the currently selected region; there is no way to retrieve a list of all regions' buckets.
- Similarly, the BucketExists and GetBucketLocation methods consider only those buckets located in the currently selected region.
- The CopyObject method cannot be used to copy objects to a bucket in another region.
Oracle Cloud Object Storage Regions
Value | Region |
Commercial Cloud Regions | |
ap-hyderabad-1 | India South (Hyderabad) |
ap-melbourne-1 | Australia Southeast (Melbourne) |
ap-mumbai-1 | India West (Mumbai) |
ap-osaka-1 | Japan Central (Osaka) |
ap-seoul-1 | South Korea Central (Seoul) |
ap-sydney-1 | Australia East (Sydney) |
ap-tokyo-1 | Japan East (Tokyo) |
ca-montreal-1 | Canada Southeast (Montreal) |
ca-toronto-1 | Canada Southeast (Toronto) |
eu-amsterdam-1 | Netherlands Northwest (Amsterdam) |
eu-frankfurt-1 | Germany Central (Frankfurt) |
eu-zurich-1 | Switzerland North (Zurich) |
me-jeddah-1 | Saudi Arabia West (Jeddah) |
sa-saopaulo-1 | Brazil East (Sao Paulo) |
uk-london-1 | UK South (London) |
us-ashburn-1 (default) | US East (Ashburn, Virginia) |
us-phoenix-1 | US West (Phoenix, Arizona) |
US Gov FedRAMP High Regions | |
us-langley-1 | US Gov East (Ashburn, Virginia) |
us-luke-1 | US Gov West (Phoenix, Arizona) |
US Gov DISA IL5 Regions | |
us-gov-ashburn-1 | US DoD East (Ashburn, Virginia) |
us-gov-chicago-1 | US DoD North (Chicago, Illinois) |
us-gov-phoenix-1 | US DoD West (Phoenix, Arizona) |
Wasabi Regions
Value | Region |
eu-central-1 | Europe (Amsterdam) |
us-east-1 (Default) | US East (Ashburn, Virginia) |
us-east-2 | US East (Manassas, Virginia) |
us-west-1 | US West (Hillsboro, Oregon) |
The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently selected ServiceProvider.
SecretKey Property (S3 Class)
This property includes the secret key to use for authentication.
Syntax
public String getSecretKey(); public void setSecretKey(String secretKey);
Default Value
""
Remarks
This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations that connect to the server.
ServiceProvider Property (S3 Class)
This property includes the S3 service provider to use.
Syntax
public int getServiceProvider(); public void setServiceProvider(int serviceProvider); Enumerated values: public final static int spAmazonS3 = 0; public final static int spDigitalOcean = 1; public final static int spGoogleStorage = 2; public final static int spWasabi = 3; public final static int spBackblazeB2 = 4; public final static int spHuawei = 5; public final static int spAlibaba = 6; public final static int spIBM = 7; public final static int spOracle = 8; public final static int spLinode = 9; public final static int spCloudflareR2 = 10; public final static int spSeagateLyveCloud = 11; public final static int spOortDSS = 12; public final static int spCustom = 255;
Default Value
0
Remarks
This property specifies the S3 service provider that the class should use. Possible values are as follows:
spAmazonS3 (0) (default) | Amazon S3 |
spDigitalOcean (1) | Digital Ocean Spaces |
spGoogleStorage (2) | Google Cloud Storage |
spWasabi (3) | Wasabi |
spBackblazeB2 (4) | Backblaze B2 |
spHuawei (5) | Huawei Cloud Object Storage |
spAlibaba (6) | Alibaba Cloud Object Storage |
spIBM (7) | IBM Cloud Object Storage |
spOracle (8) | Oracle Cloud Object Storage |
spLinode (9) | Linode Object Storage |
spCloudflareR2 (10) | Cloudflare R2 |
spSeagateLyveCloud (11) | Seagate Lyve Cloud |
spOortDSS (12) | Oort DSS |
spCustom (255) | Custom service provider |
Note: The following providers require additional configuration before requests can be made:
- spOracle (8): An Object Storage Namespace must be specified using the OracleNamespace configuration setting.
- spCloudflareR2 (10): An Account ID must be specified using the CloudflareAccountID configuration setting.
- spCustom (255): A base URL must be specified using the ServiceProviderURL configuration setting.
Changing this property will automatically result in the following actions:
- Set the Region property to the default region for the provider (empty string for spCustom (255)).
- Reset the UseSSL property to true.
- Reset the StartByte property to 0.
- Clear the ObjectMarker, PartMarker, and VersionMarker properties, as well as the StorageClass and ResumableUploadState configuration settings.
This property is not available at design time.
SSLAcceptServerCert Property (S3 Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class 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.
Please note that this functionality is provided only for cases where 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 type for a complete list of fields.SSLCert Property (S3 Class)
The certificate to be used during SSL negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (S3 Class)
This specifies the SSL/TLS implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.
SSLServerCert Property (S3 Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
SSLServerCert 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 type for a complete list of fields.StartByte Property (S3 Class)
This property includes the byte offset from which to resume the upload or download.
Syntax
public long getStartByte(); public void setStartByte(long startByte);
Default Value
0
Remarks
This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.
When uploading from a stream, the class will always seek forward in the stream if the value of StartByte is greater than 0 when CreateObject is called. Keep this in mind when resuming interrupted object uploads.
Note: This property is automatically reset to 0 anytime ServiceProvider changes.
This property is not available at design time.
Timeout Property (S3 Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int 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 class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If Timeout expires, and the operation is not yet complete, the class throws an exception.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
UseSSL Property (S3 Class)
This method includes whether to use SSL/TLS when connecting.
Syntax
public boolean isUseSSL(); public void setUseSSL(boolean useSSL);
Default Value
True
Remarks
This property specifies whether the class should use Secure Sockets Layer/Transport Layer Security (SSL/TLS) when connecting.
Note: This property is automatically reset to true any time ServiceProvider changes. The class will ignore any attempts to change this property if one of the following providers is selected, because they require SSL/TLS to be used:
- spDigitalOcean (1)
- spBackblazeB2 (4)
- spOracle (8)
- spSeagateLyveCloud (11)
This property is not available at design time.
UseVirtualHosting Property (S3 Class)
This property determines which URL style to use when making requests.
Syntax
public boolean isUseVirtualHosting(); public void setUseVirtualHosting(boolean useVirtualHosting);
Default Value
True
Remarks
If true (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject.
Note: Hosted-style URLs impose more bucket name restrictions because of DNS server naming restrictions. Refer to Amazon's documentation for more information.
If false, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.
Note: When using the spAmazonS3 (0) service provider, keep in mind that Amazon has publicly announced that buckets created after September 30, 2020, will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020, will continue to support both URL styles.
Note: This property is ignored when ServiceProvider is set to one of the following:
- spAlibaba (6) Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
- spOracle (8) Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.
- spOortDSS (12) Oort DSS does not support virtual-hosted-style URLs, only path-style URLs.
This property is not available at design time.
VersionId Property (S3 Class)
This property includes the object version to make requests against.
Syntax
public String getVersionId(); public void setVersionId(String versionId);
Default Value
""
Remarks
This property can be set to the Id of a specific object version before calling the following methods to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:
- CopyObject (to copy from a specific object version)
- DeleteObject
- GetLink (to build a link for a specific object version)
- GetObject
- GetObjectInfo
- SendCustomRequest
- UpdateObjectACL
Refer to Amazon's Versioning documentation for more information about versioning.
This property is not available at design time.
VersioningEnabled Property (S3 Class)
This property includes controls whether versioning is enabled for the currently selected bucket.
Syntax
public boolean isVersioningEnabled(); public void setVersioningEnabled(boolean versioningEnabled);
Default Value
False
Remarks
This property can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.
Note: If Bucket is empty, or refers to a bucket that does not exist, this property will always return false when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all.
Refer to Amazon's Versioning documentation for more information about versioning.
Note: When ServiceProvider is spBackblazeB2 (4), this property will always return true (assuming Bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.
This property is not available at design time.
VersionMarker Property (S3 Class)
This property includes a marker indicating what page of object versions to return next.
Syntax
public String getVersionMarker(); public void setVersionMarker(String versionMarker);
Default Value
""
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.
This property is not available at design time.
AbortMultipartUpload Method (S3 Class)
This method aborts a multipart upload.
Syntax
public void abortMultipartUpload(String objectName, String uploadId);
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: If any part of the upload is currently in progress, it may be necessary to call this method again after the upload is complete.
If this method is called successfully, the specified UploadId will no longer be valid.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
AddMetadata Method (S3 Class)
Adds a metadata item to the Metadata properties.
Syntax
public void addMetadata(String name, String value);
Remarks
This method adds a metadata item to the Metadata collection. Name specifies the name of the item, and Value specifies the value of the item. The server stores metadata names in lowercase.
If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-), it will be stripped off. The class will take care of prepending it when sending metadata to the server.
AddQueryParam Method (S3 Class)
This method adds a query parameter to the QueryParams properties.
Syntax
public void addQueryParam(String name, String value);
Remarks
This method is used to add a query parameter to the QueryParams collection. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.
AppendObject Method (S3 Class)
This method appends data to the end of the existing object specified by ObjectName .
Syntax
public void appendObject(String objectName);
Remarks
The data to upload are taken from either the stream set using SetUploadStream or ObjectData (whichever data are found first, when checked in that order).
BucketExists Method (S3 Class)
This method checks whether the bucket exists.
Syntax
public boolean bucketExists();
Remarks
This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.
Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.
CheckVersioningEnabled Method (S3 Class)
This method checks whether versioning is enabled for the currently selected bucket.
Syntax
public boolean checkVersioningEnabled();
Remarks
This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.
Note: If Bucket is empty, or refers to a bucket that does not exist, this property will always return false when queried, and any attempts to set it will fail. This behavior also occurs if the currently selected service provider does not support versioning at all.
Refer to Amazon's Versioning documentation for more information about versioning.
Note: When ServiceProvider is spBackblazeB2 (4), this property will always return true (assuming Bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.
CompleteMultipartUpload Method (S3 Class)
This method completes a multipart upload by assembling previously uploaded parts.
Syntax
public void completeMultipartUpload(String objectName, String uploadId);
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: This method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts collection, nor does it cause the PartList event to fire. The spCloudflareR2 (10) ServiceProvider does not support the ListParts S3 operation; thus, when that provider is selected, this method instead relies on the part information contained in the PartInfo[i] configuration setting.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Config Method (S3 Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CopyObject Method (S3 Class)
This method copies an object.
Syntax
public void copyObject(String srcObjectName, String destBucket, String destObjectName);
Remarks
This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.
If the VersionId property is nonempty, 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 any metadata items are present in the Metadata collection, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.
Notes:
- Objects may be copied only to buckets that exist within the same region.
- Objects larger than 5 GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload. Then use the CopyPart method to create parts for that multipart upload using the source object's data.
CopyPart Method (S3 Class)
This method copies the specified object as a part of a multipart upload.
Syntax
public void copyPart(String srcObjectName, String destBucket, String destObjectName, int destPartNumber, String destUploadId);
Remarks
This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.
The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.
To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
CreateBucket Method (S3 Class)
This method creates a new bucket.
Syntax
public void createBucket();
Remarks
This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.
CreateObject Method (S3 Class)
This method creates a new object in the currently selected bucket.
Syntax
public void createObject(String objectName);
Remarks
This method creates a new object named Object in the bucket currently selected by Bucket. If any metadata items are present in the Metadata collection, they will be included in the creation request.
If SetUploadStream has been used to set an upload stream, it will take priority as the data source. If LocalFile is set, the file will be uploaded from the specified path. If LocalFile is not set, the data in ObjectData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
This method can automatically handle the multipart upload of objects (see below). If it is desired to manually take control of the multipart upload process, see StartMultipartUpload.
Automatic Multipart Uploads
If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks the upload state information using the ResumableUploadState configuration setting; and tracks how much data have been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.
If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.
When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.
Note: Automatic multipart uploads are not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
DeleteBucket Method (S3 Class)
This method deletes a bucket.
Syntax
public void deleteBucket();
Remarks
This method deletes the bucket currently selected by Bucket.
Note: For some service providers, 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. Refer to the provider's documentation for more information.
DeleteObject Method (S3 Class)
This method deletes an object.
Syntax
public void deleteObject(String objectName);
Remarks
This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.
If the VersionId property is nonempty, this method deletes the specified version of the object instead.
Deleting Versioned Objects
If a bucket has versioning enabled (i.e., VersioningEnabled 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 did not exist (i.e., it does not appear when listing objects or it cannot be downloaded). If, however, all of the previous versions of the object (including the one that existed just before the delete marker was created) still exist, then they can be listed using ListVersions and explicitly can be interacted with by setting VersionId and calling an appropriate method.
To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.
Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.
DisableVersioning Method (S3 Class)
This method disables versioning for the currently selected bucket.
Syntax
public void disableVersioning();
Remarks
This method can be used to disable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
DoEvents Method (S3 Class)
Processes events from the internal message queue.
Syntax
public void doEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
EnableVersioning Method (S3 Class)
This method enables versioning for the currently selected bucket.
Syntax
public void enableVersioning();
Remarks
This method can be used to enable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
GetBucketLocation Method (S3 Class)
This method gets a bucket's location.
Syntax
public String getBucketLocation();
Remarks
This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.
Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.
GetLink Method (S3 Class)
This method creates a link that provides access to an object for a specified amount of time.
Syntax
public String getLink(String objectName, int expires);
Remarks
This method creates and returns a preauthenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is nonempty, 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: This method is an offline method that simply generates a presigned URL; no communication with the server takes place.
Note: This method is not supported when ServiceProvider is set to one of the following:
- spGoogleStorage (2)
- spOracle (8)
GetObject Method (S3 Class)
This method downloads an object.
Syntax
public void getObject(String objectName);
Remarks
This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is nonempty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.
If a stream has been specified using SetDownloadStream, the object data will be sent through it. If a stream is not specified, and LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.
To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading an object looks like this:
s3.LocalFile = "../MyData.zip";
s3.GetObject(s3.Objects[0].Name);
Example 1. Resuming Downloads:
The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyData.zip";
s3.LocalFile = downloadFile;
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded file
s3.StartByte = new FileInfo(downloadFile).Length;
s3.GetObject(s3.Objects[0].Name);
Example 2. Resuming Encrypted File Downloads:
Resuming encrypted file downloads is supported only when LocalFile has been set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data are downloaded, it will be decrypted and written to LocalFile.
s3.LocalFile = "../MyData.zip";
s3.EncryptionPassword = "password";
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length;
s3.GetObject(s3.Objects[0].Name);
GetObjectInfo Method (S3 Class)
This method gets an object's information and metadata.
Syntax
public void getObjectInfo(String objectName);
Remarks
This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is nonempty, information and metadata for the specified version of the object is retrieved instead.
Calling this method will fire the ObjectList and MetadataList events and also will repopulate the Objects and Metadata collection properties.
Interrupt Method (S3 Class)
Interrupt the current method.
Syntax
public void interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListBuckets Method (S3 Class)
This method lists all buckets in the account.
Syntax
public void listBuckets();
Remarks
This method lists all buckets in the account.
Calling this method will fire the BucketList event once for each bucket and also will populate the Buckets collection.
Note: When ServiceProvider is spLinode (9), this method returns only buckets located in the currently selected Region, and it is not possible to retrieve a list of all regions' buckets. Refer to the Linode section of the Region property's documentation for more information.
ListMultipartUploads Method (S3 Class)
This method lists the current multipart uploads.
Syntax
public void listMultipartUploads();
Remarks
This method lists the current multipart uploads in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each multipart upload and also will populate the Objects collection.
If more multipart uploads are still available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all of the pages of results in the Objects collection.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Note: This method is not supported when ServiceProvider is spOortDSS (12).
Note: When the ServiceProvider is spSeagateLyveCloud (11) the ObjectPrefix property must be specified.
ListObjects Method (S3 Class)
This method lists the objects in a bucket.
Syntax
public void listObjects();
Remarks
This method lists the objects in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set to restrict the results to only those objects whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object and also will populate the Objects collection. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If more objects are still available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all of the pages of results in the Objects collection.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix 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) |
ListParts Method (S3 Class)
This method lists the parts in a multipart upload.
Syntax
public void listParts(String objectName, String uploadId);
Remarks
This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.
Calling this method will fire the PartList event once for each part and also will populate the Parts collection.
If more parts are still available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all of the pages of results in the Parts collection.
This method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the class will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads. Additionally, spCloudflareR2 (10) does not support the ListParts S3 operation.
ListVersions Method (S3 Class)
This method lists the object versions in a bucket.
Syntax
public void listVersions();
Remarks
This method lists the object versions in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property also can be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object version and also will populate the Objects collection. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If more object versions are still available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects collection.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
ObjectPrefix 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) |
Reset Method (S3 Class)
This method resets the class to its initial state.
Syntax
public void reset();
Remarks
This method resets the class to its initial state.
ResetHeaders Method (S3 Class)
This method resets all HTTP headers, cookies, and LocalFile.
Syntax
public void resetHeaders();
Remarks
This method resets all HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection properties.
Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next request.
SendCustomRequest Method (S3 Class)
This method sends a custom request to the server.
Syntax
public void sendCustomRequest(String httpMethod, String objectName, String requestBody);
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are as follows:
- 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 class does the following:
- Builds a request URL, including query parameters, based on the following:
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Alternatively, if ServiceProvider is spCustom (255), the custom URL specified using the ServiceProviderURL configuration setting is used directly, and these properties are ignored.
- Bucket (if nonempty)
- ObjectName (if nonempty)
- VersionId (if both it and ObjectName are nonempty)
- QueryParams
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Adds request headers from the following:
- Signs the request (unless the SignCustomRequest configuration setting is disabled).
- Sends the request, including RequestBody if nonempty.
- Stores the response headers in the ParsedHeaders collection; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ObjectData (using the same logic as GetObject).
If the response body is XML data, then the XPath, XText, and other X* configuration settings can be used to navigate and extract information from it.
SetDownloadStream Method (S3 Class)
This method sets the stream to which downloaded data will be written.
Syntax
public void setDownloadStream(java.io.OutputStream downloadStream);
Remarks
If a download stream is set before data are downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a nonempty value will discard any stream set using this method.
SetUploadStream Method (S3 Class)
This method sets the stream from which data are read when uploading.
Syntax
public void setUploadStream(java.io.InputStream uploadStream);
Remarks
If an upload stream is set before data are uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0.
Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a nonempty value will discard any stream set using this method.
StartMultipartUpload Method (S3 Class)
This method starts a new manual multipart upload.
Syntax
public String startMultipartUpload(String objectName);
Remarks
This method starts a new manual multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an automatic multipart upload, see the CreateObject method. This upload Id can then be used to call the following methods:
If any metadata items are present in the Metadata collection, they will be included in the creation request and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.
Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
UpdateBucketACL Method (S3 Class)
This method updates a bucket's canned access policy.
Syntax
public void updateBucketACL();
Remarks
This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy
UpdateObjectACL Method (S3 Class)
This method updates an object's canned access policy.
Syntax
public void updateObjectACL(String objectName);
Remarks
This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.
If the VersionId property is nonempty, the canned access policy of the specified version of the object is updated instead.
UploadPart Method (S3 Class)
This method uploads a multipart upload part.
Syntax
public void uploadPart(String objectName, int partNumber, String uploadId);
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 are taken from either the stream set using SetUploadStream, LocalFile, or ObjectData (whichever data are found first, when checked in that order). Each part must be at least 5 MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.
If the IncludePartMD5 configuration setting is true, the class will include an MD5 digest of its data when sending it to the server. The server then will verify that the data were received without corruption.
Note: This method is not supported when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
BucketList Event (S3 Class)
This event fires once for each bucket returned when listing buckets.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void bucketList(S3BucketListEvent e) {} ... } public class S3BucketListEvent { public String bucketName; public String creationDate; public String ownerId; public String ownerName; }
Remarks
This event fires once for each bucket returned when ListBuckets is called.
BucketName reflects the name of the bucket.
CreationDate reflects the bucket's creation date.
OwnerId and OwnerName reflect the Id and display the name of the bucket's owner, respectively.
EndTransfer Event (S3 Class)
This event fires when a document finishes transferring.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void endTransfer(S3EndTransferEvent e) {} ... } public class S3EndTransferEvent { public int direction; }
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (S3 Class)
Fired when information is available about errors during data delivery.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void error(S3ErrorEvent e) {} ... } public class S3ErrorEvent { public int errorCode; public String description; }
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FragmentComplete Event (S3 Class)
This event fires after each part in an automatic multipart upload is complete.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void fragmentComplete(S3FragmentCompleteEvent e) {} ... } public class S3FragmentCompleteEvent { public int fragmentNumber; public int fragmentCount; public boolean interrupt; }
Remarks
If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically divide the upload data 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 of the upload that has been completed. This value starts at 1.
FragmentCount is the total number of parts that will be uploaded.
Interrupt can be set to true to interrupt the upload. The upload may be resumed later.
Refer to CreateObject for more information.
Note: This event is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Header Event (S3 Class)
This event is fired every time a header line comes in.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void header(S3HeaderEvent e) {} ... } public class S3HeaderEvent { public String field; public String value; }
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 (S3 Class)
This event fires once for each log message.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void log(S3LogEvent e) {} ... } public class S3LogEvent { public int logLevel; public String message; public String logType; }
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the 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 (S3 Class)
This event fires once for each metadata item returned when object information and metadata are retrieved.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void metadataList(S3MetadataListEvent e) {} ... } public class S3MetadataListEvent { public String name; public String value; }
Remarks
This event fires once for each metadata item returned when GetObjectInfo is called.
Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-).
Note: The server stores metadata names in lowercase.
Value is the metadata item's value.
ObjectList Event (S3 Class)
This event fires once for each object, object version, or multipart upload returned when listing such items.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void objectList(S3ObjectListEvent e) {} ... } public class S3ObjectListEvent { public String bucketName; public String objectName; public String lastModified; public long size; public String ETag; public String ownerId; public String ownerName; public String uploadId; public String versionId; public boolean latestVersion; public boolean deleted; }
Remarks
This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.
BucketName reflects the name of the bucket that the object is in.
ObjectName reflects the name of the object.
LastModified reflects the last modified time of the object. This is not applicable when ListMultipartUploads is called.
Size reflects the size, in bytes, of the object. This is not applicable when ListMultipartUploads is called.
ETag reflects the object's ETag. This is not applicable when ListMultipartUploads is called.
OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. This is not applicable when GetObjectInfo is called.
UploadId reflects the Id of the multipart upload. This is applicable only when ListMultipartUploads is called.
VersionId reflects the Id of the object version (note that 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.; is empty in all other cases.
LatestVersion indicates whether this is the latest object version. This is applicable only when ListVersions is called.; is true in all other cases.
Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; is false in all other cases.
PartList Event (S3 Class)
This event fires once for every part returned when listing a multipart upload's parts.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void partList(S3PartListEvent e) {} ... } public class S3PartListEvent { public int partNumber; public String objectName; public String lastModified; public long size; public String ETag; public String ownerId; public String ownerName; }
Remarks
This event fires once for each part of a multipart upload that is returned when ListParts is called.
PartNumber reflects the part's number.
ObjectName reflects the name of the object the multipart upload is for.
LastModified reflects the last modified time of the part.
Size reflects the size, in bytes, of the part.
ETag reflects the part's ETag of the part.
OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.
Note: This event is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
PrefixList Event (S3 Class)
This event fires once for each common prefix returned when listing objects.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void prefixList(S3PrefixListEvent e) {} ... } public class S3PrefixListEvent { public String bucketName; public String prefix; }
Remarks
This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is nonempty. Refer to ObjectDelimiter for more information.
BucketName reflects the name of the bucket that the prefix is in.
Prefix is the common prefix.
Progress Event (S3 Class)
This event fires during an upload or download to indicate transfer progress.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void progress(S3ProgressEvent e) {} ... } public class S3ProgressEvent { public int direction; public long bytesTransferred; public long totalBytes; public int percentDone; }
Remarks
This event fires during an upload or download to indicate the progress of the transfer. By default, this event will fire each time PercentDone increases by 1 percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see the note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the class 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 were transferred before the interruption.
For example, if 10 MB of data were successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10 MB) when the transfer is first resumed, and then will continue to fire with successively greater values as usual.
This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class 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 (S3 Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void SSLServerAuthentication(S3SSLServerAuthenticationEvent e) {} ... } public class S3SSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; }
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 (S3 Class)
Fired when secure connection progress messages are available.
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void SSLStatus(S3SSLStatusEvent e) {} ... } public class S3SSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (S3 Class)
This event fires when a document starts transferring (after the headers).
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void startTransfer(S3StartTransferEvent e) {} ... } public class S3StartTransferEvent { public int direction; }
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (S3 Class)
This event is fired while a document transfers (delivers document).
Syntax
public class DefaultS3EventListener implements S3EventListener { ... public void transfer(S3TransferEvent e) {} ... } public class S3TransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; }
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
String (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
Encoded
String
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte[]
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
ExpirationDate
String (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
String
Default Value: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is 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: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
String
Default Value: ""
This is the password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.
Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.
PrivateKey
String (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String
Default Value: ""
This field contains 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
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
This is 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 field contains 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"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte[]
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field 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. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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
int
Default Value: 0
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This field can take one of the following values:
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, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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: ""
This is the subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.
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=support@nsoftware.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: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
This field contains 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: ""
This field contains 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: ""
This field contains 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
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signatures
- Key Authentication
- Key Encryption
- Data Encryption
- Key Agreement
- Certificate Signing
- Key Signing
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signatures |
0x40 | Key Authentication (Non-Repudiation) |
0x20 | Key Encryption |
0x10 | Data Encryption |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | Key Signing |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Constructors
public Certificate();
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate( certificateData);
Parses CertificateData as an X.509 public key.
public Certificate( certStoreType, store, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType 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 class 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).
public Certificate( certStoreType, store, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class 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).
public Certificate( certStoreType, store, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType 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 class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate( certStoreType, storeBlob, storePassword, subject);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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).
public Certificate( certStoreType, storeBlob, storePassword, subject, configurationString);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class 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).
public Certificate( certStoreType, storeBlob, storePassword, encoded);
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the class will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
boolean
Default Value: False
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.
If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).
FirewallType
int
Default Value: 0
This field determines 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 is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
String
Default Value: ""
This field contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception.
Password
String
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.
Port
int
Default Value: 0
This field contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
String
Default Value: ""
This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.
Constructors
public Firewall();
Header Type
This is an HTTP header as it is received from the server.
Remarks
When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.
Fields
Field
String
Default Value: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
String
Default Value: ""
This field contains the Header contents.
Constructors
public Header();
public Header( field, value);
Proxy Type
The proxy the class will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
int
Default Value: 0
This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
boolean
Default Value: False
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Note: This setting is applicable only in Windows.
Password
String
Default Value: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default Value: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
String
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
int
Default Value: 0
This field determines 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 class will use the psTunnel option. If the URL is an http URL, the class 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: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
public Proxy();
public Proxy( server, port);
public Proxy( server, port, user, password);
S3Bucket Type
This type represents a bucket.
Remarks
This type represents a bucket.
Fields
CreationDate
String (read-only)
Default Value: ""
The field includes the creation date of the bucket.
This field reflects the creation date of the bucket.
Name
String (read-only)
Default Value: ""
The field contains the name of the bucket.
This field reflects the name of the bucket.
OwnerDisplayName
String (read-only)
Default Value: ""
The field contains the display name of the bucket's owner.
This field reflects the display name of the bucket's owner.
OwnerId
String (read-only)
Default Value: ""
The field contains the Id of the bucket's owner.
This field reflects the Id of the bucket's owner.
Constructors
public S3Bucket();
public S3Bucket( name, creationDate, ownerId, ownerDisplayName);
S3Metadata Type
This type represents Amazon's Simple Storage Service (S3) metadata item.
Remarks
This type represents an S3 metadata item.
Fields
Name
String
Default Value: ""
The field contains the name of the metadata item.
This field specifies the name of the metadata item. The server stores metadata names in lowercase.
Note: The class 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 field is populated.
Value
String
Default Value: ""
This field contains the value of the metadata item.
This field specifies the value of the metadata item.
Constructors
public S3Metadata();
public S3Metadata( name, value);
S3Object Type
This type represents an object.
Remarks
This type represents an object.
Fields
Deleted
boolean (read-only)
Default Value: False
This field specifies whether this object version is a delete marker.
This field 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 field contains the ETag of the object.
This field 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 field contains the last modified time of the object.
This field reflects the last modified time of the object.
This is not applicable when ListMultipartUploads is called.
LatestVersion
boolean (read-only)
Default Value: True
This field specifies whether this is the latest object version.
This field 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 field contains the name (key) of the object.
This field reflects the name (key) of the object.
OwnerDisplayName
String (read-only)
Default Value: ""
This field contains the display name of the object's owner.
This field reflects the display name of the object's owner.
This is not applicable when GetObjectInfo is called.
OwnerId
String (read-only)
Default Value: ""
This field contains the Id of the object's owner.
This field reflects the Id of the object's owner.
This is not applicable when GetObjectInfo is called.
Size
long (read-only)
Default Value: 0
This field contains the size of the object.
This field reflects the size of the object in bytes.
This is not applicable when ListMultipartUploads is called.
StorageClass
String (read-only)
Default Value: ""
This field contains the storage class of the object.
This field reflects the storage class of the object.
UploadId
String (read-only)
Default Value: ""
This field contains the upload Id of the multipart upload.
This field reflects the upload Id of the multipart upload.
It is applicable only when ListMultipartUploads is called.
VersionId
String (read-only)
Default Value: ""
This field contains the Id of the object version.
This field 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
public S3Object();
public S3Object( name, lastModified, size, storageClass, ETag, ownerId, ownerDisplayName, uploadId);
S3Part Type
This type represents a multipart upload part.
Remarks
This type represents a multipart upload part. It is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Fields
ETag
String (read-only)
Default Value: ""
This field contains the ETag of the part.
This field reflects the ETag of the part.
LastModified
String (read-only)
Default Value: ""
This field contains the last modified time of the part.
This field reflects the last modified time of the part.
ObjectName
String (read-only)
Default Value: ""
This field contains the name (key) of the object that the part was uploaded for.
This field reflects the name (key) of the object that the part was uploaded for.
OwnerDisplayName
String (read-only)
Default Value: ""
This field contains the display name of the part's owner.
This field reflects the display name of the part's owner.
OwnerId
String (read-only)
Default Value: ""
This field contains the Id of the part's owner.
This field reflects the Id of the part's owner.
PartNumber
int (read-only)
Default Value: 0
This field contains the number of the part.
This field reflects the number of the part.
Size
long (read-only)
Default Value: 0
This field contains the size of the part.
This field reflects the size of the part in bytes.
Constructors
public S3Part();
public S3Part( partNumber, objectName, lastModified, size, ETag, ownerId, ownerDisplayName);
S3QueryParam Type
This type represents a query parameter to send in the request.
Remarks
This type represents a query parameter to send in the request.
Fields
Name
String
Default Value: ""
This field specifies the name of the query parameter.
This field specifies the name of the query parameter.
Value
String
Default Value: ""
This field contains the value of the query parameter.
This field specifies the value of the query parameter. The class will automatically URL encode this value when sending the request.
Constructors
public S3QueryParam();
public S3QueryParam( name, value);
Config Settings (S3 Class)
The class 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 class, access to these internal properties is provided through the Config method.S3 Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection property.
By default, this property is set to 5 (Negotiate), which will use Windows Negotiate (Kerberos) authentication when making the GET request. This configuration setting also can be set to 4 (NTLM), which will use NTLM authentication to attempt authentication with the ADFSSTSEndpoint. If the ADFSUser and ADFSPassword configuration settings are empty, it will use the current user's credentials.
The class supports key-based credential profiles, that is, those that 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 previously, the class also supports the region element, if it is present in the specified profile.
The class searches for the specified profile's information in the credentials and config files. The AWSProfileDir setting can be used to configure the directory where the class 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.
By default, this setting is empty, which will cause the class to check the default location used by the AWS CLI: an .aws directory in the current user's home directory, that is, %UserProfile%\.aws (Windows) or ~/.aws (Linux/macOS).
Refer to the find zone and account IDs page of the Cloudflare R2 documentation for instructions on how to find your account Id.
Note: This setting is ignored when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
When downloading encrypted data with LocalFile set, the class will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data are decrypted to LocalFile.
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 GetObject for details.
This setting accepts a hex-encoded value.
This setting accepts a hex-encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
- 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 (e.g., 192.168.5.4).
The ETag is used to determine if the object has changed since the last operation on the file. Set the IfMatch configuration setting to the ETag to ensure that a new version of the object does not already exist on the server.
Note: This configuration setting is applicable only when ServiceProvider is spWasabi (3); other providers do not support deleting nonempty buckets.
Valid values are 5242880 (5MB) to 2147483647 (2GB). The default is 26214400 (25 MB).
Note: Applications may need to increase this setting's value to upload very large objects; Amazon only allows 10,000 parts to be uploaded for any given multipart upload.
If the amount of upload data provided when creating an object is less than SimpleUploadLimit bytes, it will be uploaded directly, and thus this setting will not apply.
Note: This setting is ignored when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Note: This configuring setting is ignored unless UseEC2RoleCredentials is 1 and IMDSVersion is 2.
The default value is 1, and a request/response method will be used to retrieve temporary security credentials. When this setting is set to 2, a session-oriented model will be used instead. Please see "Configuring Instance Metadata Service" in the Amazon AWS documentation for more information.
In the session-oriented model, the session time to live can be specified in the IMDSv2SessionTokenDuration configuration setting.
The default value is false.
Note: This configuration setting is applicable only if the SignCustomRequest setting is true; otherwise, it is ignored.
The default value is false.
The default value is false.
Note: This setting is ignored when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
This configuration setting can be used to retrieve part information that can then be stored in PartInfo[i]. Doing so makes the CompleteMultipartUpload method assemble these specific parts instead of calling ListParts internally. If the ServiceProvider property is set to spCloudflareR2 (10), this setting will automatically be updated after calling CopyPart or UploadPart. This configuration setting is read-only.
Note: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2.
If this setting is -1 (default), the server's default is used. Acceptable values vary by provider.
If this configuration setting is -1 (default), the server's default is used. Acceptable values vary by provider.
Note: This configuration setting is ignored when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
Refer to the Understanding Object Storage Namespaces page of the Oracle Cloud documentation for instructions on how to find your account's Object Storage namespace.
Valid values for i are from 0 to (PartInfoCount -1).
Note: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2.
string uploadID = s3.StartMultipartUpload("objectName");
s3.UploadPart("objectName", 1, uploadID);
string part1 = s3.Config("LastPartInfo");
s3.UploadPart("objectName", 2, uploadID);
string part2 = s3.Config("LastPartInfo");
s3.Config("PartInfoCount=2");
s3.Config("PartInfo[0]=" + part1);
s3.Config("PartInfo[1]=" + part2);
s3.CompleteMultipartUpload("objectName", uploadID);
Note: This configuration setting typically is used only when working with multiple class instances in which the desired provider does not support the ListParts S3 operation, such as Cloudflare R2.
Valid values for i are from 0 to (PrefixCount -1).
This configuration setting is always -1 when StorePrefixList is disabled.
If this configuration setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that were successfully transferred before the interruption.
If this configuration setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.
Refer to the Progress event for more information.
The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by 1 percent. Setting this setting to 0 will cause the Progress event to fire every time data are transferred.
Note: Rhe Progress 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 class will behave as if this setting were 0 for the duration of the transfer.
Note: This is applicable only when calling GetLink.
Note: This is applicable only when calling GetLink.
Note: This is applicable only when calling GetLink.
Note: This is applicable only when calling GetLink.
Note: This is applicable only when calling GetLink.
Note: This is applicable only when calling GetLink.
Refer to CreateObject for more information.
Note: This setting is automatically cleared any time ServiceProvider changes. This setting is not applicable when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
By default, this setting is enabled, and object-level ACL headers are included.
When the class uses the specified base URL to generate a request URL, it performs the following transformations (if necessary):
- If the base URL includes an http[s]:// prefix, it is ignored; the UseSSL property controls whether the class makes secure or plaintext connections.
- If the base URL contains a %region% token, it is replaced with the Region property's current value.
For example, if this setting is set to http://s3.%region%.myservice.com, UseSSL is true, and Region is region-1, then the class will generate request URLs like https://s3.region-1.myservice.com/bucket/... (or like https://bucket.s3.region-1.myservice.com/..., if the UseVirtualHosting property is true).
By default, the signing version is 4. In SigV4, the signing key is derived from the credential scope string and will not be sent along in the request. Specifying a value of 2 means that the older Signature Version 2 will be used instead.
Note: SigV2 is deprecated and is no longer supported by Amazon.
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.
Valid values are -1 to 5368709120 (5 GB), inclusive. The default is 104857600 (100 MB). If this configuration setting is set to 0, the class will always perform a multipart upload when creating an object; if it is set to -1, the class will never perform a multipart upload.
Note: This setting is ignored when ServiceProvider is spGoogleStorage (2). Google Cloud Storage does not support multipart uploads.
By default, this setting is empty, causing new objects to be created with a provider's default storage class (usually STANDARD, but refer to the provider's documentation for more information). This setting is cleared any time ServiceProvider changes.
Note: The IBM Cloud Object Storage provider assigns storage classes to buckets rather than to individual objects. When ServiceProvider is spIBM (7), this setting can be set to a valid IBM storage class string before calling CreateBucket to create a bucket with the specified storage class. Buckets are created with the standard storage class by default.
By default, this setting is disabled.
For the class 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" page in the Amazon IAM documentation for more information.
By default, this setting is false. When set to true, the class will do the following before each request:
- Make a request against the EC2 instance to get the name of the role attached to it.
- Make a request against the metadata service to obtain temporary security credentials for the IAM role returned in the previous call.
- Parse the response, automatically populating the AccessKey and SecretKey properties and the SessionToken configuration setting.
- Execute the original request using the temporary security credentials that were acquired.
Note: This setting is ignored if the AWSProfile setting is set to a profile that includes credential information.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath Syntax
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 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. |
XPath Examples
Assuming the following XML response:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
Or, alternatively, the following JSON response:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
Here are some examples of valid XPaths:
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 is not an exhaustive list by any means, but should provide a general idea of the possibilities.
The current element is specified via the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
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]".
The default value is False.
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 class throws 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 class throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.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 class 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 after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.
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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this 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 class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 classs that do not directly expose Firewall properties.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if 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 is a positive value, the system will attempt to send pending data until the specified 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 class 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.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).
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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before 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 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 is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
If set to true, the class 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 class is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Note: This value must be set after SSLProvider is set.
Example values:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values when SSLProvider is set to latform include:
- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
Possible values when SSLProvider is set to Internal include:
- 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider 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 only supported 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 only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above 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 class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
When set, the class 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class throws an exception.
The format of this value is a comma separated list of hash-signature combinations. For instance:
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 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.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider 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)
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 setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified 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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
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)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.
- 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.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class 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 (S3 Class)
Common Errors
600 A server error occurred or the class was not able 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 or 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 (e.g., a name, path, Id) 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 already exists and Overwrite is false. | |
609 The class 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 configuration setting is not set. | |
611 An exception occurred while working with the specified LocalFile (or the current value of LocalFile 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. |
HTTP Errors
118 Firewall Error. Error description contains 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 Can't open AttachedFile. |
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 at this time. A connection is in progress. | |
112 You cannot change 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 class 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. | |
303 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 non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't 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] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory 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 not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |