AmazonRequest Component
Properties Methods Events Configuration Settings Errors
The AmazonRequest Component provides a generic interface to Amazon's Web Services.
Syntax
nsoftware.InAmazon.Amazonrequest
Remarks
The AmazonRequest Component allows you to access any Amazon Web Service except S3, and is useful if you wish to support a service not implemented by the /n software Amazon Integrator package. It can also be used to send custom requests to any web service supported by this package, with the exception of S3.
You will first need to sign up for the web service you wish to use, and obtain the AccessKey and SecretKey from Amazon, as well as the APIVersion. Then add the Parameters specific to that service. Then you can start sending messages to the URL for that service using either the Get or SubmitTo method. The component will properly order the parameters and compute the expiration and signature values automatically. You may parse the XML response using the X-properties provided (XPath, XElement, XText, etc.), or by use of the XML events. (StartElement, EndElement, Characters, etc.)
For instance, the following PAAPI request:
PAAPI.AccessKey = "XXXXXX";
PAAPI.SecretKey = "XXXXXXXXXXXXXXXX";
PAAPI.Operation = opBrowseNodeLookup;
PAAPI.AddParam("BrowseNodeId, "123456");
PAAPI.SendRequest();
can be made using the AmazonRequest component in the following manner:
AmazonRequest.AccessKey = "XXXXXX";
AmazonRequest.SecretKey = "XXXXXXXXXXXXXXXX";
AmazonRequest.APIVersion = "2009-01-01";
AmazonRequest.AddParameter("Operation", "BrowseNodeLookup");
AmazonRequest.AddParameter("Service", "AWSECommerceService");
AmazonRequest.AddParameter("BrowseNodeId", "123456");
AmazonRequest.Get("http://ecs.amazonaws.com/onca/xml");
You will need to refer to the Amazon Web Services documentation
for details on how to implement the service you intend to use with this component.
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. |
| APIVersion | Version of the API you're using to submit a transaction. |
| AttachedFile | A file to append to PostData if the POST or PUT methods are used. |
| BuildDOM | When True, an internal object model of the XML document is created. |
| Connected | Shows whether the component is connected. |
| ContentType | Content type for posts and puts. |
| Cookies | Collection of cookies. |
| 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 downloading. If the file exists, it is overwritten. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| Namespaces | A collection of namespaces in the current stack. |
| OtherHeaders | Other headers as determined by the user (optional). |
| Parameters | Parameters to be sent in the request. |
| ParsedHeaders | Collection of headers returned from the last request. |
| PostData | The data to post with the URL if the POST method is used. |
| Proxy | A set of properties related to proxy access. |
| 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. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum of bytes of data to be transferred. |
| TransferredHeaders | The full set of headers as received from the server. |
| URL | The URL to fetch. |
| Validate | When True, the parser checks that the document consists of well-formed XML. |
| XAttributes | A collection of attributes of the current element. |
| XChildren | Collection of child elements of the current element. |
| XElement | The name of the current element. |
| XErrorPath | An XPath to check the server response for errors. |
| XNamespace | The namespace of the current element. |
| XParent | The parent of the current element. |
| XPath | Provides a way to point to a specific element in the response. |
| XPrefix | The prefix of the current element. |
| XSubTree | A snapshot of the current element in the document. |
| XText | The text of the current element. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| AddParameter | Adds a parameter to the query string. |
| Attr | Returns the value of the specified attribute. |
| Config | Sets or retrieves a configuration setting . |
| DoEvents | Processes events from the internal message queue. |
| Get | Fetches the document using the HTTP GET method. |
| Interrupt | Interrupt the current method. |
| Reset | Resets the component. |
| ResetHeaders | Resets all HTTP headers, cookies, and localfile. |
| SubmitTo | Post current parameters to the URL specified by the 'URL' parameter. |
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.
| Characters | Fired for plain text segments of the input stream. |
| Comment | Fired when a comment section is encountered. |
| Connected | Fired immediately after a connection completes (or fails). |
| ConnectionStatus | Fired to indicate changes in connection state. |
| Disconnected | Fired when a connection is closed. |
| EndElement | Fired when an end-element tag is encountered. |
| EndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
| Error | Information about errors during data delivery. |
| EvalEntity | Fired every time an entity needs to be evaluated. |
| Header | Fired every time a header line comes in. |
| IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
| Meta | Fired when a meta section is encountered. |
| PI | Fired when a processing instruction section is encountered. |
| Redirect | Fired when a redirection is received from the server. |
| SetCookie | Fired for every cookie set by the server. |
| SpecialSection | Fired when a special section is encountered. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| StartElement | Fired when a begin-element tag is encountered in the document. |
| StartPrefixMapping | Fired when entering the scope of a namespace declaration. |
| Status | Fired when the HTTP status line is received from the server. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| CacheContent | If true, the original XML is saved in a buffer. |
| ErrorCodePath | The path to the error code in the response. |
| ErrorMessagePath | The path to the error message in the response. |
| Region | The region to which the request is made. |
| ServiceName | The name of the service being used. |
| SignatureDate | The Date header to send to Amazon. |
| SignatureVersion | The version of signature used. |
| From | Allows the specification of the email address of the HTTP agent. |
| CacheContent | If true, the original XML is saved in a buffer. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| 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. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| 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. |
| 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. |
| 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). |
| 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 TCP 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. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| 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. |