DigitalOcean Component
Properties Methods Events Configuration Settings Errors
The DigitalOcean Component provides an easy way to interface with DigitalOcean's Spaces service.
Syntax
nsoftware.InCloudStorage.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 Id for the Amazon Web Services account. |
AccessPolicy | The AccessPolicy are used to set permissions when a Bucket or an object is updated. |
Bucket | The name of the current bucket. |
Buckets | The list of buckets returned by a call to ListBuckets . |
Connected | Shows whether the component is connected. |
ContentDisposition | Content disposition for the object. |
ContentType | Content type for the object. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The password to use when encrypting the object. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
Idle | The current status of the component. |
LocalFile | The path to a local file for uploading or downloading. When downloading, if the file exists it is overwritten (optional). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
ObjectData | The contents of the object returned after calling GetObject , or the data to upload. |
ObjectDelimiter | A delimiter can be used to organize multiple objects. |
ObjectMarker | A marker for the object(s). |
ObjectPrefix | A prefix for the object(s). |
Objects | The objects returned by a call to ListObjects . |
OtherHeaders | Other headers as determined by the user (optional). |
Overwrite | Whether or not the component should overwrite files during transfer. |
ParsedHeaders | Collection of headers returned from the last request. |
Parts | The parts returned by a call to ListParts . |
Proxy | A set of properties related to proxy access. |
Range | The byte-range to be sent to the server. |
Referer | Referer URL/document (optional). |
Region | The region where the bucket is located. |
SecretKey | The Secret Access Key for the Amazon Web Services account. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
StatusLine | The first line of the last server response. |
Timeout | A timeout for the component. |
UseVirtualHosting | Determines which style request to use. |
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. |
AddUserMetaData | Adds meta data to an object. |
CompleteMultipartUpload | Completes a multipart upload by assembling previously uploaded parts. |
Config | Sets or retrieves a configuration setting . |
CopyObject | Make a copy of the specified object. |
CopyPart | Copy the specified object as a part of a multipart upload. |
CreateBucket | Creates a new bucket. |
CreateObject | Puts an object into a bucket. |
DeleteBucket | Deletes a bucket. |
DeleteObject | Deletes the specified object. |
DoEvents | Processes events from the internal message queue. |
GetBucketLocation | Returns the location of the specified bucket. |
GetLink | Creates a link to an object which expires in seconds specified. |
GetObject | Gets an object from a bucket. |
GetObjectInfo | Returns the meta-data for the indicated object. |
GetXValue | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . |
Interrupt | Interrupt the current method. |
ListBuckets | Lists all buckets in the account. |
ListMultipartUploads | Lists current multipart uploads. |
ListObjects | Lists all objects in a bucket. |
ListParts | Lists all parts in a current multipart upload. |
Reset | Resets request-related properties. |
ResetHeaders | Resets all HTTP headers, cookies, and localfile. |
SendCustomRequest | Sends a custom request to DigitalOcean. |
SetDownloadStream | Sets the stream to which the downloaded data from the server will be written. |
SetUploadStream | Sets the stream to be uploaded to the server. |
StartMultipartUpload | Starts a multipart upload and returns an UploadId. |
UpdateBucketACL | Updates the access policy of the specified bucket. |
UpdateObjectACL | Updates the access policy of the specified object. |
UploadPart | Uploads a part in a multipart upload. |
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 | Fired for every bucket when ListBuckets is called. |
Connected | Fired immediately after a connection completes (or fails). |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
ObjectList | Fired for every object when ListObjects , or upload when ListMultipartUploads is called. |
PartList | Fired for every part when ListParts is called. |
PrefixList | Fired for every prefix returned as a common prefix. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Status | Fired when the HTTP status line is received from the server. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
LocationConstraint | The region where buckets will be created. |
Region | The region whose endpoint will be used. |
IfMatch | Check to make sure the object has not been modified since the last request. |
EventObjectSize | Used to retrieve the full object size from inside the ObjectList event. |
ObjectSize | Used to set and retrieve object sizes information beyond the range of an integer. |
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. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during AES encryption/decryption. |
ETag | The ETag for the object returned by the server. |
EnforceBucketNameRestrictions | Whether or not to enforce bucket naming conventions. |
IncludeObjectMD5 | Includes the MD5 digest of the object data if set. |
IncludePartMD5 | Includes the MD5 digest of the part data if set. |
IsPaged | Whether or not all objects were returned by the last listing. |
MaxParts | The maximum number of parts in a multipart upload returned when calling ListParts. |
MaxObjects | The maximum number of objects for the server to return. |
PartNumberMarker | The marker indicating the start of the next part list. |
Prefix[i] | The common prefix at index 'i'. |
PrefixCount | The number of common prefixes. |
PrefixOtherData[i] | The common prefix other data at index 'i'. |
ResponseContentType | Sets the Content-Type header of the response. |
ResponseContentLanguage | Sets the Content-Language header of the response. |
ResponseExpires | Sets the Expires header of the response. |
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. |
SessionToken | The session token to send in the request when using temporary credentials. |
SigningTime | A custom date to send to the component to use while signing all requests. |
SignatureVersion | The version of signature used. |
StorePrefixList | If true, store the common prefixes when ListObjects is called. |
TempPath | If set, the temporary files created during decryption will be put in the path specified. |
APIVersion | Service's API version. |
HTTPMethod | Specifies the HTTP method to use when sending a custom request. |
SignCustomRequest | Tells the component to sign the outgoing request. |
TransferredData | Returns the entire XML response received from the server. |
URL | If set, the default URL will be overridden by this value. |
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. |
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. |
HTTPVersion | The version of HTTP used by the component. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
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. |
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. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
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 (IPPort 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. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
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. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
TcpNoDelay | Whether or not to delay when sending packets. |
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. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
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. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
UseBackgroundThread | Whether threads created by the component are background threads. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |