Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

Amazons3 Configuration

The component 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 component, access to these internal properties is provided through the Config method.

S3 Configuration Settings

EventObjectSize:   Used to retrieve the full object size from inside the ObjectList event.

The Size parameter of the ObjectList event is an integer, but the Amazon specifications allow object sizes up to 5GB. You can use this configuration setting inside of the ObjectList event to retrieve the object size exactly as it is reported by Amazon. This setting is not valid outside of the ObjectList event.

ObjectSize:   Used to set and retrieve object sizes information beyond the range of an integer.

The Size field is an integer, but Amazon allows object sizes up to 5GB. You can use this configuration setting to retrieve the full Size field for any item in the Objects. For example, to get the size of the third object in the collection, (the item at index 2 of the Objects collection) you'd do the following:

  S3.Config("ObjectSize[2]");
ContentRange:   This contains the range of bytes of the current object that are being returned.

When implementing chunked and resumable object downloads by setting the Range property, this configuration will contain the returned range of bytes and the total count of bytes for the specified object. This configuration will be populated after a call to GetObject

CopyPartRange:   Specifies the range of bytes to copy when calling CopyPart.

This setting optionally specifies the range of bytes to copy from the source object when calling CopyPart. By default the entire object is copied as the new part. When set, this setting dictates the 0-based range of bytes to copy in the format "first-last". For example: "2048-4096".

EncryptionIV:   The initialization vector to be used for encryption/decryption.

When encrypting or decrypting an object, set this to the initialization vector for the component to use when processing the data.

The keys and initialization vector which are used are generated based on a PKCS5 Password specification. However, if another utility generates keys based on a different scheme, setting the EncryptionKey and EncryptionIV may be used instead.

EncryptionKey:   The key to use during AES encryption/decryption.

When decrypting or encrypting an object, set this to the key for the component to use when processing the data.

The keys and initialization vector which are used are generated based on a PKCS5 Password specification. However, if another utility generates keys based on a different scheme, setting the EncryptionKey and EncryptionIV may be used instead.

ETag:   The ETag for the object returned by the server.

This contains the ETag for the object returned after GetObject is called.

When implementing chunked and resumable object downloads, the ETag is used to determine if the object has changed since the last chunk was downloaded. Set the IfMatch config to the ETag of the previous request to tell the component to make sure the object has not changed.

IfMatch:   Check to make sure the object has not been modified since the last request.

When implementing chunked and resumable object downloads, the IfMatch config is used to determine if the object has changed since the last chunk was downloaded. Set the IfMatch config to the ETag of the previous request to tell the component to make sure the object has not changed before a call to GetObject.

EnforceBucketNameRestrictions:   Whether or not to enforce bucket naming conventions.

When set to False (default) the component will not enforce the bucket naming restrictions. US based buckets are not subject to the same name restrictions as other locations. When set to True the component will enforce the following restrictions:

  • Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes.
  • Bucket names must start with a number or letter.
  • Bucket names must be between 3 and 63 characters long.
  • Bucket names should not end with a dash.
  • Bucket names cannot contain two adjacent periods.
  • Bucket names cannot contain dashes next to periods.
  • Bucket names must not be formatted as an IP address (eg: 192.168.5.4).
IncludeObjectMD5:   Includes the MD5 digest of the object data if set.

If set to True the component will include the MD5 digest of the object data when CreateObject is called. The host will use this value to verify the data was not corrupted during transfer. The default value is False.

IncludePartMD5:   Includes the MD5 digest of the part data if set.

If set to True the component will include the MD5 digest of the part data when UploadPart is called. The host will use this value to verify the data was not corrupted during transfer. The default value is False.

IsPaged:   Whether or not all objects were returned by the last listing.

This configuration may be queried after a call to ListObjects to find out whether or not the server sent all objects in the last listing. If all objects were not listed, the component automatically has set the ObjectMarker property to the last object from the current listing to begin the next listing.

This setting is also used in conjunction with ListParts in the same manner.

LocationConstraint:   The location where buckets will be created.

You may specify a location constraint so newly created objects are stored in the same location.

Amazon S3 also supports region-specific endpoints, which can be used by setting the URL config to the appropriate endpoint. Note that when using a region-specific endpoint, the LocationConstraint config must also be set to the same region.

The current location constraints supported by Amazon are:

Location Constraint Region Endpoint
EU EU (Ireland) http://s3-eu-west-1.amazonaws.com
us-east-2 US East (Ohio) http://s3.us-east-2.amazonaws.com
us-west-1 US West (Northern California) http://s3-us-west-1.amazonaws.com
us-west-2 US West (Oregon) http://s3-us-west-2.amazonaws.com
eu-central-1 EU (Frankfurt) http://s3-eu-central-1.amazonaws.com
ap-southeast-1 Asia Pacific (Singapore) http://s3-ap-southeast-1.amazonaws.com
ap-southeast-2 Asia Pacific (Sydney) http://s3-ap-southeast-2.amazonaws.com
ap-northeast-1 Asia Pacific (Tokyo) http://s3-ap-northeast-1.amazonaws.com
ap-northeast-2 Asia Pacific (Seoul) http://s3-ap-northeast-2.amazonaws.com
sa-east-1 South America (Sao Paulo) http://s3-sa-east-1.amazonaws.com

