IBiz Amazon s3 Component : s3 OCX, s3 .NET Component, s3 Class, s3 Bean, s3 Object

Available in: AMAZON | S3

S3 Component [IBiz Amazon Integrator V2]

Properties Methods Events Configuration Settings

The S3 component provides an easy interface to Amazon's Simple Storage Service (S3).

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The S3 component allows you to access Amazon's Simple Storage Service (S3) in a secure manner using SSL. S3 allows you to store arbitrary data object's on Amazon's server and access them from anywhere using an Internet connection. There are features available to authenticate access to private object's, share object's as public, distribute an object using Bittorrent etc. A brief synopsis follows but please refer to http://aws.amazon.com/s3 for details.

You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. 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 S3 data store.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


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.
Connected	Shows whether the component is connected.
ContentDisposition	Content disposition for the object.
ContentType	Content type for the object.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	Port of the firewall to connect to.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
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.
ObjectDelimiter	A delimiter can be used to roll up a bunch of keys.
ObjectMarker	A marker for the object(s).
ObjectPrefix	A prefix for the object(s).
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	Similar to the Authorization property, but for proxy authorization.
ProxyPassword	A password if Basic authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy.
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if Basic authentication is to be used for the proxy.
Range	The byte-range to be sent to the server.
Referer	Referer URL/document (optional).
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
SecretKey	The Secret Access Key for the Amazon Web Services account.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
UseSSL	Use SSL to access Amazon S3.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AddUserMetaData	Adds meta data to an object.
Config	Sets or retrieves a component configuration setting.
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.
GetLink	Creates a link to an object which expires in seconds specified.
GetObject	Gets an object from a bucket.
GetTorrent	Gets an object from a bucket as a torrent.
Interrupt	Interrupt the current method.
ListBuckets	Lists all buckets in the account.
ListObjects	Lists all objects in a bucket;.
ResetHeaders	Resets all HTTP headers, cookies, and LocalFile.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


BucketList	Fired for every bucket when 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 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 complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FollowRedirects	Whether or not to follow redirects.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
IsTruncated	Whether or not all objects were returned by the last listing.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
LocationConstraint	The location where buckets will be created.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxObjects	The maximum number of objects for the server to return.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator(PRNG).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic 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 Basic authentication is to be used for the proxy.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification
SocketHandle	The handle of the main socket used by the component.
UseVirtualHosting	Determines which style request to use.
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)