Amazon Integrator SQS Component : SQS OCX, SQS .NET Component, SQS Class, SQS Bean, SQS Object

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 SQS Component allows you to access Amazon's Simple Queue Service (SQS). SQS allows you to create globally accessible queues on Amazon's servers. These queues can be used by developers to transfer data between distributed application components, without losing messages or requiring each component to always be available. A brief synopsis follows but please refer to Amazon SQS documentation for details.

You will first need to sign up for the SQS service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating queues in your account using CreateQueue. You can then start adding message's to the queue using CreateMessage and retrieve the same using ListMessages.

There are other methods such as ListQueues, DeleteQueue, DeleteMessage etc. that further enable you to manage your SQS queues.

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.
AttributesCount	The number of records in the Attributes arrays.
AttributesName	The name of the attribute.
AttributesValue	The value of the attribute.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MaxMessages	The maximum number of messages retrieved from the queue.
MessagesCount	The number of records in the Messages arrays.
MessagesBody	The body of the SQS message.
MessagesId	The ID of the SQS message.
MessagesMD5	The MD5 of the SQS message.
MessagesReceiptHandle	The Receipt handle of the SQS message.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
QueuePrefix	QueuePrefix can be used to filter the queues listed.
QueuesCount	The number of records in the Queues arrays.
QueuesId	The ID of the SQS queue.
QueuesUrl	The URL of the SQS queue.
Referer	Referer URL/document (optional).
SecretKey	The Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If 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.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
VisibilityTimeout	The visibility duration for messages in the queue.

Method List

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


AddPermission	Adds a permission to a queue for a specific account, which allows for sharing access to the queue.
ChangeMessageVisibility	Changes the visibility timeout of a message.
Config	Sets or retrieves a configuration setting.
CreateMessage	Adds a message to a queue.
CreateQueue	Creates an SQS queue.
DeleteMessage	Deletes the message specified.
DeleteQueue	Deletes a queue.
DoEvents	Processes events from the internal message queue.
GetQueueAttributes	Returns all attributes of a queue.
GetXValue	Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest.
Interrupt	Interrupt the current method.
ListMessages	Gets messages from the queue.
ListQueues	Lists the queues under the current account.
RemovePermission	The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter.
Reset	Resets request-related properties.
ResetHeaders	Resets all HTTP headers, cookies, and localfile.
SendCustomRequest	Allows the sending of a custom request to an Amazon web service.
SetQueueAttribute	Sets an attribute of a queue.

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.


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.
Message	Fired for each message retrieved from the queue.
Queue	Fired for each queue of the user.
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.


APIVersion	Amazon'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 Amazon.
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.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
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.
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.
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.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
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;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
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.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
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).
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.
CodePage	The system code page used for Unicode to Multibyte translations.

|

About

|

Privacy Policy

|

Terms of Use

|