Note that when using this setting in conjuction with the URL configuration setting, LocationConstraint should be set first to avoid overwriting the intended URL.

MaxParts:   The maximum number of parts in a multipart upload returned when calling ListParts.

When calling ListParts a maximum of 1000 parts will be returned by default. This setting allows you to specify a different maximum number. If there are more than MaxParts parts returned, IsPaged will return True and ListParts should be called in a loop until IsPaged returns False in order to list all of the parts.

MaxObjects:   The maximum number of objects for the server to return.

The maximum number of objects to be returned by ListObjects. The default value is -1, which does not send the server a limit on the amount to return.

This does not guarantee that all objects will be returned by the server. You may check the IsPaged config to see if more objects exist that were not returned in the listing. If there are more objects, call ListObjects again. The ObjectMarker will have been set to the next correct object marker for the new listing to begin.

PartNumberMarker:   The marker indicating the start of the next part list.

This setting is populated and used automatically by the component when calling ListParts and greater than MaxParts are returned. In this cases the results are said to be paged and this value will hold the last result in the current set to act as a starting point for the next ListParts call. In normal usage you will not need to query or set this value. Refer to MaxParts and ListParts for more information on properly dealing with paged results.

Prefix[i]:   The common prefix at index 'i'.

When StorePrefixList is true, this field is populated with the common prefixes normally exposed in the PrefixList event. The values in the collection are based on the values in ObjectDelimiter and ObjectPrefix when ListObjects is called.

Valid array indices are from 0 to PrefixCount - 1.

PrefixCount:   The number of common prefixes.

When StorePrefixList is true, this field is populated with the number of common prefixes normally exposed in the PrefixList event.

PrefixOtherData[i]:   The common prefix other data at index 'i'.

When StorePrefixList is true, this field is populated with the common prefixes' other data normally exposed in the PrefixList event.

Valid array indices are from 0 to PrefixCount - 1.

ProductToken:   This is used with Amazon DevPay to charge users for S3 usage.

Specifying a ProductToken allows the developer to charge a user based on their S3 usage.

Region:   The region where the bucket is located.

By default the component will use the US East (N. Virginia) region. Set this configuration setting if the bucket is located in a different region.

Available Regions:

ValueRegion
us-east-1 (Default)US East (N. Virginia)
us-west-1US West (N. California)
us-west-2US West (Oregon)
eu-west-1EU (Ireland)
eu-central-1EU (Frankfurt)
ap-northeast-1Asia Pacific (Tokyo)
ap-northeast-2Asia Pacific (Seoul)
ap-southeast-1Asia Pacific (Singapore)
ap-southeast-2Asia Pacific (Sydney)
sa-east-1South America (São Paulo)
cn-north-1China North

SigningTime:   A custom date to send to the S3 component to use while signing all requests.

The SigningTime config can be used to send a custom value for the signature date that is used while signing all Amazon requests. This is often used if a machine has not been patched or is sending incorrect date values while attempting to connect to Amazon.

This value must be provided as a traditional UNIX timestamp. A UNIX timestamp is the number of seconds since the UNIX Epoch (January 1, 1970). An example value for the timestamp would be 1236626334.

ResponseContentType:   Sets the Content-Type header of the response.

If specified, this determines the Content-Type header returned by the S3 server. Note that this is only applicable when calling GetLink.

ResponseContentLanguage:   Sets the Content-Language header of the response.

If specified, this determines the Content-Language header returned by the S3 server. Note that this is only applicable when calling GetLink.

ResponseExpires:   Sets the Expires header of the response.

If specified, this determines the Expires header returned by the S3 server. Note that this is only applicable when calling GetLink.

ResponseCacheControl:   Sets the Cache-Control header of the response.

If specified, this determines the Cache-Control header returned by the S3 server. Note that this is only applicable when calling GetLink.

ResponseContentDisposition:   Sets the Content-Disposition header of the response.

If specified, this determines the Content-Disposition header returned by the S3 server. Note that this is only applicable when calling GetLink.

ResponseContentEncoding:   Sets the Content-Encoding header of the response.

If specified, this determines the Content-Encoding header returned by the S3 server. Note that this is only applicable when calling GetLink.

SignatureVersion:   The version of signature used.

The signature version used in the request. The default value is "4".

StorageClass:   Specify the storage class to be used for the uploaded object.

Setting this option on the component allows you to control the storage class of an uploaded object. Valid options are:

ValueResult
1Standard storage (default)
2Reduced Redundancy storage

NOTE: This option only applies to the CreateObject and CopyObject methods.

StorePrefixList:   If true, store the common prefixes when ListObjects is called.

