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.

Method List

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

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.

Config Settings

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

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:

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.

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:

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.

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:

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.

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:

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:

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.

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.

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.

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.

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.

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

Alibaba Cloud Object Storage Regions

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

Google Cloud Storage Regions

Huawei Cloud Object Storage Regions

IBM Cloud Object Storage Regions

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

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

Wasabi Regions

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:

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.

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.

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:

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.

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 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:

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:

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:

1. 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
2. Adds request headers from the following:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • SessionToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if nonempty.
5. Stores the response headers in the ParsedHeaders collection; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ObjectData (using the same logic as GetObject).

If the response body is XML data, 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:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

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:

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

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

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

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

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

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

Constructors

public S3Metadata();

public S3Metadata( name,  value);

S3Object Type

This type represents an object.

Remarks

This type represents an object.

Fields

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

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

Constructors

public S3QueryParam();

public S3QueryParam( name,  value);

Config Settings (S3 Class)

S3 Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings