# AmazonSQS Class The AmazonSQS Class provides an easy interface to Amazon's Simple Queue Service (SQS). ## Syntax ```text ipworksmq.AmazonSQS ``` ## Remarks The AmazonSQS Class 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](http://aws.amazon.com/sqs) for details. You will first need to sign up for the SQS service and obtain the [AccessKey](#accesskey-property-amazonsqs-class) and [SecretKey](#secretkey-property-amazonsqs-class) from Amazon. Then you can start creating queues in your account using [CreateQueue](#createqueue-method-amazonsqs-class). You can then start adding message's to the queue using [CreateMessage](#createmessage-method-amazonsqs-class) and retrieve the same using [ListMessages](#listmessages-method-amazonsqs-class). There are other methods such as [ListQueues](#listqueues-method-amazonsqs-class), [DeleteQueue](#deletequeue-method-amazonsqs-class), [DeleteMessage](#deletemessage-method-amazonsqs-class) etc. that further enable you to manage your SQS queues. SmoothMQ is also supported. For compatibility with SmoothMQ, [APIRequestFormat](#APIRequestFormat) must be set to 2. Additionally, it is advisable to set [ResolveQueueId](#ResolveQueueId) to true. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessKey](#accesskey-property-amazonsqs-class) | The Access Key Id for the Amazon Web Services account. | | [Attributes](#attributes-property-amazonsqs-class) | A list of attributes for a queue. | | [Firewall](#firewall-property-amazonsqs-class) | A set of properties related to firewall access. | | [LocalHost](#localhost-property-amazonsqs-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [MaxMessages](#maxmessages-property-amazonsqs-class) | The maximum number of messages retrieved from the queue. | | [Messages](#messages-property-amazonsqs-class) | The messages retrieved as a result of calling ListMessages . | | [OtherHeaders](#otherheaders-property-amazonsqs-class) | Other headers as determined by the user (optional). | | [Proxy](#proxy-property-amazonsqs-class) | A set of properties related to proxy access. | | [QueuePrefix](#queueprefix-property-amazonsqs-class) | QueuePrefix can be used to filter the queues listed. | | [Queues](#queues-property-amazonsqs-class) | The queues retrieved as a result of calling ListMessages . | | [Referer](#referer-property-amazonsqs-class) | This property includes the referer URL/document (optional). | | [SecretKey](#secretkey-property-amazonsqs-class) | The Secret Access Key for the Amazon Web Services account. | | [SSLAcceptServerCert](#sslacceptservercert-property-amazonsqs-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-amazonsqs-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-amazonsqs-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-amazonsqs-class) | The server certificate for the last established connection. | | [StatusLine](#statusline-property-amazonsqs-class) | This property is the first line of the last server response. | | [Timeout](#timeout-property-amazonsqs-class) | The timeout for the class. | | [UseSSL](#usessl-property-amazonsqs-class) | Use SSL when accessing the service. | | [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class) | The visibility duration for messages in the queue. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddPermission](#addpermission-method-amazonsqs-class) | Adds a permission to a queue for a specific account, which allows for sharing access to the queue. | | [ChangeMessageVisibility](#changemessagevisibility-method-amazonsqs-class) | Changes the visibility timeout of a message. | | [Config](#config-method-amazonsqs-class) | Sets or retrieves a configuration setting. | | [CreateMessage](#createmessage-method-amazonsqs-class) | Adds a message to a queue. | | [CreateQueue](#createqueue-method-amazonsqs-class) | Creates an SQS queue. | | [DeleteMessage](#deletemessage-method-amazonsqs-class) | Deletes the message specified. | | [DeleteQueue](#deletequeue-method-amazonsqs-class) | Deletes a queue. | | [DoEvents](#doevents-method-amazonsqs-class) | This method processes events from the internal message queue. | | [GetQueueAttributes](#getqueueattributes-method-amazonsqs-class) | Returns all attributes of a queue. | | [GetXValue](#getxvalue-method-amazonsqs-class) | Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . | | [Interrupt](#interrupt-method-amazonsqs-class) | This method interrupts the current method. | | [ListMessages](#listmessages-method-amazonsqs-class) | Gets messages from the queue. | | [ListQueues](#listqueues-method-amazonsqs-class) | Lists the queues under the current account. | | [RemovePermission](#removepermission-method-amazonsqs-class) | The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter. | | [Reset](#reset-method-amazonsqs-class) | Resets request-related properties. | | [ResetHeaders](#resetheaders-method-amazonsqs-class) | Resets all HTTP headers, cookies, and LocalFile. | | [SendCustomRequest](#sendcustomrequest-method-amazonsqs-class) | Allows the sending of a custom request to an Amazon web service. | | [SetQueueAttribute](#setqueueattribute-method-amazonsqs-class) | Sets an attribute of a queue. | ## 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.* | | | | --- | --- | | [Connected](#connected-event-amazonsqs-class) | Fired immediately after a connection completes (or fails). | | [Disconnected](#disconnected-event-amazonsqs-class) | Fired when a connection is closed. | | [EndTransfer](#endtransfer-event-amazonsqs-class) | Fired when a document finishes transferring. | | [Error](#error-event-amazonsqs-class) | Fired when information is available about errors during data delivery. | | [Header](#header-event-amazonsqs-class) | Fired every time a header line comes in. | | [Message](#message-event-amazonsqs-class) | Fired for each message retrieved from the queue. | | [Queue](#queue-event-amazonsqs-class) | Fired for each queue of the user. | | [SSLServerAuthentication](#sslserverauthentication-event-amazonsqs-class) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-amazonsqs-class) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-amazonsqs-class) | Fired when a document starts transferring (after the headers). | | [Status](#status-event-amazonsqs-class) | Fired when the HTTP status line is received from the server. | | [Transfer](#transfer-event-amazonsqs-class) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [APIRequestFormat](#APIRequestFormat) | Changes the API request format. | | [APIVersion](#APIVersion) | Service's API version. | | [HTTPMethod](#HTTPMethod) | Specifies the HTTP method to use when sending a custom request. | | [MessageAttributeCount](#MessageAttributeCount) | The number of message attributes. | | [MessageAttributeDataType\[i\]](#MessageAttributeDataType[i]) | The data type of the message attribute. | | [MessageAttributeName\[i\]](#MessageAttributeName[i]) | The name of the message attribute. | | [MessageAttributeValue\[i\]](#MessageAttributeValue[i]) | The value of the message attribute. | | [MessageDeduplicationId](#MessageDeduplicationId) | The message deduplication ID for the message being created. | | [MessageGroupId](#MessageGroupId) | The ID of the message group to which the message belongs. | | [PurgeQueue](#PurgeQueue) | Deletes all messages in a queue specified by the QueueId. | | [Region](#Region) | The region the class will make requests against. | | [ResolveQueueId](#ResolveQueueId) | If set to true (default false), requests that require Queue URL can also be resolved using the Queue ID. | | [SignatureVersion](#SignatureVersion) | The version of signature used. | | [SignCustomRequest](#SignCustomRequest) | Tells the class to sign the outgoing request. | | [TransferredData](#TransferredData) | Returns the entire XML response received from the server. | | [URL](#URL) | If set, the default URL will be overridden by this value. | | [UseEC2RoleCredentials](#UseEC2RoleCredentials) | If set, authenticate requests with credentials obtained from the specified IAM role attached to the EC2 instance. | | [UseFIFOQueues](#UseFIFOQueues) | Whether queues should always be created as FIFO queues. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [AllowNTLMFallback](#AllowNTLMFallback) | Whether to allow fallback from Negotiate to NTLM when authenticating. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxHeaders](#MaxHeaders) | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. | | [MaxHTTPCookies](#MaxHTTPCookies) | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformDeflate](#UsePlatformDeflate) | Whether to use the platform implementation to decompress compressed responses. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the class will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallListener](#FirewallListener) | If true, the class binds to a SOCKS firewall as a server (TCPClient only). | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLContextProtocol](#SSLContextProtocol) | The protocol used when getting an SSLContext instance. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [SSLTrustManagerFactoryAlgorithm](#SSLTrustManagerFactoryAlgorithm) | The algorithm to be used to create a TrustManager through TrustManagerFactory. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | # AccessKey Property ([AmazonSQS](#amazonsqs-class) Class) The Access Key Id for the Amazon Web Services account. ## Syntax ```text public String getAccessKey(); public void setAccessKey(String accessKey); ``` ## Default Value "" ## Remarks This is the username for the Amazon Web Services account. No two accounts may have the same Access Key. This is used along with the [SecretKey](#secretkey-property-amazonsqs-class) to authenticate with Amazon servers. # Attributes Property ([AmazonSQS](#amazonsqs-class) Class) A list of attributes for a queue. ## Syntax ```text public SQSAttributeList getAttributes(); ``` ## Remarks After a call to [GetQueueAttributes](#getqueueattributes-method-amazonsqs-class), Attributes will contain the attributes of the queue specified in the [GetQueueAttributes](#getqueueattributes-method-amazonsqs-class) request. This property is read-only and not available at design time. Please refer to the [SQSAttribute](#sqsattribute-type) type for a complete list of fields. # Firewall Property ([AmazonSQS](#amazonsqs-class) Class) A set of properties related to firewall access. ## Syntax ```text public Firewall getFirewall(); public void setFirewall(Firewall firewall); ``` ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. Please refer to the [Firewall](#firewall-type) type for a complete list of fields. # LocalHost Property ([AmazonSQS](#amazonsqs-class) Class) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public String getLocalHost(); public void setLocalHost(String localHost); ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # MaxMessages Property ([AmazonSQS](#amazonsqs-class) Class) The maximum number of messages retrieved from the queue. ## Syntax ```text public int getMaxMessages(); public void setMaxMessages(int maxMessages); ``` ## Default Value 1 ## Remarks The maximum number of messages retrieved by [ListMessages](#listmessages-method-amazonsqs-class). This is not the number of messages that will be returned, but just the maximum number that will be returned. Amazon's SQS service dictates that this parameter should be between 1 to 10, all other values are illegal. # Messages Property ([AmazonSQS](#amazonsqs-class) Class) The messages retrieved as a result of calling ListMessages . ## Syntax ```text public SqsMessageList getMessages(); ``` ## Remarks This property will be populated with a list of messages after a call to [ListMessages](#listmessages-method-amazonsqs-class). This property is read-only and not available at design time. Please refer to the [SqsMessage](#sqsmessage-type) type for a complete list of fields. # OtherHeaders Property ([AmazonSQS](#amazonsqs-class) Class) Other headers as determined by the user (optional). ## Syntax ```text public String getOtherHeaders(); public void setOtherHeaders(String otherHeaders); ``` ## Default Value "" ## Remarks This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From. The headers must follow the format *Header: Value* as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the class beyond what is provided. This property is not available at design time. # Proxy Property ([AmazonSQS](#amazonsqs-class) Class) A set of properties related to proxy access. ## Syntax ```text public Proxy getProxy(); public void setProxy(Proxy proxy); ``` ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. Please refer to the [Proxy](#proxy-type) type for a complete list of fields. # QueuePrefix Property ([AmazonSQS](#amazonsqs-class) Class) QueuePrefix can be used to filter the queues listed. ## Syntax ```text public String getQueuePrefix(); public void setQueuePrefix(String queuePrefix); ``` ## Default Value "" ## Remarks Only the queues whose names start with the specified QueuePrefix are listed when [ListQueues](#listqueues-method-amazonsqs-class) is called. # Queues Property ([AmazonSQS](#amazonsqs-class) Class) The queues retrieved as a result of calling ListMessages . ## Syntax ```text public SqsQueueList getQueues(); ``` ## Remarks This property will be populated with a list of queues after a call to [ListQueues](#listqueues-method-amazonsqs-class). This property is read-only and not available at design time. Please refer to the [SqsQueue](#sqsqueue-type) type for a complete list of fields. # Referer Property ([AmazonSQS](#amazonsqs-class) Class) This property includes the referer URL/document (optional). ## Syntax ```text public String getReferer(); public void setReferer(String referer); ``` ## Default Value "" ## Remarks If this property contains a nonempty string, a *Referer* HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL. This property is not available at design time. # SecretKey Property ([AmazonSQS](#amazonsqs-class) Class) The Secret Access Key for the Amazon Web Services account. ## Syntax ```text public String getSecretKey(); public void setSecretKey(String secretKey); ``` ## Default Value "" ## Remarks This property describes the secret key to the Amazon account. It should not be shared with others. The SecretKey is used along with the [AccessKey](#accesskey-property-amazonsqs-class) in the authentication process with Amazon servers. # SSLAcceptServerCert Property ([AmazonSQS](#amazonsqs-class) Class) Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert); ``` ## Remarks If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally. NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLCert Property ([AmazonSQS](#amazonsqs-class) Class) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert); ``` ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SSLProvider Property ([AmazonSQS](#amazonsqs-class) Class) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2; ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # SSLServerCert Property ([AmazonSQS](#amazonsqs-class) Class) The server certificate for the last established connection. ## Syntax ```text public Certificate getSSLServerCert(); ``` ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. This property is read-only. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # StatusLine Property ([AmazonSQS](#amazonsqs-class) Class) This property is the first line of the last server response. ## Syntax ```text public String getStatusLine(); ``` ## Default Value "" ## Remarks This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the StatusLine property. The HTTP protocol specifies the structure of the StatusLine as follows: [HTTP version] [Result Code] [Description]. This property is read-only and not available at design time. # Timeout Property ([AmazonSQS](#amazonsqs-class) Class) The timeout for the class. ## Syntax ```text public int getTimeout(); public void setTimeout(int timeout); ``` ## Default Value 60 ## Remarks If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If Timeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use [DoEvents](#doevents-method-amazonsqs-class) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If Timeout expires, and the operation is not yet complete, the class throws an exception. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # UseSSL Property ([AmazonSQS](#amazonsqs-class) Class) Use SSL when accessing the service. ## Syntax ```text public boolean isUseSSL(); public void setUseSSL(boolean useSSL); ``` ## Default Value True ## Remarks Use this property to specify whether the class should use SSL when connecting to the service. This property is not available at design time. # VisibilityTimeout Property ([AmazonSQS](#amazonsqs-class) Class) The visibility duration for messages in the queue. ## Syntax ```text public int getVisibilityTimeout(); public void setVisibilityTimeout(int visibilityTimeout); ``` ## Default Value -1 ## Remarks Visibility timeout is used to guard against multiple delivery. Successive calls to [ListMessages](#listmessages-method-amazonsqs-class) on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with [DeleteMessage](#deletemessage-method-amazonsqs-class). A default visibility timeout is configured when a queue is created using [CreateQueue](#createqueue-method-amazonsqs-class), it can also be altered when a message is added using [CreateMessage](#createmessage-method-amazonsqs-class) or when they are retrieved using [ListMessages](#listmessages-method-amazonsqs-class). The default value for VisibilityTimeout is -1, which notifies the component that you would like to use the default behavior for the current Queue. NOTE: Unlike messages received from standard queues, messages received from FIFO queues can *only* be deleted within their VisibilityTimeout. Attempting to call [DeleteMessage](#deletemessage-method-amazonsqs-class) for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error. Keep this in mind when picking a VisibilityTimeout value to create a FIFO queue and/or retrieve messages with. # AddPermission Method ([AmazonSQS](#amazonsqs-class) Class) Adds a permission to a queue for a specific account, which allows for sharing access to the queue. ## Syntax ```text public String addPermission(String queueId, String userLabel, String amazonAccount, String permissionName); ``` ## Remarks This method adds a permission to the queue specified by *QueueId* for the user account specified by *AmazonAccount*. *UserLabel* is the unique identification of the permission you're granting, and is used when deleting the permission via the [RemovePermission](#removepermission-method-amazonsqs-class) method. The current list of values you may pass in the *PermissionName* parameter are listed below: - SendMessage - ReceiveMessage - DeleteMessage - ChangeMessageVisibility - GetQueueAttributes Note that when you create a queue, you have full control access rights for the queue. Only you (as owner of the queue) can grant or deny permissions to the queue. AddPermission writes an SQS-generated policy. If you want to write your own policy, use [SetQueueAttribute](#setqueueattribute-method-amazonsqs-class) to upload your policy. This method returns the RequestId contained in the Amazon response. # ChangeMessageVisibility Method ([AmazonSQS](#amazonsqs-class) Class) Changes the visibility timeout of a message. ## Syntax ```text public String changeMessageVisibility(String queueId, String receiptHandle, int visiblityTimeout); ``` ## Remarks Changes the visibility of the message specified by *ReceiptHandle* in the queue specified by *QueueId*. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. This method returns the RequestId contained in the Amazon response. # Config Method ([AmazonSQS](#amazonsqs-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-amazonsqs-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-amazonsqs-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateMessage Method ([AmazonSQS](#amazonsqs-class) Class) Adds a message to a queue. ## Syntax ```text public String createMessage(String queueId, String message); ``` ## Remarks Adds a message to the queue specified. If [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class) is specified it is updated for all the messages in the queue. CreateMessage returns a message id assigned to the message that is added to a queue. This can then be used to [ListMessages](#listmessages-method-amazonsqs-class) or [DeleteMessage](#deletemessage-method-amazonsqs-class). Note: When adding a message to a FIFO queue, the [MessageGroupId](#MessageGroupId) configuration setting *must* be populated before calling this method. # CreateQueue Method ([AmazonSQS](#amazonsqs-class) Class) Creates an SQS queue. ## Syntax ```text public String createQueue(String queueName); ``` ## Remarks A queue with the specified name is created. CreateQueue returns a queue id assigned to the queue. This can then be used to [CreateMessage](#createmessage-method-amazonsqs-class) or [DeleteQueue](#deletequeue-method-amazonsqs-class). If the *QueueName* ends with *.fifo*, the queue will be created as a FIFO queue. Alternatively, if the [UseFIFOQueues](#UseFIFOQueues) configuration setting is enabled, the class will always attempt to create FIFO queues, appending *.fifo* to the given *QueueName* if necessary (all FIFO queues' names must have that suffix). # DeleteMessage Method ([AmazonSQS](#amazonsqs-class) Class) Deletes the message specified. ## Syntax ```text public void deleteMessage(String queueId, String receiptHandle); ``` ## Remarks Deletes the message specified by *ReceiptHandle* from the queue specified by *QueueId*. NOTE: Unlike messages received from standard queues, messages received from FIFO queues can *only* be deleted within their [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class). Attempting to call DeleteMessage for a message received from a FIFO queue after its [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class) has expired will cause the server to return an error. # DeleteQueue Method ([AmazonSQS](#amazonsqs-class) Class) Deletes a queue. ## Syntax ```text public void deleteQueue(String queueId); ``` ## Remarks Deletes the queue specified by *QueueId*. # DoEvents Method ([AmazonSQS](#amazonsqs-class) Class) This method processes events from the internal message queue. ## Syntax ```text public void doEvents(); ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # GetQueueAttributes Method ([AmazonSQS](#amazonsqs-class) Class) Returns all attributes of a queue. ## Syntax ```text public String getQueueAttributes(String queueId); ``` ## Remarks This method retrieves all of the attributes of the queue specified by *QueueId*, and stores them in the [Attributes](#attributes-property-amazonsqs-class) collection. Queues currently have five attributes that may be returned: - ApproximateNumberOfMessages - VisibilityTimeout (for more information, see Visibility Timeout) - CreatedTimestamp - LastModifiedTimestamp - Policy This method returns the RequestId contained in the Amazon response. # GetXValue Method ([AmazonSQS](#amazonsqs-class) Class) Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest . ## Syntax ```text public String getXValue(String XPath); ``` ## Remarks This method allows a user to retrieve a valid XPath expression from the HTTP response after calling [SendCustomRequest](#sendcustomrequest-method-amazonsqs-class). # Interrupt Method ([AmazonSQS](#amazonsqs-class) Class) This method interrupts the current method. ## Syntax ```text public void interrupt(); ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # ListMessages Method ([AmazonSQS](#amazonsqs-class) Class) Gets messages from the queue. ## Syntax ```text public void listMessages(String queueId); ``` ## Remarks This method retrieves messages from the queue specified by *QueueId*, and fires a [Message](#message-event-amazonsqs-class) event for each message it receives. The messages may also be accessed using the property [Messages](#messages-property-amazonsqs-class). If [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class) greater than -1 it is applied to the messages, otherwise the default timeout of the queue used. Only one message is retrieved by default; this behavior may be modified by changing [MaxMessages](#maxmessages-property-amazonsqs-class). NOTE: Unlike messages received from standard queues, messages received from FIFO queues can *only* be deleted within their [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class). Attempting to call [DeleteMessage](#deletemessage-method-amazonsqs-class) for a message received from a FIFO queue after its [VisibilityTimeout](#visibilitytimeout-property-amazonsqs-class) has expired will cause the server to return an error. # ListQueues Method ([AmazonSQS](#amazonsqs-class) Class) Lists the queues under the current account. ## Syntax ```text public void listQueues(); ``` ## Remarks This method will fire a [Queue](#queue-event-amazonsqs-class) event for each queue available for the Amazon SQS account specified by [AccessKey](#accesskey-property-amazonsqs-class). The listing may be filtered using [QueuePrefix](#queueprefix-property-amazonsqs-class). # RemovePermission Method ([AmazonSQS](#amazonsqs-class) Class) The RemovePermission action revokes any permissions in the queue policy that matches the UserLabel parameter. ## Syntax ```text public String removePermission(String queueId, String userLabel); ``` ## Remarks Note that only the owner of the queue may revoke previously added permissions. This method returns the RequestId contained in the Amazon response. # Reset Method ([AmazonSQS](#amazonsqs-class) Class) Resets request-related properties. ## Syntax ```text public void reset(); ``` ## Remarks Calling this method will reset the component to the original state. # ResetHeaders Method ([AmazonSQS](#amazonsqs-class) Class) Resets all HTTP headers, cookies, and LocalFile. ## Syntax ```text public void resetHeaders(); ``` ## Remarks Resets all the HTTP headers as well as LocalFile to "" (empty string). Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one. # SendCustomRequest Method ([AmazonSQS](#amazonsqs-class) Class) Allows the sending of a custom request to an Amazon web service. ## Syntax ```text public String sendCustomRequest(String url, String requestData, String otherHeaders); ``` ## Remarks Allows the sending of a custom request to the Amazon web service. The *URL* parameter describes the endpoint that is being targeted. The *RequestData* is set to any data required for the request. The *OtherHeaders* parameter is used to set any additional headers that should be set for the request. # SetQueueAttribute Method ([AmazonSQS](#amazonsqs-class) Class) Sets an attribute of a queue. ## Syntax ```text public String setQueueAttribute(String queueId, String attributeName, String attributeValue); ``` ## Remarks This method sets attributes of the queue specified by *QueueId*. When you change a queue's attributes, the change can take up to 60 seconds to propagate throughout the SQS system. This method returns the RequestId contained in the Amazon response. # Connected Event ([AmazonSQS](#amazonsqs-class) Class) Fired immediately after a connection completes (or fails). ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void connected(AmazonSQSConnectedEvent e) {} ... } public class AmazonSQSConnectedEvent { public int statusCode; public String description; } ``` ## Remarks If the connection is made normally, *StatusCode* is 0 and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-amazonsqs-class) section for more information. # Disconnected Event ([AmazonSQS](#amazonsqs-class) Class) Fired when a connection is closed. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void disconnected(AmazonSQSDisconnectedEvent e) {} ... } public class AmazonSQSDisconnectedEvent { public int statusCode; public String description; } ``` ## Remarks If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-amazonsqs-class) section for more information. # EndTransfer Event ([AmazonSQS](#amazonsqs-class) Class) Fired when a document finishes transferring. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void endTransfer(AmazonSQSEndTransferEvent e) {} ... } public class AmazonSQSEndTransferEvent { public int direction; } ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Error Event ([AmazonSQS](#amazonsqs-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void error(AmazonSQSErrorEvent e) {} ... } public class AmazonSQSErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-amazonsqs-class) section. # Header Event ([AmazonSQS](#amazonsqs-class) Class) Fired every time a header line comes in. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void header(AmazonSQSHeaderEvent e) {} ... } public class AmazonSQSHeaderEvent { public String field; public String value; } ``` ## Remarks The *Field* parameter contains the name of the HTTP header (which is the same as it is delivered). The *Value* parameter contains the header contents. If the header line being retrieved is a continuation header line, then the *Field* parameter contains "" (empty string). # Message Event ([AmazonSQS](#amazonsqs-class) Class) Fired for each message retrieved from the queue. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void message(AmazonSQSMessageEvent e) {} ... } public class AmazonSQSMessageEvent { public String messageId; public String receiptHandle; public String messageData; public String MD5; } ``` ## Remarks When [ListMessages](#listmessages-method-amazonsqs-class) is invoked the class fires Message for each message retrieved. The number of messages retrieved are specified using [MaxMessages](#maxmessages-property-amazonsqs-class). OtherData is reserved for future use. # Queue Event ([AmazonSQS](#amazonsqs-class) Class) Fired for each queue of the user. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void queue(AmazonSQSQueueEvent e) {} ... } public class AmazonSQSQueueEvent { public String queueId; public String URL; } ``` ## Remarks When [ListQueues](#listqueues-method-amazonsqs-class) is invoked the class fires Queue for each queue. # SSLServerAuthentication Event ([AmazonSQS](#amazonsqs-class) Class) Fired after the server presents its certificate to the client. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void SSLServerAuthentication(AmazonSQSSSLServerAuthenticationEvent e) {} ... } public class AmazonSQSSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write } ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True. # SSLStatus Event ([AmazonSQS](#amazonsqs-class) Class) Fired when secure connection progress messages are available. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void SSLStatus(AmazonSQSSSLStatusEvent e) {} ... } public class AmazonSQSSSLStatusEvent { public String message; } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([AmazonSQS](#amazonsqs-class) Class) Fired when a document starts transferring (after the headers). ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void startTransfer(AmazonSQSStartTransferEvent e) {} ... } public class AmazonSQSStartTransferEvent { public int direction; } ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # Status Event ([AmazonSQS](#amazonsqs-class) Class) Fired when the HTTP status line is received from the server. ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void status(AmazonSQSStatusEvent e) {} ... } public class AmazonSQSStatusEvent { public String HTTPVersion; public int statusCode; public String description; } ``` ## Remarks *HTTPVersion* is a string containing the HTTP version string as returned from the server (e.g., "1.1"). *StatusCode* contains the HTTP status code (e.g., 200), and *Description* the associated message returned by the server (e.g., "OK"). # Transfer Event ([AmazonSQS](#amazonsqs-class) Class) Fired while a document transfers (delivers document). ## Syntax ```text public class DefaultAmazonSQSEventListener implements AmazonSQSEventListener { ... public void transfer(AmazonSQSTransferEvent e) {} ... } public class AmazonSQSTransferEvent { public int direction; public long bytesTransferred; public int percentDone; public byte[] text; } ``` ## Remarks The *Text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *BytesTransferred* parameter contains the number of bytes transferred in this *Direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | In Java, the certificate store normally is a file containing certificates and optional private keys. When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # Firewall Type The firewall the class will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType). The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. Connection information will first be obtained from Java system properties, such as *http.proxyHost* and *https.proxyHost*. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified. If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems). **FirewallType** *int* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. | **Host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a [Host](#Firewall_f_Host) is given, the requested connections will be authenticated through the specified firewall when connecting. If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class throws an exception. **Password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. **Port** *int* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details. NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details. **User** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class throws an exception. ## Constructors ```text public Firewall(); ``` # Proxy Type The proxy the class will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme). The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **AuthScheme** *int* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set. [AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected. By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the class will attempt basic authentication. If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead. If [AuthScheme](#Proxy_f_AuthScheme) is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password). **AutoDetect** *boolean* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. Note: This setting is applicable only in Windows. **Password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. **Port** *int* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details. **Server** *String* *Default Value: ""* If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned. **SSL** *int* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **User** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server. If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation. ## Constructors ```text public Proxy(); ``` ```text public Proxy(String server, int port); ``` ```text public Proxy(String server, int port, String user, String password); ``` # SQSAttribute Type This type represents a single SQS attribute. ## Remarks This type represents a single SQS attribute. The following fields are available: - [Name](#SQSAttribute_f_Name) - [Value](#SQSAttribute_f_Value) ## Fields **Name** *String (read-only)* *Default Value: ""* The name of the attribute. **Value** *String (read-only)* *Default Value: ""* The value of the attribute. ## Constructors ```text public SQSAttribute(); ``` # SqsMessage Type An object representing a single SQS Message. ## Remarks An object representing a single SQS Message. The following fields are available: - [Body](#SqsMessage_f_Body) - [Id](#SqsMessage_f_Id) - [MD5](#SqsMessage_f_MD5) - [ReceiptHandle](#SqsMessage_f_ReceiptHandle) ## Fields **Body** *String (read-only)* *Default Value: ""* The body of the SQS message. **Id** *String (read-only)* *Default Value: ""* The ID of the SQS message. **MD5** *String (read-only)* *Default Value: ""* The MD5 of the SQS message. **ReceiptHandle** *String (read-only)* *Default Value: ""* The Receipt handle of the SQS message. ## Constructors ```text public SqsMessage(); ``` ```text public SqsMessage(String id, String receiptHandle, String body, String MD5); ``` # SqsQueue Type An object representing a single SQS queue. ## Remarks An object representing a single SQS queue. The following fields are available: - [Id](#SqsQueue_f_Id) - [Url](#SqsQueue_f_Url) ## Fields **Id** *String (read-only)* *Default Value: ""* The ID of the SQS queue. **Url** *String (read-only)* *Default Value: ""* The URL of the SQS queue. ## Constructors ```text public SqsQueue(); ``` ```text public SqsQueue(String id, String url); ``` # Config Settings ([AmazonSQS](#amazonsqs-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-amazonsqs-class) method. ### AmazonSQS Config Settings **APIRequestFormat**: Changes the API request format.Possible values are as follows: | | | | --- | --- | | 0 (default) | Sends GET requests using AWS query protocol. | | 1 | Sends POST requests using AWS query protocol. | | 2 | Sends POST requests using AWS JSON protocol. | **APIVersion**: Service's API version.This describes the API version as defined by the service of the current protocol. The default is set to the version that the class was designed around, but may be changed to a different version. Amazon defines each version as the date it was released. An example is: "2009-07-15". **HTTPMethod**: Specifies the HTTP method to use when sending a custom request.The following methods are supported: **GET**,**PUT**,**HEAD**,**POST** and **DELETE** and are only used when [SendCustomRequest](#sendcustomrequest-method-amazonsqs-class) is called. The default value is "" (empty string) in which case the default HTTP methods are used (more details about the default behavior can be found on the [SendCustomRequest](#sendcustomrequest-method-amazonsqs-class) page). **MessageAttributeCount**: The number of message attributes.This setting is used to get or set the number of message attributes. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method. **MessageAttributeDataType[i]**: The data type of the message attribute.This setting can be used to get or set the data type of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method. Possible values are: - 0 (string - default) - 1 (number) - 2 (binary) Valid array indices are from 0 to [MessageAttributeCount](#MessageAttributeCount) - 1. **MessageAttributeName[i]**: The name of the message attribute.This setting can be used to get or set the message attribute name. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method. Valid array indices are from 0 to [MessageAttributeCount](#MessageAttributeCount) - 1. **MessageAttributeValue[i]**: The value of the message attribute.This setting gets or sets the value of the message attribute. This setting is applicable in SQS when calling the CreateMessage and ListMessages methods. This setting is applicable in SNS when calling the PublishMessage method. Valid array indices are from 0 to [MessageAttributeCount](#MessageAttributeCount) - 1. **MessageDeduplicationId**: The message deduplication ID for the message being created.First-In-First-Out (FIFO) queues support deduplication of sent messages. If a message with a particular message deduplication ID is sent successfully, any messages sent with the same message deduplication ID are accepted successfully, but are not delivered during the 5-minute deduplication interval. This only applies when creating message in a FIFO queue, and should be provided for each message sent in the following scenarios: - Messages sent with identical message bodies that Amazon SQS must treat as unique. - Messages sent with identical content but different message attributes that Amazon SQS must treat as unique. - Messages sent with different content (for example, retry counts included in the message body) that Amazon SQS must treat as duplicates. **MessageGroupId**: The ID of the message group to which the message belongs.First-In-First-Out (FIFO) queues support message groups that allow multiple ordered message groups within a single queue. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). This only applies when creating message in a FIFO queue and is required to be set. **PurgeQueue**: Deletes all messages in a queue specified by the QueueId.Used to purge all messages from the specified queue. Set this to the QueueId of the queue to be purged. When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling PurgeQueue will be deleted; messages sent to the queue while it is being purged may be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue was called may be received, but will be deleted within the next minute. **Region**: The region the class will make requests against.This config specifies the AWS region the class uses when making requests. By default, the region is *us-east-1*. Change this value when accessing resources located in other regions. For a complete and up-to-date list of supported regions, please refer to the AWS service documentation. **ResolveQueueId**: If set to true (default false), requests that require Queue URL can also be resolved using the Queue ID. The component will make an extra request invoking the AmazonSQS.GetQueueUrl method and use its response for the request that will require the Queue URL to be resolved. **SignatureVersion**: The version of signature used.The signature version used in the request. The default value is "4". **SignCustomRequest**: Tells the component to sign the outgoing request.By default, this configuration is True, and when [SendCustomRequest](#sendcustomrequest-method-amazonsqs-class) is called the class will sign the specified request to authenticate with the service. If set to False, the request will be sent as is, without signing. **TransferredData**: Returns the entire XML response received from the server. **URL**: If set, the default URL will be overridden by this value.By default, the class uses the service's URL. Setting this config will override this value. This should be only the base URL but not include the Queue name. For example: ```csharp sqs.Config("URL=https://myregion.custom-sqs-server.com"); sqs.ListMessages("MyQueue"); ``` **UseEC2RoleCredentials**: If set, authenticate requests with credentials obtained from the specified IAM role attached to the EC2 instance.When the class is running within an Amazon EC2 instance, this setting can be set to the name of an IAM role in order to automatically authenticate requests as that IAM role using temporary credentials obtained from the EC2 instance itself. In order for the class to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "[Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)" page in the Amazon IAM documentation for more information. By default, this setting is empty. When populated with an IAM role name, the class will do the following before each request: 1. Make a request against the EC2 instance to obtain temporary security credentials for the IAM role associated with the current instance profile. 2. Parse the response, automatically populating the [AccessKey](#accesskey-property-amazonsqs-class) and [SecretKey](#secretkey-property-amazonsqs-class) properties. 3. Execute the original request using the temporary security credentials that were acquired. **UseFIFOQueues**: Whether queues should always be created as FIFO queues.This setting specifies whether the class should always attempt to create queues as FIFO queue. By default, it is disabled, and a queue will only be created as a FIFO queue if the *QueueName* passed to [CreateQueue](#createqueue-method-amazonsqs-class) ends with *.fifo* (this is a required suffix for all FIFO queues). When enabled, the class will always append the *.fifo* suffix (if necessary) to the desired *QueueName* when [CreateQueue](#createqueue-method-amazonsqs-class) is called. (Note that queue names can be no longer than 80 characters, including the *.fifo* suffix.) ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class throws an exception if the server does not support HTTP/2. The default value is True. **AllowNTLMFallback**: Whether to allow fallback from Negotiate to NTLM when authenticating.This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the class will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. NOTE: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-amazonsqs-class) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class throws an exception. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class throws an exception instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. HTTP/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxHeaders**: Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.This configuration setting should be set when the TransferredHeaders collection is to be populated when a [Header](#header-event-amazonsqs-class) event has been fired. This value represents the number of headers that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxHTTPCookies**: Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection. To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection. **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. **UsePlatformDeflate**: Whether to use the platform implementation to decompress compressed responses.This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to *True* (default), the platform implementation is used. If set to *False*, an internal implementation is used. **UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine). **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-amazonsqs-class) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only throws an exception once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the Connected operation as a whole. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient. If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-amazonsqs-class) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-amazonsqs-class) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-amazonsqs-class) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Platform*. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-amazonsqs-class) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-amazonsqs-class) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLContextProtocol**: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. NOTE: This value must be set after [SSLProvider](#sslprovider-property-amazonsqs-class) is set. Example values: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Platform* include the following: - SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_RC4_128_SHA - SSL_RSA_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_WITH_DES_CBC_SHA - SSL_RSA_WITH_NULL_MD5 - SSL_DH_anon_WITH_3DES_EDE_CBC_SHA - SSL_DHE_RSA_WITH_DES_CBC_SHA - SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA - SSL_RSA_WITH_NULL_SHA - SSL_DH_anon_WITH_RC4_128_MD5 - SSL_RSA_WITH_RC4_128_MD5 - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_NULL_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended) - TLS_ECDH_anon_WITH_RC4_128_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended) - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_EXPORT_WITH_RC4_40_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_RC4_128_SHA - TLS_ECDH_ECDSA_WITH_RC4_128_SHA - TLS_ECDH_anon_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_RC4_128_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_NULL_SHA256 - TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA - TLS_KRB5_WITH_RC4_128_MD5 - TLS_ECDHE_ECDSA_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_RC4_128_SHA - TLS_EMPTY_RENEGOTIATION_INFO_SCSV - TLS_KRB5_WITH_3DES_EDE_CBC_MD5 - TLS_KRB5_WITH_RC4_128_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_NULL_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_DES_CBC_MD5 - TLS_KRB5_EXPORT_WITH_RC4_40_MD5 - TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5 - TLS_ECDH_anon_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_WITH_DES_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_NULL_SHA - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA Possible values when [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-amazonsqs-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-amazonsqs-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-amazonsqs-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-amazonsqs-class) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonsqs-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonsqs-class) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-amazonsqs-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLTrustManagerFactoryAlgorithm**: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-amazonsqs-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-amazonsqs-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. # Trappable Errors ([AmazonSQS](#amazonsqs-class) Class) ### AmazonSQS Errors | | | | --- | --- | | 601 | An error returned from Amazon SQS. Please refer to the error message for explanation. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-amazonsqs-class) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |