DigitalOcean Component
Properties Methods Events Config Settings Errors
The DigitalOcean component provides an easy way to interface with DigitalOcean's Spaces service.
Syntax
nsoftware.CloudStorage.DigitalOcean
Remarks
The DigitalOcean Spaces service has an API that is compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses.
To use the DigitalOcean component, you will first need to sign up for the DigitalOcean Spaces service and obtain an AccessKey and a SecretKey. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.
There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your data store.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AccessKey | The access key to use for authentication. |
AccessPolicy | The canned access policy to apply to a bucket or object. |
Bucket | Selects a bucket. |
Buckets | A collection of buckets. |
ContentDisposition | Content disposition to send for an object. |
ContentType | Content type to send for an object. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
Idle | This property specifies the current status of the component. |
LocalFile | The location of the local file. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Metadata | A collection of metadata items. |
ObjectData | The data that was downloaded, or that should be uploaded. |
ObjectDelimiter | The delimiter string to use when listing objects. |
ObjectMarker | A marker indicating what page of objects to return next. |
ObjectPrefix | A prefix used to restrict the results returned when listing objects. |
Objects | A collection of objects. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | Determines if local files are overwritten. |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
PartMarker | A marker indicating what page of parts to return next. |
Parts | A collection of multipart upload parts. |
Proxy | A set of properties related to proxy access. |
QueryParams | Additional query parameters to be included in the request. |
Range | The range of bytes to request. |
Region | The region the component will make requests against. |
SecretKey | The secret key to use for authentication. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | This property includes the timeout for the component. |
UseVirtualHosting | Determines which style request to use. |
VersionId | The object version to make requests against. |
VersionMarker | A marker indicating what page of object versions to return next. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AbortMultipartUpload | Aborts a multipart upload. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
BucketExists | Checks whether the bucket exists. |
CheckVersioningEnabled | Checks whether versioning is enabled for the currently selected bucket. |
CompleteMultipartUpload | Completes a multipart upload by assembling previously uploaded parts. |
Config | Sets or retrieves a configuration setting. |
CopyObject | Copies an object. |
CopyPart | Copies the specified object as a part of a multipart upload. |
CreateBucket | Creates a new bucket. |
CreateObject | Creates a new object in the currently selected bucket. |
DeleteBucket | Deletes a bucket. |
DeleteObject | Deletes an object. |
DisableVersioning | Disables versioning for the currently selected bucket. |
DoEvents | This method processes events from the internal message queue. |
EnableVersioning | Enables versioning for the currently selected bucket. |
GetBucketLocation | Gets a bucket's location. |
GetLink | Creates a link that provides access to an object for a specified amount of time. |
GetObject | Downloads an object. |
GetObjectInfo | Gets an object's information and metadata. |
Interrupt | This method interrupts the current method. |
ListBuckets | Lists all buckets in the account. |
ListMultipartUploads | Lists the current multipart uploads. |
ListObjects | Lists the objects in a bucket. |
ListParts | Lists the parts in a multipart upload. |
ListVersions | Lists the object versions in a bucket. |
Reset | Resets the component to its initial state. |
ResetHeaders | Resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | Sends a custom request to the server. |
SetDownloadStream | Sets the stream to which downloaded data will be written. |
SetUploadStream | Sets the stream from which data is read when uploading. |
StartMultipartUpload | Starts a new manual multipart upload. |
UpdateBucketACL | Updates a bucket's canned access policy. |
UpdateObjectACL | Updates an object's canned access policy. |
UploadPart | Uploads a multipart upload part. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
BucketList | 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 | 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 | Fires once for each metadata item returned when object information and metadata is retrieved. |
ObjectList | Fires once for each object, object version, or multipart upload returned when listing such items. |
PartList | Fires once for every part returned when listing a multipart upload's parts. |
PrefixList | Fires once for each common prefix returned when listing objects. |
Progress | 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 component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
AssumeRoleARN | Amazon Resource Name used when assuming a role for authentication. |
AssumeRoleDuration | The durration for role session in seconds. |
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 component should use to obtain authentication and region information. |
AWSProfileDir | The location of the AWS CLI credentials and config files. |
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. |
FragmentSize | The part size to use when uploading a new object. |
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. |
MaskSensitiveData | 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. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixes returned. |
ProgressAbsolute | Whether the component 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. |
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 component to sign the outgoing request. |
SigningTime | A custom date to send to the component to use while signing all requests. |
SimpleUploadLimit | The maximum data size the component should attempt to upload directly when creating an object. |
StorePrefixList | Whether to store the common prefixes returned when listing objects. |
TempPath | The path to the directory where temporary files are created. |
URL | If set, the default URL will be overridden by this value. |
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 component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component 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 component. |
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 component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component 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 component. |
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 component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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 component 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 component 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. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
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 be included when performing an SSL handshake. |
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. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
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. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (DigitalOcean Component)
The access key to use for authentication.
Syntax
Default Value
""
Remarks
This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.
AccessPolicy Property (DigitalOcean Component)
The canned access policy to apply to a bucket or object.
Syntax
public DigitalOceanAccessPolicies AccessPolicy { get; set; }
enum DigitalOceanAccessPolicies { ptPrivate, ptPublicRead, ptPublicReadWrite, ptAuthenticatedRead, ptBucketOwnerRead, ptBucketOwnerFullControl, ptNone }
Public Property AccessPolicy As DigitaloceanAccessPolicies
Enum DigitalOceanAccessPolicies ptPrivate ptPublicRead ptPublicReadWrite ptAuthenticatedRead ptBucketOwnerRead ptBucketOwnerFullControl ptNone End Enum
Default Value
0
Remarks
This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:
- CopyObject (for the destination object)
- CreateBucket
- CreateObject
- StartMultipartUpload
- UpdateBucketACL
- UpdateObjectACL
Valid values are:
ptPrivate (0) (default) | Owner gets full control, no one else has access. |
ptPublicRead (1) | Owner gets full control, everyone else gets read access. |
ptPublicReadWrite (2) | Owner gets full control, everyone else gets read/write access. |
ptAuthenticatedRead (3) | Owner gets full control, authenticated users get read access. |
ptBucketOwnerRead (4) | Only applicable for objects. Object owner gets full control, bucket owner gets read access. |
ptBucketOwnerFullControl (5) | Only applicable for objects. Both object and bucket owner get full control. |
ptNone (6) | (Instructs the component to not explicitly set a canned access policy for a bucket or object.) |
Bucket Property (DigitalOcean Component)
Selects a bucket.
Syntax
Default Value
""
Remarks
This property selects a bucket, by name, for the component to operate against. It must be set before attempting most operations.
Buckets Property (DigitalOcean Component)
A collection of buckets.
Syntax
public S3BucketList Buckets { get; }
Public ReadOnly Property Buckets As S3BucketList
Remarks
This collection holds a list of S3Bucket items.
Calling ListBuckets will populate this collection.
This property is read-only and not available at design time.
Please refer to the S3Bucket type for a complete list of fields.ContentDisposition Property (DigitalOcean Component)
Content disposition to send for an object.
Syntax
Default Value
""
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.
This property is not available at design time.
ContentType Property (DigitalOcean Component)
Content type to send for an object.
Syntax
Default Value
""
Remarks
This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.
This property is not available at design time.
EncryptionAlgorithm Property (DigitalOcean Component)
The encryption algorithm.
Syntax
public DigitalOceanEncryptionAlgorithms EncryptionAlgorithm { get; set; }
enum DigitalOceanEncryptionAlgorithms { eaAES, eaBlowfish, eaCAST, eaDES, eaIDEA, eaRC2, eaRC4, eaTEA, eaTripleDES, eaTwofish, eaRijndael, eaChaCha, eaXSalsa20 }
Public Property EncryptionAlgorithm As DigitaloceanEncryptionAlgorithms
Enum DigitalOceanEncryptionAlgorithms eaAES eaBlowfish eaCAST eaDES eaIDEA eaRC2 eaRC4 eaTEA eaTripleDES eaTwofish eaRijndael eaChaCha eaXSalsa20 End Enum
Default Value
0
Remarks
This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:
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 (DigitalOcean Component)
The encryption password.
Syntax
Default Value
""
Remarks
If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.
The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.
This property is not available at design time.
Firewall Property (DigitalOcean Component)
A set of properties related to firewall access.
Syntax
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.FollowRedirects Property (DigitalOcean Component)
Determines what happens when the server issues a redirect.
Syntax
public DigitalOceanFollowRedirects FollowRedirects { get; set; }
enum DigitalOceanFollowRedirects { frNever, frAlways, frSameScheme }
Public Property FollowRedirects As DigitaloceanFollowRedirects
Enum DigitalOceanFollowRedirects frNever frAlways frSameScheme End Enum
Default Value
0
Remarks
This property specifies how the component should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:
frNever (0) (default) | Redirects are never followed; the component 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 component throws an exception. |
Idle Property (DigitalOcean Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
LocalFile Property (DigitalOcean Component)
The location of the local file.
Syntax
Default Value
""
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.
Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.
LocalHost Property (DigitalOcean Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Metadata Property (DigitalOcean Component)
A collection of metadata items.
Syntax
public S3MetadataList Metadata { get; }
Public Property Metadata As S3MetadataList
Remarks
This collection holds a list of S3Metadata items.
This collection is populated when GetObjectInfo is called; and its items are used anytime CreateObject, CopyObject, or StartMultipartUpload is called.
This property is not available at design time.
Please refer to the S3Metadata type for a complete list of fields.ObjectData Property (DigitalOcean Component)
The data that was downloaded, or that should be uploaded.
Syntax
Default Value
""
Remarks
This property is populated with object data after calling GetObject if SetDownloadStream and LocalFile are not set.
This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if SetUploadStream and LocalFile are not set.
This property is not available at design time.
ObjectDelimiter Property (DigitalOcean Component)
The delimiter string to use when listing objects.
Syntax
Default Value
""
Remarks
If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.
The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the component will also populate the PrefixCount and Prefix[i] configuration settings
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
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 (DigitalOcean Component)
A marker indicating what page of objects to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns empty string.
Refer to ListObjects for more information.
This property is not available at design time.
ObjectPrefix Property (DigitalOcean Component)
A prefix used to restrict the results returned when listing objects.
Syntax
Default Value
""
Remarks
This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.
Object Hierarchy Traversal
By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:
- MyCompany/
- MyCompany/Department1/
- MyCompany/Department2/
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:
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 (DigitalOcean Component)
A collection of objects.
Syntax
public S3ObjectList Objects { get; }
Public ReadOnly Property Objects As S3ObjectList
Remarks
This collection holds a list of S3Object items.
Calling GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads will populate this collection.
This property is read-only and not available at design time.
Please refer to the S3Object type for a complete list of fields.OtherHeaders Property (DigitalOcean Component)
This property includes other headers as determined by the user (optional).
Syntax
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the component beyond what is provided.
This property is not available at design time.
Overwrite Property (DigitalOcean Component)
Determines if local files are overwritten.
Syntax
Default Value
False
Remarks
This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is false.
ParsedHeaders Property (DigitalOcean Component)
This property includes a collection of headers returned from the last request.
Syntax
public HeaderList ParsedHeaders { get; }
Public ReadOnly Property ParsedHeaders As HeaderList
Remarks
This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.
MaxHeaders can be used to control the maximum number of headers saved.
This collection is indexed from 0 to count -1.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.PartMarker Property (DigitalOcean Component)
A marker indicating what page of parts to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.
Refer to ListParts for more information.
This property is not available at design time.
Parts Property (DigitalOcean Component)
A collection of multipart upload parts.
Syntax
public S3PartList Parts { get; }
Public ReadOnly Property Parts As S3PartList
Remarks
This collection holds a list of S3Part items.
Calling ListParts will populate this collection.
This property is read-only and not available at design time.
Please refer to the S3Part type for a complete list of fields.Proxy Property (DigitalOcean Component)
A set of properties related to proxy access.
Syntax
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.QueryParams Property (DigitalOcean Component)
Additional query parameters to be included in the request.
Syntax
public QueryParamList QueryParams { get; }
Public Property QueryParams As QueryParamList
Remarks
This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.
Please refer to the QueryParam type for a complete list of fields.Range Property (DigitalOcean Component)
The range of bytes to request.
Syntax
Default Value
""
Remarks
This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.
There are two valid formats for this property's value:
- StartByte-
- StartByte-EndByte
Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the component will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.
This property is not available at design time.
Region Property (DigitalOcean Component)
The region the component will make requests against.
Syntax
Default Value
"nyc3"
Remarks
This property control which region the component will make requests against. By default the component uses nyc3, the New York 3 region. This property should be changed to create or access resources in other regions.
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 |
The component will always convert this property's value to lowercase. If this property is cleared, the component will reset it to the default value.
SecretKey Property (DigitalOcean Component)
The secret key to use for authentication.
Syntax
Default Value
""
Remarks
This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.
SSLAcceptServerCert Property (DigitalOcean Component)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (DigitalOcean Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (DigitalOcean Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public DigitalOceanSSLProviders SSLProvider { get; set; }
enum DigitalOceanSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As DigitaloceanSSLProviders
Enum DigitalOceanSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
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 component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (DigitalOcean Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
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 (DigitalOcean Component)
The byte offset from which to resume the upload or download.
Syntax
Default Value
0
Remarks
This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.
When uploading from a stream, the component will always seek forward in the stream if the value of StartByte is greater than 0 when CreateObject is called. Keep this in mind when resuming interrupted object uploads.
This property is not available at design time.
Timeout Property (DigitalOcean Component)
This property includes the timeout for the component.
Syntax
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.
The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the component throws an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
UseVirtualHosting Property (DigitalOcean Component)
Determines which style request to use.
Syntax
Default Value
True
Remarks
If set to true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.nyc3.digitaloceanspaces.com/yourobject. If false, the component will use the path-style request: http://nyc3.digitaloceanspaces.com/yourbucket/yourobject.
NOTE: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions. DigitalOcean follows Amazon's naming restrictions, so refer to Amazon's S3 documentation for more information.
This property is not available at design time.
VersionId Property (DigitalOcean Component)
The object version to make requests against.
Syntax
Default Value
""
Remarks
This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:
- CopyObject (to copy from a specific object version)
- DeleteObject
- GetLink (to build a link for a specific object version)
- GetObject
- GetObjectInfo
- SendCustomRequest
- UpdateObjectACL
Refer to Amazon's Versioning documentation for more information about versioning.
This property is not available at design time.
VersionMarker Property (DigitalOcean Component)
A marker indicating what page of object versions to return next.
Syntax
Default Value
""
Remarks
This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.
Refer to ListVersions for more information.
This property is not available at design time.
AbortMultipartUpload Method (DigitalOcean Component)
Aborts a multipart upload.
Syntax
public void AbortMultipartUpload(string objectName, string uploadId); Async Version public async Task AbortMultipartUpload(string objectName, string uploadId); public async Task AbortMultipartUpload(string objectName, string uploadId, CancellationToken cancellationToken);
Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) Async Version Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) As Task Public Sub AbortMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task
Remarks
This method aborts the multipart upload of the object named ObjectName specified by UploadId.
When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)
If this method is called successfully, the specified UploadId will no longer be valid.
AddMetadata Method (DigitalOcean Component)
Adds a metadata item to the Metadata properties.
Syntax
Remarks
This method adds a metadata item to the Metadata collection. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.
If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The component will take care of prepending it when sending metadata to the server.
AddQueryParam Method (DigitalOcean Component)
Adds a query parameter to the QueryParams properties.
Syntax
Remarks
This method is used to add a query parameter to the QueryParams collection. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.
BucketExists Method (DigitalOcean Component)
Checks whether the bucket exists.
Syntax
public bool BucketExists(); Async Version public async Task<bool> BucketExists(); public async Task<bool> BucketExists(CancellationToken cancellationToken);
Public Function BucketExists() As Boolean Async Version Public Function BucketExists() As Task(Of Boolean) Public Function BucketExists(cancellationToken As CancellationToken) As Task(Of Boolean)
Remarks
This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.
CheckVersioningEnabled Method (DigitalOcean Component)
Checks whether versioning is enabled for the currently selected bucket.
Syntax
public bool CheckVersioningEnabled(); Async Version public async Task<bool> CheckVersioningEnabled(); public async Task<bool> CheckVersioningEnabled(CancellationToken cancellationToken);
Public Function CheckVersioningEnabled() As Boolean Async Version Public Function CheckVersioningEnabled() As Task(Of Boolean) Public Function CheckVersioningEnabled(cancellationToken As CancellationToken) As Task(Of Boolean)
Remarks
This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.
Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return false when queried.
Refer to Amazon's Versioning documentation for more information about versioning.
CompleteMultipartUpload Method (DigitalOcean Component)
Completes a multipart upload by assembling previously uploaded parts.
Syntax
public void CompleteMultipartUpload(string objectName, string uploadId); Async Version public async Task CompleteMultipartUpload(string objectName, string uploadId); public async Task CompleteMultipartUpload(string objectName, string uploadId, CancellationToken cancellationToken);
Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) Async Version Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String) As Task Public Sub CompleteMultipartUpload(ByVal ObjectName As String, ByVal UploadId As String, cancellationToken As CancellationToken) As Task
Remarks
This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.
Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts collection, nor does it cause the PartList event to fire.
Config Method (DigitalOcean Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CopyObject Method (DigitalOcean Component)
Copies an object.
Syntax
public void CopyObject(string srcObjectName, string destBucket, string destObjectName); Async Version public async Task CopyObject(string srcObjectName, string destBucket, string destObjectName); public async Task CopyObject(string srcObjectName, string destBucket, string destObjectName, CancellationToken cancellationToken);
Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String) Async Version Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String) As Task Public Sub CopyObject(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.
If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.
If there are any metadata items present in the Metadata collection, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.
Notes:
- Objects may only be copied to buckets that exist within the same region.
- Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.
CopyPart Method (DigitalOcean Component)
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); Async Version public async Task CopyPart(string srcObjectName, string destBucket, string destObjectName, int destPartNumber, string destUploadId); public async Task CopyPart(string srcObjectName, string destBucket, string destObjectName, int destPartNumber, string destUploadId, CancellationToken cancellationToken);
Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String) Async Version Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String) As Task Public Sub CopyPart(ByVal SrcObjectName As String, ByVal DestBucket As String, ByVal DestObjectName As String, ByVal DestPartNumber As Integer, ByVal DestUploadId As String, cancellationToken As CancellationToken) As Task
Remarks
This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.
The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.
To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.
CreateBucket Method (DigitalOcean Component)
Creates a new bucket.
Syntax
public void CreateBucket(); Async Version public async Task CreateBucket(); public async Task CreateBucket(CancellationToken cancellationToken);
Public Sub CreateBucket() Async Version Public Sub CreateBucket() As Task Public Sub CreateBucket(cancellationToken As CancellationToken) As Task
Remarks
This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.
CreateObject Method (DigitalOcean Component)
Creates a new object in the currently selected bucket.
Syntax
public void CreateObject(string objectName); Async Version public async Task CreateObject(string objectName); public async Task CreateObject(string objectName, CancellationToken cancellationToken);
Public Sub CreateObject(ByVal ObjectName As String) Async Version Public Sub CreateObject(ByVal ObjectName As String) As Task Public Sub CreateObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata collection, they will included in the creation request.
If SetUploadStream has been used to set an upload stream, it will take priority as the data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.
Automatic Multipart Uploads
If more than SimpleUploadLimit bytes of data are provided, the component will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the component automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.
If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.
When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.
DeleteBucket Method (DigitalOcean Component)
Deletes a bucket.
Syntax
public void DeleteBucket(); Async Version public async Task DeleteBucket(); public async Task DeleteBucket(CancellationToken cancellationToken);
Public Sub DeleteBucket() Async Version Public Sub DeleteBucket() As Task Public Sub DeleteBucket(cancellationToken As CancellationToken) As Task
Remarks
This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.
DeleteObject Method (DigitalOcean Component)
Deletes an object.
Syntax
public void DeleteObject(string objectName); Async Version public async Task DeleteObject(string objectName); public async Task DeleteObject(string objectName, CancellationToken cancellationToken);
Public Sub DeleteObject(ByVal ObjectName As String) Async Version Public Sub DeleteObject(ByVal ObjectName As String) As Task Public Sub DeleteObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.
If the VersionId property is non-empty, this method deletes the specified version of the object instead.
Deleting Versioned Objects
If a bucket has versioning enabled (i.e., CheckVersioningEnabled returns true when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a delete marker.If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.
To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.
Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.
DisableVersioning Method (DigitalOcean Component)
Disables versioning for the currently selected bucket.
Syntax
public void DisableVersioning(); Async Version public async Task DisableVersioning(); public async Task DisableVersioning(CancellationToken cancellationToken);
Public Sub DisableVersioning() Async Version Public Sub DisableVersioning() As Task Public Sub DisableVersioning(cancellationToken As CancellationToken) As Task
Remarks
This method can be used to disable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
DoEvents Method (DigitalOcean Component)
This method processes events from the internal message queue.
Syntax
public void DoEvents(); Async Version public async Task DoEvents(); public async Task DoEvents(CancellationToken cancellationToken);
Public Sub DoEvents() Async Version Public Sub DoEvents() As Task Public Sub DoEvents(cancellationToken As CancellationToken) As Task
Remarks
When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.
EnableVersioning Method (DigitalOcean Component)
Enables versioning for the currently selected bucket.
Syntax
public void EnableVersioning(); Async Version public async Task EnableVersioning(); public async Task EnableVersioning(CancellationToken cancellationToken);
Public Sub EnableVersioning() Async Version Public Sub EnableVersioning() As Task Public Sub EnableVersioning(cancellationToken As CancellationToken) As Task
Remarks
This method can be used to enable versioning for the bucket currently selected by Bucket.
Refer to Amazon's Versioning documentation for more information about versioning.
GetBucketLocation Method (DigitalOcean Component)
Gets a bucket's location.
Syntax
public string GetBucketLocation(); Async Version public async Task<string> GetBucketLocation(); public async Task<string> GetBucketLocation(CancellationToken cancellationToken);
Public Function GetBucketLocation() As String Async Version Public Function GetBucketLocation() As Task(Of String) Public Function GetBucketLocation(cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.
GetLink Method (DigitalOcean Component)
Creates a link that provides access to an object for a specified amount of time.
Syntax
public string GetLink(string objectName, int expires); Async Version public async Task<string> GetLink(string objectName, int expires); public async Task<string> GetLink(string objectName, int expires, CancellationToken cancellationToken);
Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer) As String Async Version Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer) As Task(Of String) Public Function GetLink(ByVal ObjectName As String, ByVal Expires As Integer, cancellationToken As CancellationToken) As Task(Of String)
Remarks
This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.
The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.
Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.
GetObject Method (DigitalOcean Component)
Downloads an object.
Syntax
public void GetObject(string objectName); Async Version public async Task GetObject(string objectName); public async Task GetObject(string objectName, CancellationToken cancellationToken);
Public Sub GetObject(ByVal ObjectName As String) Async Version Public Sub GetObject(ByVal ObjectName As String) As Task Public Sub GetObject(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.
If a stream has been specified using SetDownloadStream, the object data will be sent through it. If a stream is not specified, and LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.
To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading an object looks like this:
s3.LocalFile = "../MyData.zip";
s3.GetObject(s3.Objects[0].Name);
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyData.zip";
s3.LocalFile = downloadFile;
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded file
s3.StartByte = new FileInfo(downloadFile).Length;
s3.GetObject(s3.Objects[0].Name);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
s3.LocalFile = "../MyData.zip";
s3.EncryptionPassword = "password";
s3.GetObject(s3.Objects[0].Name);
//The transfer is interrupted and GetObject() above fails. Later, resume the download:
//Get the size of the partially downloaded temp file
s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length;
s3.GetObject(s3.Objects[0].Name);
GetObjectInfo Method (DigitalOcean Component)
Gets an object's information and metadata.
Syntax
public void GetObjectInfo(string objectName); Async Version public async Task GetObjectInfo(string objectName); public async Task GetObjectInfo(string objectName, CancellationToken cancellationToken);
Public Sub GetObjectInfo(ByVal ObjectName As String) Async Version Public Sub GetObjectInfo(ByVal ObjectName As String) As Task Public Sub GetObjectInfo(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.
Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects and Metadata collection properties.
Interrupt Method (DigitalOcean Component)
This method interrupts the current method.
Syntax
public void Interrupt(); Async Version public async Task Interrupt(); public async Task Interrupt(CancellationToken cancellationToken);
Public Sub Interrupt() Async Version Public Sub Interrupt() As Task Public Sub Interrupt(cancellationToken As CancellationToken) As Task
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListBuckets Method (DigitalOcean Component)
Lists all buckets in the account.
Syntax
public void ListBuckets(); Async Version public async Task ListBuckets(); public async Task ListBuckets(CancellationToken cancellationToken);
Public Sub ListBuckets() Async Version Public Sub ListBuckets() As Task Public Sub ListBuckets(cancellationToken As CancellationToken) As Task
Remarks
This method lists all buckets in the account.
Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets collection.
ListMultipartUploads Method (DigitalOcean Component)
Lists the current multipart uploads.
Syntax
public void ListMultipartUploads(); Async Version public async Task ListMultipartUploads(); public async Task ListMultipartUploads(CancellationToken cancellationToken);
Public Sub ListMultipartUploads() Async Version Public Sub ListMultipartUploads() As Task Public Sub ListMultipartUploads(cancellationToken As CancellationToken) As Task
Remarks
This method lists the current multipart uploads in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects collection.
If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects collection.
ListObjects Method (DigitalOcean Component)
Lists the objects in a bucket.
Syntax
public void ListObjects(); Async Version public async Task ListObjects(); public async Task ListObjects(CancellationToken cancellationToken);
Public Sub ListObjects() Async Version Public Sub ListObjects() As Task Public Sub ListObjects(cancellationToken As CancellationToken) As Task
Remarks
This method lists the objects in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object, and will also populate the Objects collection. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects collection.
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 (DigitalOcean Component)
Lists the parts in a multipart upload.
Syntax
Remarks
This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.
Calling this method will fire the PartList event once for each part, and will also populate the Parts collection.
If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts collection.
Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the component will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.
ListVersions Method (DigitalOcean Component)
Lists the object versions in a bucket.
Syntax
public void ListVersions(); Async Version public async Task ListVersions(); public async Task ListVersions(CancellationToken cancellationToken);
Public Sub ListVersions() Async Version Public Sub ListVersions() As Task Public Sub ListVersions(cancellationToken As CancellationToken) As Task
Remarks
This method lists the object versions in the bucket currently selected by Bucket.
Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.
Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects collection. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.
If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects collection.
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 (DigitalOcean Component)
Resets the component to its initial state.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
Remarks
This method resets the component to its initial state.
ResetHeaders Method (DigitalOcean Component)
Resets all HTTP headers, cookies, and LocalFile.
Syntax
public void ResetHeaders(); Async Version public async Task ResetHeaders(); public async Task ResetHeaders(CancellationToken cancellationToken);
Public Sub ResetHeaders() Async Version Public Sub ResetHeaders() As Task Public Sub ResetHeaders(cancellationToken As CancellationToken) As Task
Remarks
Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection properties.
Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.
SendCustomRequest Method (DigitalOcean Component)
Sends a custom request to the server.
Syntax
public void SendCustomRequest(string httpMethod, string objectName, string requestBody); Async Version public async Task SendCustomRequest(string httpMethod, string objectName, string requestBody); public async Task SendCustomRequest(string httpMethod, string objectName, string requestBody, CancellationToken cancellationToken);
Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String) Async Version Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String) As Task Public Sub SendCustomRequest(ByVal HttpMethod As String, ByVal ObjectName As String, ByVal RequestBody As String, cancellationToken As CancellationToken) As Task
Remarks
This method can be used to send arbitrary requests to the server.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The ObjectName and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the component does the following:
- Builds a request URL, including query parameters, based on the following:
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
- Bucket (if non-empty)
- ObjectName (if non-empty)
- VersionId (if both it and ObjectName are non-empty)
- QueryParams
- UseSSL, Region, and UseVirtualHosting for the base URL.
- Adds request headers from:
- Signs the request (unless the SignCustomRequest configuration setting is disabled).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeaders collection; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ObjectData (using the same logic as GetObject).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.
SetDownloadStream Method (DigitalOcean Component)
Sets the stream to which downloaded data will be written.
Syntax
public void SetDownloadStream(System.IO.Stream downloadStream); Async Version public async Task SetDownloadStream(System.IO.Stream downloadStream); public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) Async Version Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task
Remarks
If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.
Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
SetUploadStream Method (DigitalOcean Component)
Sets the stream from which data is read when uploading.
Syntax
public void SetUploadStream(System.IO.Stream uploadStream); Async Version public async Task SetUploadStream(System.IO.Stream uploadStream); public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) Async Version Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task
Remarks
If an upload stream is set before data is uploaded, the content of the stream will be read by the component and uploaded to the server. The stream should be open and normally set to position 0.
Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.
StartMultipartUpload Method (DigitalOcean Component)
Starts a new manual multipart upload.
Syntax
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 there are any metadata items present in the Metadata collection, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.
Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.
UpdateBucketACL Method (DigitalOcean Component)
Updates a bucket's canned access policy.
Syntax
public void UpdateBucketACL(); Async Version public async Task UpdateBucketACL(); public async Task UpdateBucketACL(CancellationToken cancellationToken);
Public Sub UpdateBucketACL() Async Version Public Sub UpdateBucketACL() As Task Public Sub UpdateBucketACL(cancellationToken As CancellationToken) As Task
Remarks
This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy
UpdateObjectACL Method (DigitalOcean Component)
Updates an object's canned access policy.
Syntax
public void UpdateObjectACL(string objectName); Async Version public async Task UpdateObjectACL(string objectName); public async Task UpdateObjectACL(string objectName, CancellationToken cancellationToken);
Public Sub UpdateObjectACL(ByVal ObjectName As String) Async Version Public Sub UpdateObjectACL(ByVal ObjectName As String) As Task Public Sub UpdateObjectACL(ByVal ObjectName As String, cancellationToken As CancellationToken) As Task
Remarks
This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.
If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.
UploadPart Method (DigitalOcean Component)
Uploads a multipart upload part.
Syntax
public void UploadPart(string objectName, int partNumber, string uploadId); Async Version public async Task UploadPart(string objectName, int partNumber, string uploadId); public async Task UploadPart(string objectName, int partNumber, string uploadId, CancellationToken cancellationToken);
Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String) Async Version Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String) As Task Public Sub UploadPart(ByVal ObjectName As String, ByVal PartNumber As Integer, ByVal UploadId As String, cancellationToken As CancellationToken) As Task
Remarks
This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.
PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.
The data to upload is taken from either the stream set using SetUploadStream, LocalFile, or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.
If the IncludePartMD5 configuration setting is true, the component will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.
BucketList Event (DigitalOcean Component)
Fires once for each bucket returned when listing buckets.
Syntax
public event OnBucketListHandler OnBucketList; public delegate void OnBucketListHandler(object sender, DigitalOceanBucketListEventArgs e); public class DigitalOceanBucketListEventArgs : EventArgs { public string BucketName { get; } public string CreationDate { get; } public string OwnerId { get; } public string OwnerName { get; } }
Public Event OnBucketList As OnBucketListHandler Public Delegate Sub OnBucketListHandler(sender As Object, e As DigitalOceanBucketListEventArgs) Public Class DigitalOceanBucketListEventArgs Inherits EventArgs Public ReadOnly Property BucketName As String Public ReadOnly Property CreationDate As String Public ReadOnly Property OwnerId As String Public ReadOnly Property OwnerName As String End Class
Remarks
This event fires once for each bucket returned when ListBuckets is called.
BucketName reflects the name of the bucket.
CreationDate reflects the bucket's creation date.
OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.
EndTransfer Event (DigitalOcean Component)
This event fires when a document finishes transferring.
Syntax
public event OnEndTransferHandler OnEndTransfer; public delegate void OnEndTransferHandler(object sender, DigitalOceanEndTransferEventArgs e); public class DigitalOceanEndTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnEndTransfer As OnEndTransferHandler Public Delegate Sub OnEndTransferHandler(sender As Object, e As DigitalOceanEndTransferEventArgs) Public Class DigitalOceanEndTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (DigitalOcean Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, DigitalOceanErrorEventArgs e); public class DigitalOceanErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As DigitalOceanErrorEventArgs) Public Class DigitalOceanErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FragmentComplete Event (DigitalOcean Component)
Fires after each part in an automatic multipart upload is complete.
Syntax
public event OnFragmentCompleteHandler OnFragmentComplete; public delegate void OnFragmentCompleteHandler(object sender, DigitalOceanFragmentCompleteEventArgs e); public class DigitalOceanFragmentCompleteEventArgs : EventArgs { public int FragmentNumber { get; } public int FragmentCount { get; } public bool Interrupt { get; set; } }
Public Event OnFragmentComplete As OnFragmentCompleteHandler Public Delegate Sub OnFragmentCompleteHandler(sender As Object, e As DigitalOceanFragmentCompleteEventArgs) Public Class DigitalOceanFragmentCompleteEventArgs Inherits EventArgs Public ReadOnly Property FragmentNumber As Integer Public ReadOnly Property FragmentCount As Integer Public Property Interrupt As Boolean End Class
Remarks
If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the component will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.
FragmentNumber is the number of the current part that has completed. This value starts at 1.
FragmentCount is the total number of parts that will be uploaded.
Interrupt can be set to true to interrupt the upload. The upload may be resumed later.
Refer to CreateObject for more information.
Header Event (DigitalOcean Component)
This event is fired every time a header line comes in.
Syntax
public event OnHeaderHandler OnHeader; public delegate void OnHeaderHandler(object sender, DigitalOceanHeaderEventArgs e); public class DigitalOceanHeaderEventArgs : EventArgs { public string Field { get; } public string Value { get; } }
Public Event OnHeader As OnHeaderHandler Public Delegate Sub OnHeaderHandler(sender As Object, e As DigitalOceanHeaderEventArgs) Public Class DigitalOceanHeaderEventArgs Inherits EventArgs Public ReadOnly Property Field As String Public ReadOnly Property Value As String End Class
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (DigitalOcean Component)
This event fires once for each log message.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, DigitalOceanLogEventArgs e); public class DigitalOceanLogEventArgs : EventArgs { public int LogLevel { get; } public string Message { get; } public string LogType { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As DigitalOceanLogEventArgs) Public Class DigitalOceanLogEventArgs Inherits EventArgs Public ReadOnly Property LogLevel As Integer Public ReadOnly Property Message As String Public ReadOnly Property LogType As String End Class
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
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 (DigitalOcean Component)
Fires once for each metadata item returned when object information and metadata is retrieved.
Syntax
public event OnMetadataListHandler OnMetadataList; public delegate void OnMetadataListHandler(object sender, DigitalOceanMetadataListEventArgs e); public class DigitalOceanMetadataListEventArgs : EventArgs { public string Name { get; } public string Value { get; } }
Public Event OnMetadataList As OnMetadataListHandler Public Delegate Sub OnMetadataListHandler(sender As Object, e As DigitalOceanMetadataListEventArgs) Public Class DigitalOceanMetadataListEventArgs Inherits EventArgs Public ReadOnly Property Name As String Public ReadOnly Property Value As String End Class
Remarks
This event fires once for each metadata item returned when GetObjectInfo is called.
Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.
Value is the metadata item's value.
ObjectList Event (DigitalOcean Component)
Fires once for each object, object version, or multipart upload returned when listing such items.
Syntax
public event OnObjectListHandler OnObjectList; public delegate void OnObjectListHandler(object sender, DigitalOceanObjectListEventArgs e); public class DigitalOceanObjectListEventArgs : EventArgs { public string BucketName { get; } public string ObjectName { get; } public string LastModified { get; } public long Size { get; } public string ETag { get; } public string OwnerId { get; } public string OwnerName { get; } public string UploadId { get; } public string VersionId { get; } public bool LatestVersion { get; } public bool Deleted { get; } }
Public Event OnObjectList As OnObjectListHandler Public Delegate Sub OnObjectListHandler(sender As Object, e As DigitalOceanObjectListEventArgs) Public Class DigitalOceanObjectListEventArgs Inherits EventArgs Public ReadOnly Property BucketName As String Public ReadOnly Property ObjectName As String Public ReadOnly Property LastModified As String Public ReadOnly Property Size As Long Public ReadOnly Property ETag As String Public ReadOnly Property OwnerId As String Public ReadOnly Property OwnerName As String Public ReadOnly Property UploadId As String Public ReadOnly Property VersionId As String Public ReadOnly Property LatestVersion As Boolean Public ReadOnly Property Deleted As Boolean End Class
Remarks
This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.
BucketName reflects the name of the bucket that the object is in.
ObjectName reflects the name of the object.
LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.
Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.
ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.
OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.
UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.
VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.
LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.
Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.
PartList Event (DigitalOcean Component)
Fires once for every part returned when listing a multipart upload's parts.
Syntax
public event OnPartListHandler OnPartList; public delegate void OnPartListHandler(object sender, DigitalOceanPartListEventArgs e); public class DigitalOceanPartListEventArgs : EventArgs { public int PartNumber { get; } public string ObjectName { get; } public string LastModified { get; } public long Size { get; } public string ETag { get; } public string OwnerId { get; } public string OwnerName { get; } }
Public Event OnPartList As OnPartListHandler Public Delegate Sub OnPartListHandler(sender As Object, e As DigitalOceanPartListEventArgs) Public Class DigitalOceanPartListEventArgs Inherits EventArgs Public ReadOnly Property PartNumber As Integer Public ReadOnly Property ObjectName As String Public ReadOnly Property LastModified As String Public ReadOnly Property Size As Long Public ReadOnly Property ETag As String Public ReadOnly Property OwnerId As String Public ReadOnly Property OwnerName As String End Class
Remarks
This event fires once for each multipart upload part returned when ListParts is called.
PartNumber reflects the part's number.
ObjectName reflects the name of the object the multipart upload is for.
LastModified reflects the last modified time of the part.
Size reflects the size, in bytes, of the part.
ETag reflects the part's ETag of the part.
OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.
PrefixList Event (DigitalOcean Component)
Fires once for each common prefix returned when listing objects.
Syntax
public event OnPrefixListHandler OnPrefixList; public delegate void OnPrefixListHandler(object sender, DigitalOceanPrefixListEventArgs e); public class DigitalOceanPrefixListEventArgs : EventArgs { public string BucketName { get; } public string Prefix { get; } }
Public Event OnPrefixList As OnPrefixListHandler Public Delegate Sub OnPrefixListHandler(sender As Object, e As DigitalOceanPrefixListEventArgs) Public Class DigitalOceanPrefixListEventArgs Inherits EventArgs Public ReadOnly Property BucketName As String Public ReadOnly Property Prefix As String End Class
Remarks
This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.
BucketName reflects the name of the bucket that the prefix is in.
Prefix is the common prefix.
Progress Event (DigitalOcean Component)
Fires during an upload or download to indicate transfer progress.
Syntax
public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, DigitalOceanProgressEventArgs e); public class DigitalOceanProgressEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public long TotalBytes { get; } public int PercentDone { get; } }
Public Event OnProgress As OnProgressHandler Public Delegate Sub OnProgressHandler(sender As Object, e As DigitalOceanProgressEventArgs) Public Class DigitalOceanProgressEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property TotalBytes As Long Public ReadOnly Property PercentDone As Integer End Class
Remarks
This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the component tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.
For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.
This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.
SSLServerAuthentication Event (DigitalOcean Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, DigitalOceanSSLServerAuthenticationEventArgs e); public class DigitalOceanSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As DigitalOceanSSLServerAuthenticationEventArgs) Public Class DigitalOceanSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (DigitalOcean Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, DigitalOceanSSLStatusEventArgs e); public class DigitalOceanSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As DigitalOceanSSLStatusEventArgs) Public Class DigitalOceanSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (DigitalOcean Component)
This event fires when a document starts transferring (after the headers).
Syntax
public event OnStartTransferHandler OnStartTransfer; public delegate void OnStartTransferHandler(object sender, DigitalOceanStartTransferEventArgs e); public class DigitalOceanStartTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnStartTransfer As OnStartTransferHandler Public Delegate Sub OnStartTransferHandler(sender As Object, e As DigitalOceanStartTransferEventArgs) Public Class DigitalOceanStartTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (DigitalOcean Component)
This event is fired while a document transfers (delivers document).
Syntax
public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, DigitalOceanTransferEventArgs e); public class DigitalOceanTransferEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public int PercentDone { get; } public string Text { get; }
public byte[] TextB { get; } }
Public Event OnTransfer As OnTransferHandler Public Delegate Sub OnTransferHandler(sender As Object, e As DigitalOceanTransferEventArgs) Public Class DigitalOceanTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property PercentDone As Integer Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() End Class
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
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: ""
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: ""
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: ""
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: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
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
bool (read-only)
Default: 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: ""
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: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
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: 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: ""
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: ""
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: "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. |
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: "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. |
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: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This 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 component. 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. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
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: ""
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: ""
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 (read-only)
Default: ""
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 Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 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 Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
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.
Encoded
string
Default: ""
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: ""
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.
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
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 component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
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 component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
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 data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
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 component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
Firewall Type
The firewall the component will connect through.
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 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: ""
This field contains the name or IP address of the 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 component throws an exception.
Password
string
Default: ""
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 component throws an exception.
Port
int
Default: 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: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
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: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
string
Default: ""
This field contains the Header contents.
Constructors
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
ProxyAuthSchemes
Default: 0
This field is used to tell the component 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 component. Look at the configuration file for the component 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
bool
Default: False
This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default: ""
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 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.
Port
int
Default: 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: ""
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
ProxySSLTypes
Default: 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 component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
string
Default: ""
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
QueryParam Type
A query parameter to send in the request.
Remarks
This type represents a query parameter to send in the request.
Fields
Name
string
Default: ""
The name of the query parameter.
This field specifies the name of the query parameter.
Value
string
Default: ""
The value of the query parameter.
This field specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.
Constructors
public QueryParam();
Public QueryParam()
public QueryParam(string name, string value);
Public QueryParam(ByVal Name As String, ByVal Value As String)
S3Bucket Type
This type represents a bucket.
Remarks
This type represents a bucket.
Fields
CreationDate
string (read-only)
Default: ""
The field includes the creation date of the bucket.
This field reflects the creation date of the bucket.
Name
string (read-only)
Default: ""
The field contains the name of the bucket.
This field reflects the name of the bucket.
OwnerDisplayName
string (read-only)
Default: ""
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: ""
The field contains the Id of the bucket's owner.
This field reflects the Id of the bucket's owner.
Constructors
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: ""
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 component will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this field is populated.
Value
string
Default: ""
This field contains the value of the metadata item.
This field specifies the value of the metadata item.
Constructors
public S3Metadata();
Public S3Metadata()
public S3Metadata(string name, string value);
Public S3Metadata(ByVal Name As String, ByVal Value As String)
S3Object Type
This type represents an object.
Remarks
This type represents an object.
Fields
Deleted
bool (read-only)
Default: 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: ""
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: ""
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
bool (read-only)
Default: 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: ""
This field contains the name (key) of the object.
This field reflects the name (key) of the object.
OwnerDisplayName
string (read-only)
Default: ""
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: ""
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: 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: ""
This field contains the storage class of the object.
This field reflects the storage class of the object.
UploadId
string (read-only)
Default: ""
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: ""
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
S3Part Type
This type represents a multipart upload part.
Remarks
This type represents a multipart upload part.
Fields
ETag
string (read-only)
Default: ""
This field contains the ETag of the part.
This field reflects the ETag of the part.
LastModified
string (read-only)
Default: ""
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: ""
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: ""
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: ""
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: 0
This field contains the number of the part.
This field reflects the number of the part.
Size
long (read-only)
Default: 0
This field contains the size of the part.
This field reflects the size of the part in bytes.
Constructors
Config Settings (DigitalOcean Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.DigitalOcean Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection property.
The component supports key-based credential profiles; i.e., those which include the aws_access_key_id, aws_secret_access_key, and (optionally) aws_session_token elements. Role-based profiles are not supported at this time.
In addition to the authentication-related elements mentioned above, the component also supports the region element, if it is present in the specified profile.
The component searches for the specified profile's information in the credentials and config files. The AWSProfileDir setting can be used to configure the directory where the component looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur.
Note: If the profile specified using this setting includes credential information, the UseEC2RoleCredentials setting will be ignored (if it is enabled).
By default, this setting is empty, which will cause the component to check the default location used by the AWS CLI: an .aws directory in the current user's home directory; i.e., %UserProfile%\.aws (Windows) or ~/.aws (Linux/macOS).
When downloading encrypted data with LocalFile set, the component will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is 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 DownloadFile 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 (eg: 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 config to the ETag to ensure a new version of the object does not already exist on the server.
Valid values are 5242880 (5MB) to 2147483647 (2GB). The default is 26214400 (25MB). Note that applications may need to increase this setting's value in order to upload very large objects; Amazon only allows 10000 parts to be uploaded for any given multipart upload.
If the amount of upload data provided when creating an object is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply.
Note: This setting is ignored if IMDSVersion is 1.
The default value is 2 and a session-oriented method will be used to retrieve temporary security credentials. When this setting is set to 1, a request/response 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 that this setting is only applicable if the SignCustomRequest setting is true; it is ignored otherwise.
The default value is false.
The default value is false.
If this setting is -1 (default), the server's default (1000) is used. Acceptable values are 1 to 1000 (inclusive).
If this setting is -1 (default), the server's default (1000) is used. Acceptable values are 1 to 1000 (inclusive).
Valid values for i are from 0 to (PrefixCount - 1).
This setting is always -1 when StorePrefixList is disabled.
If this 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 was successfully transferred before the interruption.
If this setting is disabled, then the component will treat resumed transfers as "new" transfers, and the values reported by the Progress 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 one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.
Note that the 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 component will behave as if this setting were 0 for the duration of the transfer.
Refer to CreateObject for more information.
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. Please note that 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 (5GB), inclusive. The default is 104857600 (100MB). If this setting is set to 0, the component will always perform a multipart upload when creating an object; if it is set to -1, the component will never perform a multipart upload.
By default, this setting is disabled.
In order for the component to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances" page in the Amazon IAM documentation for more information.
By default, this setting is false. When set to true the component will do the following before each request:
- 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 initiate a session. The request returns a token that must be included in subsequent requests.
- 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 through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through 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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through 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 component 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 component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
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 component 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 component 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 component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
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 component 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 component 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 components that do not directly expose Firewall properties.
If this entry is set, the component 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 components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components 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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components 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 component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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 configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
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 configuration setting has no effect if SSLProvider is set to Platform.
If set to True, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), 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 default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that 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 supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider 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 configuration setting is applicable only 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 component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component 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 configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "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 User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
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 component 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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (DigitalOcean Component)
Common Errors
600 | A server error occurred, and/or the component was unable to process the server's response. Please refer to the error message for more information. |
601 | An unsupported operation or action was attempted. |
602 | The RawRequest 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 (i.e., a name, path, Id, etc.) was specified. |
605 | An invalid index was specified. |
606 | An upload was aborted by the user before it could finish. |
607 | The specified resource is a folder and cannot be downloaded. |
608 | A download failed because the specified LocalFile already exists and Overwrite is false. |
609 | The component could not resume a download or upload. Please refer to the error message for more information. |
610 | An encrypted download could not be resumed because the DownloadTempFile 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. |
The component may also return one of the following error codes, which are inherited from other components.
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. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost 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 component is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |