The Net Tools Company - 800.225.4190
Search: 
Available in: AMAZON
SimpleDB Component [Amazon Integrator V5]

Properties   Methods   Events   Configuration Settings  

The SimpleDB Component provides an easy interface to Amazon's SimpleDB.

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 SimpleDB Component allows you to access Amazon's SimpleDB. SimpleDB allows you to create globally accessible databases on Amazon's servers. These databases can be used by developers to transfer data between distributed applications and store information. A brief synopsis follows, but please refer to Amazon SimpleDB documentation for details.

You will first need to sign up for the SimpleDB service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating domains in your account using CreateDomain. You can then start adding items and attributes to the queue using PutAttributes and retrieve the same using Select.

There are other methods such as ListDomains, DeleteDomain, DeleteAttributes etc. that further enable you to manage your SimpleDB domains and items.

Property List


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

AccessKeyThe Access Key Id for the Amazon Web Services account.
AttributesCountThe number of records in the Attributes arrays.
AttributesNameThe name of the attribute.
AttributesReplaceThe replacement flag of the current Simple DB attribute.
AttributesValueThe value of the attribute.
DomainNameThe domain name to use for all operations.
DomainCountThe number of records in the Domain array.
DomainA list of domains for an account.
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.
FollowRedirectsDetermines what happens when the server issues a redirect.
ItemCountThe number of records in the Item arrays.
ItemAttrCountNumber of attributes for the current item.
ItemAttrIndexThe index of the selected attribute of the current item.
ItemAttrNameThe name of the attribute selected by AttrIndex.
ItemAttrValueThe value of the attribute selected by AttrIndex.
ItemNameThe name of the SimpleDB item.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NextTokenAllows one to set the value to start searching for the next query while calling ListDomains or Select.
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.
SecretKeyThe Secret Access Key for the Amazon Web Services account.
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).
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
UseSSLUse SSL to access Amazon SimpleDB.

Method List


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

ConfigSets or retrieves a configuration setting.
CreateDomainCreates a SimpleDB domain.
DeleteAttributesDeletes the current collection of Attributes in the domain specified by DomainName and the parameter ItemName.
DeleteDomainDeletes a SimpleDB domain.
DoEventsProcesses events from the internal message queue.
GetAttributesRetrieves the current collection of Attributes from the domain specified by DomainName and the parameter ItemName.
GetXValueRetrieves a valid XPath expression from the HTTP response after calling SendCustomRequest.
InterruptInterrupt the current method.
ListDomainsLists the SimpleDB domains of the specified account.
PutAttributesPuts the current collection of Attributes to the domain specified by DomainName and the parameter ItemName.
ResetResets request-related properties.
ResetAttributesResets the entire attribute collection.
SelectPerforms a select query on a SimpleDB Domain.
SendCustomRequestAllows the sending of a custom request to an Amazon web service.

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.

AttributeFired after an attribute is retrieved from the specified Item while calling GetAttributes.
DomainFired for each domain of the user.
ErrorInformation about errors during data delivery.
ItemFired for each valid item name that is returned after a call to Select.
MetadataFired when valid Amazon metadata is returned after a SimpleDB method call.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

BatchPutAttributesUses the BatchPutAttributes operation.
Items[index].AttrReplaceSet the replace flag for an item attribute.
MaxNumberOfDomainsThe maximum number of domains to retrieve while listing domains.
APIVersionAmazon's API version.
HTTPMethodSpecifies the HTTP method to use when sending a custom request.
SignCustomRequestTells the component to sign the outgoing request.
TransferredDataReturns the entire XML response received from Amazon.
URLIf set, the default URL will be overridden by this value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AuthorizationThe Authorization string to be sent to the server.
EncodeURLIf set to true the URL will be encoded by the component.
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.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
UseIPv6Whether or not to use IPv6.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallTypeDetermines the type of firewall to connect through.
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.
| About | Privacy Policy | Terms of Use |
© Copyright 2012 /n software inc.