Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

CloudStorage Class

Properties   Methods   Events   Configuration Settings   Errors  

The CloudStorage component provide an easy way to upload, download, and manage files and folders with multiple service providers.

Syntax

incloudstorage.cloudstorage()

Remarks

The CloudStorage class provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this class:

  • Amazon S3
  • Box.com
  • Dropbox
  • Google Drive
  • Microsoft OneDrive
  • SharePoint Online

The class supports simple file and folder management as well as encryption. Capabilities include uploading and downloading files, strong encryption support, creating folders, and more.

To begin, first create an account and register your application. Consult the documentation of the individual service provider for instructions on this process.

Authentication

The following providers use OAuth 2.0 for authentication:

  • Box
  • Dropbox
  • Google Drive
  • Microsoft OneDrive

Use the OAuth class included in the toolkit, or any other OAuth implementation to perform authentication and retrieve an authorization string. Once you've obtained an authorization string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. Consult the service provider documentation for more information about supported scope values and more details on OAuth authentication.

To authenticate with Amazon S3 set AccountAccessKey and AccountSecretKey. To authenticate with SharePoint Online set AccountURL, AccountUser, and AccountPassword.

Selecting a Provider

To specify the provider simply set ServiceProvider. This tells the class to which service requests will be made.

Listing Files and Folders

ListDirectory lists files and folder the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties.


cloudstorage.RemoteFile = ""; //Clear filemask
cloudstorage.RemotePath = "MyFolder";
cloudstorage.ListDirectory();
for (int i = 0; i < cloudstorage.DirList.Count; i++)
{
  Console.WriteLine(cloudstorage.DirList[i].FileName);
  Console.WriteLine(cloudstorage.DirList[i].FileSize);
  Console.WriteLine(cloudstorage.DirList[i].FileTime);
  Console.WriteLine(cloudstorage.DirList[i].IsDir);
}

The RemoteFile property may also be used as a filemask when listing files. For instance:


component.RemoteFile = "*.txt"
component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

If LocalFile is set the file will be saved to the specified location. If LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method.


cloudstorage.RemotePath = "My Folder";
cloudstorage.RemoteFile = "MyFile.zip";
cloudstorage.LocalFile = "../MyFile.zip";
cloudstorage.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download.


cloudstorage.RemotePath = myRemoteFolder;
cloudstorage.RemoteFile = myRemoteFile;
cloudstorage.LocalFile = downloadFile;
cloudstorage.Download();

//The transfer is interrupted and Download() above fails. Later, resume the download:

//Get the size of the partially download file
cloudstorage.StartByte = new FileInfo(downloadFile).Length; 
cloudstorage.RemotePath = myRemoteFolder;
cloudstorage.RemoteFile = myRemoteFile;
cloudstorage.LocalFile = downloadFile;
cloudstorage.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, 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.

cloudstorage.RemotePath = myRemoteFolder;
cloudstorage.RemoteFile = myRemoteFile;
cloudstorage.LocalFile = downloadFile;
cloudstorage.EncryptionPassword = "password";
cloudstorage.Download();

//The transfer is interrupted and Download() above fails. Later, resume the download:

//Get the size of the partially download temp file
cloudstorage.StartByte = new FileInfo(cloudstorage.Config("DownloadTempFile")).Length; 
cloudstorage.RemotePath = myRemoteFolder;
cloudstorage.RemoteFile = myRemoteFile;
cloudstorage.LocalFile = downloadFile;
cloudstorage.EncryptionPassword = "password";
cloudstorage.Download();

Uploading Files

The Upload method is used to upload files.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example:

//Upload with a relative path
cloudstorage.LocalFile = "C:\localfile.txt"
cloudstorage.RemoteFile = "remotefile.txt"
cloudstorage.Upload()

//Upload with an absolute path
cloudstorage.LocalFile = "C:\localfile2.txt"
cloudstorage.RemoteFile = "/folder/remotefile2.txt"
cloudstorage.Upload()

Additional Functionality

The CloudStorage class offers advanced functionality beyond simple uploads and downloads. For instance:

Property List


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

AccountAccessKeyThis property specifies the Amazon S3 Access Key.
AccountPasswordThis property specifies the SharePoint user's password.
AccountSecretKeyThis property specifies the Amazon S3 Secret Key.
AccountURLThis property specifies the SharePoint site URL.
AccountUserThis property specifies the SharePoint user.
AuthorizationOAuth 2.0 Authorization Token.
DirListCountThe number of records in the DirList arrays.
DirListFileNameThis property holds the name of the file or folder.
DirListFileSizeThis property holds the size of the file in bytes.
DirListFileTimeThis property holds the modified date of the file.
DirListIsDirThis property specifies whether the entry is a directory.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OverwriteWhether to overwrite the local or remote file.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RemoteFileThe name of the remote file.
RemotePathThe current path on the server.
ServiceProviderThe storage service provider.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartByteThe byte offset from which to start download.
TimeoutA timeout for the component.

Method List


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

ConfigSets or retrieves a configuration setting .
DeleteFileRemove a file specified by FileName from the server.
DownloadDownload the specified file.
InterruptInterrupt the current method.
ListDirectoryLists the current directory specified by RemotePath on the server.
MakeDirectoryCreates a directory on the server.
RemoveDirectoryRemove the specified directory.
RenameFileRenames the file.
UploadUploads the file specified by LocalFile to the server.

Event List


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

DirListFired when a directory entry is received.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired while a document transfers (delivers document).

Configuration Settings


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

DateFormatThe date format of the file time.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
XPathProvides a way to point to a specific element in the returned XML response.
XElementThe name of the current element.
XParentThe parent of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
XChildCountThe number of child elements of the current element.
XChildName[x]The name of the child element.
XChildXText[x]The inner text of the child element.
TempPathThe path to the directory where temporary files are created.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0