By default, this configuration setting is set to false. When set to true, the component will store the common prefixes (based on ObjectDelimiter and ObjectPrefix) normally exposed in the PrefixList event in Prefix[i]; and PrefixOtherData[i];.

TempPath:   If set, the temporary files created during decryption will be put in the path specified.

If set, temporary files created during encryption and decryption will be put in the path specified. If no path is specified, the system's default temp directory will be used.

UseServerSideEncryption:   If true, use server side encryption.

By default, this config is set to false. At the time of object creation, that is, when you are uploading a new object or making a copy of an existing object, you can specify if you want Amazon S3 to encrypt your data with AES256.

UserToken:   This is used with Amazon DevPay to charge users for S3 usage.

Specifying a UserToken allows the developer to charge a user based on their S3 usage.

APIVersion:   Amazon's API version.

This describes the API version as defined by Amazon of the current protocol. The default is set to the version that the component 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 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 page).

SignCustomRequest:   Tells the component to sign the outgoing request.

By default, this configuration is True, and when SendCustomRequest is called, the request will sign the specified request to authenticate with Amazon's servers. If set to False, the request will be sent as is, without signing.

TransferredData:   Returns the entire XML response received from Amazon.

URL:   If set, the default URL will be overridden by this value.

By default, the component uses the Amazon URL for the service. Setting this config will override this value.

UseTransferAcceleration:   TBD.

TBD

EnableTransferAcceleration:   TBD.

TBD

HTTP Configuration Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is true, the component adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This is the same as the AllowHTTPCompression property. This setting is exposed here for use by components that inherit from HTTP.

AllowIdenticalRedirectURL:   Allow redirects to the same URL.

By default the component does not allow redirects to the same URL to avoid redirect loops. In some cases the server may intentionally redirect the client back to the same URL. In that case this setting may be set to True to allow the redirect to be followed. The default value is False.

Append:   Whether to append data to LocalFile.

This setting determines whether data is 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 only applicable when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a non-empty 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 component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

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.

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.

EncodeURL:   If set to true the URL will be encoded by the component.

The default value is false. If set to true the URL passed to the component will be URL encoded.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the component 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 component throws an exception.

Note that 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 could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than 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 component throws an exception instead.

Valid options are:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to true the component will perform a GET on the new location.

The default value is false. If set to true the component will perform a GET on the new location. Otherwise it will use the same HTTP method again.

HTTPVersion:   The version of HTTP used by the component.

Possible values include "1.0", and "1.1". The default is "1.1".

IfModifiedSince:   A date determining the maximum age of the desired document.

This is the same as the IfModifiedSince property. This setting is exposed here for use by components that inherit from HTTP.

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 that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

MaxHeaders:   Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This config should be set when the TransferredHeaders collection is to be populated when a Header 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 config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxHTTPCookies:   Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This config 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 config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value besides frNever the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration option can be set to a string of headers to be appended to the HTTP request headers.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\ n") .

Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail.

This configuration option is useful for extending the functionality of the component beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This is the same as AuthScheme. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This is the same as Password. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This is the same as Port. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This is the same as Server. This setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This is the same as User. This setting is provided for use by components that do not directly expose Proxy properties.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the component.

If 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 component.

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.

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to true, the component 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 component 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.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

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 where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "/n software IPWorks HTTP/S Component - www.nsoftware.com".

Override the default with the name and version of your software.

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.

IPPort Configuration Settings

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 component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the component whether or not to automatically detect and use firewall system settings, if available.

This is the same as AutoDetect. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (IPPort only).

This entry is for IPPort only and does not work for other components that descend from IPPort.

If this entry is set, the component 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 is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as Password. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as Port. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

NOTE: This is the same as FirewallType. This setting is provided for use by components that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

NOTE: This is the same as User. This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a 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.

Note: This value is not applicable in Java.

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 will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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 Java or MAC.

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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified 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 component returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The TCP port in the local host where the component binds.

This must be set before a connection is attempted. It instructs the component 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; setting is useful when trying to connect to services that require a trusted port in 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 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 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 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 is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This 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.

RecordLength:   The length of received data records.

If set to a positive value, this setting defines the length of data records to be received. The component will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

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 and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

This 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. In order to keep streams open after the transfer of data, set this to False. the default value is True.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

SSL Configuration Settings

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the component 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 component is the same.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength 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.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

SSLProvider:   The name of the security provider to use.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLContextProtocol:   The protocol used when getting an SSLContext instance.

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

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.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled 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 component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values:

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 include:
  • 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
  • TLS_ECDH_anon_WITH_RC4_128_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA
  • 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

SSLEnabledCipherSuites is used together with SSLCipherStrength.

Note: This configuration setting is available only in .NET and Java.

Socket Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component 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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Configuration Settings

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.

UseDaemonThreads:   Whether threads created by the component are daemon threads.

If set to True, when the component creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the component will not set the Daemon property on the created thread.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0