Docs

IPWorks 2022 Android Edition

Version 22.0 [Build 8171]

OData Component

Properties   Methods   Events   Configuration Settings   Errors  

The OData component implements the Open Data Protocol (OData). It can be used to query, parse, and update/modify data contained within an OData service.

Syntax

IPWorks.Odata

Remarks

The OData Component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. QueryService can then be called to retrieve the results (which can be viewed via the Entry*** properties).

OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.QueryService()

To create a new entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. CreateEntry can then be called to create the entry.

OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products" OData1.EntryProperties OData1.CreateEntry()

If you wish to update an entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. UpdateEntry can then be called to update the entry.

OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" // Index 1 is the "Name" property. OData1.EntryProperties[1].Value = "MyNewName" OData1.UpdateEntry()

Deleting an entry requires that you first set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to delete. DeleteEntry can then be called to delete the entry.

OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.ResourcePath = "Products(1)" OData1.DeleteEntry()

In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting ServiceRootURI to the root URI of the service, GetSchema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.

OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc" OData1.GetSchema()

Property List


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

AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
ChannelThis includes the feed elements of a feed.
CookiesCollection of cookies.
EntryAuthorThe Author of the current entry in an OData feed.
EntryCountThe number of entries contained within an OData feed.
EntryETagThe ETag of the current entry in an OData feed.
EntryIdThe ID of the current entry in an OData feed.
EntryIndexThe index of the current entry in an OData feed.
EntryLinksA collection of links in the current OData entry.
EntryPropertiesA collection of elements in the current OData entry.
EntrySummaryThe Summary of the current entry in an OData feed.
EntryTitleThe Title of the current entry in an OData feed.
EntryTypeThe entry category or type.
EntryUpdatedThe Date-Time when current entry in an OData feed was updated.
EntryXMLThe raw XML of the current entry in an OData feed.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
ODataVersionThe OData Version.
OtherHeadersOther headers as determined by the user (optional).
OtherQueryOptionsAdditional Query Options to be used when querying a service.
ParsedHeadersCollection of headers returned from the last request.
PasswordA password if authentication is to be used.
ProxyA set of properties related to proxy access.
QueryFilterSelects only the entries that satisfy the specified filter (expression).
QueryOrderByThe value used to order entries when querying a service.
QuerySelectSelects only the specified properties to be returned in an entry when querying a service.
QuerySkipThe number of entries to skip when querying a service.
QuerySkipTokenToken given by an OData server when the last query result collection is too large.
QueryTopSelects the first N entries when querying a service.
ResourcePathThe Resource Path of an OData service.
SchemaAssociationThe navigation properties and their corresponding associations contained within an entity of a service schema.
SchemaAssociationCountThe number of navigation properties contained within an OData schema entity.
SchemaAssociationIndexThe index of the current navigation property in an OData schema entity.
SchemaEntityThe entities contained within a service schema.
SchemaEntityCountThe number of entities contained within an OData schema.
SchemaEntityIndexThe index of the current entity in an OData schema.
SchemaKeysThe keys of a schema entity.
SchemaPropertyThe properties contained within an entity of a service schema.
SchemaPropertyCountThe number of properties contained within an OData schema entity.
SchemaPropertyIndexThe index of the current property in an OData schema entity.
SchemaTypeFieldThe fields (properties) contained within a complex type.
SchemaTypeFieldCountThe number of properties contained within an OData schema complex type.
SchemaTypeFieldIndexThe index of the current field (property) in an OData schema complex type.
ServiceRootURIThe root URI of an OData service.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLProviderTBD.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
UserA user name if authentication is to be used.

Method List


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

configSets or retrieves a configuration setting.
createEntryCreates a new entry within the specified OData service resource.
customRequestSends a request to the specified URL using the HTTP Method and Post Data provided.
deleteEntryDeletes an entry within an OData service resource.
getEntryPropertyGet an OData entry property.
getSchemaRetrieves the schema for a service.
hasXPathDetermines whether a specific element exists in the document.
queryServiceQueries an OData service using the specified parameters.
resetReset all properties of the component.
setEntryPropertySet an OData entry property.
setSchemaEntitySets the schema entity.
setSchemaPropertySets the schema property.
setSchemaTypeSets the schema type.
updateEntryUpdate an OData entry.
updatePropertyUpdate an OData entry property.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferThis event fires when a document finishes transferring.
EntityFired once for each entity retrieved.
EntryFired once for each entry retrieved.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
LogFires once for each log message.
PropertyFired once for each property found within an entity.
SetCookieFired for every cookie set by the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event fires when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings


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

EncodeResourcePathWhether the ResourcePath is URL encoded.
NameAndEmailFormatDetermines how the data of the name and e-mail properties will be formatted.
TransferredHeadersThe full set of headers as received from the server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLContextProtocolThe protocol used when getting an SSLContext instance.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithmThe algorithm to be used to create a TrustManager through TrustManagerFactory.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13ProviderThe TLS 1.3 implementation to be used.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseDaemonThreadsWhether threads created by the component are daemon threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Authorization Property (OData Component)

The Authorization string to be sent to the server.

Syntax


public String getAuthorization();


public void setAuthorization(String authorization);

Default Value

""

Remarks

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.

A common use for this property is to specify OAuth authorization string.

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]".

AuthScheme Property (OData Component)

The authentication scheme to use when server authorization is required.

Syntax


public int getAuthScheme();


public void setAuthScheme(int authScheme);

Enumerated values:
  public final static int authBasic = 0;

  public final static int authDigest = 1;

  public final static int authProprietary = 2;

  public final static int authNone = 3;

  public final static int authNtlm = 4;

  public final static int authNegotiate = 5;

  public final static int authOAuth = 6;

Default Value

0

Remarks

This property will tell the component which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the component to clear the values of User, Password and Authorization.

Channel Property (OData Component)

This includes the feed elements of a feed.

Syntax


public AtomChannel getChannel();


public void setChannel(AtomChannel channel);

Remarks

This property contains the "feed" elements of an ATOM feed. The Channel property has fields that contain values for subelements of the "feed" element.

Cookies Property (OData Component)

Collection of cookies.

Syntax


public HTTPCookieList getCookies();


public void setCookies(HTTPCookieList cookies);

Remarks

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies are also added to Cookies.

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size - 1.

This property is not available at design time.

EntryAuthor Property (OData Component)

The Author of the current entry in an OData feed.

Syntax


public String getEntryAuthor();


public void setEntryAuthor(String entryAuthor);

Default Value

""

Remarks

This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

EntryCount Property (OData Component)

The number of entries contained within an OData feed.

Syntax


public int getEntryCount();


Default Value

0

Remarks

This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).

This property is read-only and not available at design time.

EntryETag Property (OData Component)

The ETag of the current entry in an OData feed.

Syntax


public String getEntryETag();


public void setEntryETag(String entryETag);

Default Value

""

Remarks

This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once EntryIndex is set.

This property is also used when retrieving, updating or deleting an entry. When EntryETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an "If-Match" header will be sent with the entered value.

This property is not available at design time.

EntryId Property (OData Component)

The ID of the current entry in an OData feed.

Syntax


public String getEntryId();


public void setEntryId(String entryId);

Default Value

""

Remarks

This property contains the ID of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an ID can be found).

This property is not available at design time.

EntryIndex Property (OData Component)

The index of the current entry in an OData feed.

Syntax


public int getEntryIndex();


public void setEntryIndex(int entryIndex);

Default Value

-1

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties and ResourcePath will be populated with their respective values found within the entry.

This property takes index values from 0 to EntryCount-1.

Setting EntryIndex to -1 will clear the entries contained by the component and will also reset EntryProperties and EntryCount.

This property is not available at design time.

EntryLinks Property (OData Component)

A collection of links in the current OData entry.

Syntax


public ODataEntryLinkList getEntryLinks();


public void setEntryLinks(ODataEntryLinkList entryLinks);

Remarks

This is a collection of links (referred to as Navigation Properties) in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryLink types in this collection.

EntryProperties Property (OData Component)

A collection of elements in the current OData entry.

Syntax


public ODataEntryPropertyList getEntryProperties();


public void setEntryProperties(ODataEntryPropertyList entryProperties);

Remarks

This is a collection of elements in the current OData entry, as specified by EntryIndex. When EntryIndex is set, all of the elements in the entry are stored as ODataEntryProperty types in this collection.

EntrySummary Property (OData Component)

The Summary of the current entry in an OData feed.

Syntax


public String getEntrySummary();


public void setEntrySummary(String entrySummary);

Default Value

""

Remarks

This property contains the Summary of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Summary can be found).

This property is not applicable to OData V4 feeds.

This property is not available at design time.

EntryTitle Property (OData Component)

The Title of the current entry in an OData feed.

Syntax


public String getEntryTitle();


public void setEntryTitle(String entryTitle);

Default Value

""

Remarks

This property contains the Title of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a Title can be found).

This property is not available at design time.

EntryType Property (OData Component)

The entry category or type.

Syntax


public String getEntryType();


public void setEntryType(String entryType);

Default Value

""

Remarks

This property specifies the entry category or type. When communicating with a service using OData V3 this property specifies the Category element. When communicating with a service using OData V4 this property specifies the "type" attribute.

This property is not available at design time.

EntryUpdated Property (OData Component)

The Date-Time when current entry in an OData feed was updated.

Syntax


public String getEntryUpdated();


Default Value

""

Remarks

This property contains the Date-Time when the specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a Title can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

EntryXML Property (OData Component)

The raw XML of the current entry in an OData feed.

Syntax


public String getEntryXML();


public void setEntryXML(String entryXML);

Default Value

""

Remarks

This property contains the raw XML of the specified entry within an OData feed. This value will be populated once EntryIndex is set.

This property is not available at design time.

Firewall Property (OData Component)

A set of properties related to firewall access.

Syntax


public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

This is a Firewall type property which contains fields describing the firewall through which the component will attempt to connect.

Idle Property (OData Component)

The current status of the component.

Syntax


public boolean isIdle();


Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

LocalHost Property (OData Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax


public String getLocalHost();


public void setLocalHost(String localHost);

Default Value

""

Remarks

The LocalHost 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 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 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 multi-homed 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.

ODataVersion Property (OData Component)

The OData Version.

Syntax


public int getODataVersion();


public void setODataVersion(int ODataVersion);

Enumerated values:
  public final static int odV2 = 0;

  public final static int odV3 = 1;

  public final static int odV4 = 2;

  public final static int odAuto = 3;

Default Value

3

Remarks

This property specifies the OData version to be used in the request and expected in the response. Possible values are:

  • 0 (odV2)
  • 1 (odv3)
  • 3 (odV4)
  • 4 (odAuto - default)
When set to 4 (odAuto - default) the component will automatically determine the version used by the service and use the same version to format requests and parse responses. When calling CreateEntry or UpdateEntry if the service version is not already known from a previous operation the component will first query the service to determine the version.

Once the version of the service has been automatically determined it will continue to be used until Reset is called.

This property is not available at design time.

OtherHeaders Property (OData Component)

Other headers as determined by the user (optional).

Syntax


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, From, etc.

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 property with caution. If this property contains invalid headers, HTTP requests may fail.

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

This property is not available at design time.

OtherQueryOptions Property (OData Component)

Additional Query Options to be used when querying a service.

Syntax


public String getOtherQueryOptions();


public void setOtherQueryOptions(String otherQueryOptions);

Default Value

""

Remarks

This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs and multiple entries should be separated with an '&' (i.e. name1=value1&name2=value2).

Note all specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI, ResourcePath and any Query*** properties specified).

This property is not available at design time.

ParsedHeaders Property (OData Component)

Collection of headers returned from the last request.

Syntax


public HeaderList getParsedHeaders();


Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size - 1.

This property is read-only and not available at design time.

Password Property (OData Component)

A password if authentication is to be used.

Syntax


public String getPassword();


public void setPassword(String password);

Default Value

""

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization config setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Proxy Property (OData Component)

A set of properties related to proxy access.

Syntax


public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

QueryFilter Property (OData Component)

Selects only the entries that satisfy the specified filter (expression).

Syntax


public String getQueryFilter();


public void setQueryFilter(String queryFilter);

Default Value

""

Remarks

This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.

Below are the operators supported in the expression language.

Logical Operators

Operator Description Example
eq Equal "City eq 'Durham'"
ne Not Equal "City ne 'North Carolina'"
gt Greater Than "Price gt 20"
ge Greater Than or Equal "Price ge 10"
lt Less Than "Price lt 20"
le Less Than Or Equal "Price le 100"
and Logical And "Price le 200 and Price gt 3.5 "
or Logical Or "Price le 3.5 or Price gt 200"
not Logical Not "not endswith(Description,'milk')"

Arithmetic Operators

Operator Description Example
add Addition "Price add 5 gt 10"
sub Subtraction "Price sub 5 gt 10"
mul Multiplication "Price mul 2 gt 2000"
div Division "Price div 2 gt 4"
mod Modulo "Price mod 2 eq 0"

Grouping Operators

Operator Description Example
( ) Precedence Grouping "(Price sub 5) gt 10 "

Below are the functions supported in the expression language.

String Functions

Function Example
bool substringof(string po, string p1) "substringof('Alfreds', CompanyName) eq true"
bool endswith(string p0, string p1) "endswith(CompanyName, 'Futterkiste') eq true"
bool startswith(string p0, string p1) "startswith(CompanyName, 'Alfr') eq true"
int length(string p0) "length(CompanyName) eq 19"
int indexof(string p0, string p1) "indexof(CompanyName, 'lfreds') eq 1"
string replace(string p0, string find, string replace) "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'"
string substring(string p0, int pos) "substring(CompanyName, 1) eq 'lfreds Futterkiste'"
string substring(string p0, int pos, int length) "substring(CompanyName, 1, 2) eq 'lf'"
string tolower(string p0) "tolower(CompanyName) eq 'alfreds futterkiste'"
string toupper(string p0) "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'"
string trim(string p0) "trim(CompanyName) eq 'Alfreds Futterkiste'"
string concat(string p0, string p1) "concat(concat(City, ', '), Country) eq 'Berlin, Germany'"

Date Functions

Function Example
int day(DateTime p0) "day(BirthDate) eq 8"
int hour(DateTime p0) "hour(BirthDate) eq 0"
int minute(DateTime p0) "minute(BirthDate) eq 0"
int month(DateTime p0) "month(BirthDate) eq 12"
int second(DateTime p0) "second(BirthDate) eq 0"
int year(DateTime p0) "year(BirthDate) eq 1948"

Math Functions

Function Example
double round(double p0) "round(Freight) eq 32"
decimal round(decimal p0) "round(Freight) eq 32"
double floor(double p0) "round(Freight) eq 32"
decimal floor(decimal p0) "floor(Freight) eq 32"
double ceiling(double p0) "ceiling(Freight) eq 33"
decimal ceiling(decimal p0) "floor(Freight) eq 33"

Type Functions

Function Example
bool IsOf(type p0) "isof('NorthwindModel.Order')"
bool IsOf(expression p0, type p1) "isof(ShipCountry, 'Edm.String')"

This property is not available at design time.

QueryOrderBy Property (OData Component)

The value used to order entries when querying a service.

Syntax


public String getQueryOrderBy();


public void setQueryOrderBy(String queryOrderBy);

Default Value

""

Remarks

This property allows you to specify a value by which the returned entries will be order after a call to QueryService.

Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending " asc" or " desc" (respectively) to your OrderBy value. For example, if you want to sort the entries by 'Rating' in descending order you would set QueryOrderBy to "Rating desc". If a specific order ('asc' or 'desc') is not specified, the entries will be returned in ascending order.

This property is not available at design time.

QuerySelect Property (OData Component)

Selects only the specified properties to be returned in an entry when querying a service.

Syntax


public String getQuerySelect();


public void setQuerySelect(String querySelect);

Default Value

""

Remarks

This property allows you to specify the specific properties you want returned within an entry when calling QueryService. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to only have the 'Name' and 'Price' of each item returned you can set QuerySelect to "Name,Price".

Note the specified values can be a property name, navigation property name (Title) or the "*" character (which returns all the properties for each entry).

This property is not available at design time.

QuerySkip Property (OData Component)

The number of entries to skip when querying a service.

Syntax


public String getQuerySkip();


public void setQuerySkip(String querySkip);

Default Value

""

Remarks

This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than 0.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use QueryOrderBy to specify how the entries should be sorted prior to skipping the top N items.

This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to "Rating desc" (to order the items by Rating from highest to lowest), set QuerySkip to "2" (to skip the first and second items), and finally set QueryTop to "2" (to only return the third and fourth items).

This property is not available at design time.

QuerySkipToken Property (OData Component)

Token given by an OData server when the last query result collection is too large.

Syntax


public String getQuerySkipToken();


public void setQuerySkipToken(String querySkipToken);

Default Value

""

Remarks

When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs a Skip Token is returned in the response and the component will populate QuerySkipToken with the returned value. Calling QueryService again will return the next page of results.

This property is not available at design time.

QueryTop Property (OData Component)

Selects the first N entries when querying a service.

Syntax


public String getQueryTop();


public void setQueryTop(String queryTop);

Default Value

""

Remarks

This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService. The specified value should not be a value less than 0.

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use QueryOrderBy to specify how the entries should be sorted prior to selecting the top N items.

This property is not available at design time.

ResourcePath Property (OData Component)

The Resource Path of an OData service.

Syntax


public String getResourcePath();


public void setResourcePath(String resourcePath);

Default Value

""

Remarks

This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI (ServiceRootURI/ResourcePath) to query feeds and modify entries.

This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different Resource Path.

For example, a valid ResourcePath for the OData sample service is: "Products".

This property is not available at design time.

SchemaAssociation Property (OData Component)

The navigation properties and their corresponding associations contained within an entity of a service schema.

Syntax


public ODataSchemaAssociation getSchemaAssociation();


Remarks

This property is used to obtain the navigation properties and their corresponding associations contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaAssociationIndex.

This property is read-only and not available at design time.

SchemaAssociationCount Property (OData Component)

The number of navigation properties contained within an OData schema entity.

Syntax


public int getSchemaAssociationCount();


Default Value

0

Remarks

This property is updated to reflect the total number of navigation properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaAssociationIndex Property (OData Component)

The index of the current navigation property in an OData schema entity.

Syntax


public int getSchemaAssociationIndex();


public void setSchemaAssociationIndex(int schemaAssociationIndex);

Default Value

0

Remarks

This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex). Once set, SchemaAssociation will be populated.

This property is not available at design time.

SchemaEntity Property (OData Component)

The entities contained within a service schema.

Syntax


public ODataSchemaEntity getSchemaEntity();


Remarks

This property is used to obtain the entities of a service schema. This property is populated after setting SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaEntityCount Property (OData Component)

The number of entities contained within an OData schema.

Syntax


public int getSchemaEntityCount();


Default Value

0

Remarks

This property is updated to reflect the total number of entities within a schema (retrieved via GetSchema).

This property is read-only and not available at design time.

SchemaEntityIndex Property (OData Component)

The index of the current entity in an OData schema.

Syntax


public int getSchemaEntityIndex();


public void setSchemaEntityIndex(int schemaEntityIndex);

Default Value

0

Remarks

This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.

This property is not available at design time.

SchemaKeys Property (OData Component)

The keys of a schema entity.

Syntax


public String[] getSchemaKeys();


Default Value

Remarks

This property is used to obtain the key(s) contained within an entity of a service schema and is populated after setting SchemaEntityIndex.

Note: A Key value maps to a property of the entity, details of which can be retrieved via SchemaProperty.

This property is read-only and not available at design time.

SchemaProperty Property (OData Component)

The properties contained within an entity of a service schema.

Syntax


public ODataSchemaProperty getSchemaProperty();


Remarks

This property is used to obtain the properties contained within an entity (specified by SchemaEntityIndex) of a service schema. This property is populated after setting SchemaPropertyIndex.

Note: In reference to a database structure, a property would be a column.

This property is read-only and not available at design time.

SchemaPropertyCount Property (OData Component)

The number of properties contained within an OData schema entity.

Syntax


public int getSchemaPropertyCount();


Default Value

0

Remarks

This property is updated to reflect the total number of properties within the schema entity specified by SchemaEntityIndex.

This property is read-only and not available at design time.

SchemaPropertyIndex Property (OData Component)

The index of the current property in an OData schema entity.

Syntax


public int getSchemaPropertyIndex();


public void setSchemaPropertyIndex(int schemaPropertyIndex);

Default Value

0

Remarks

This property is used to specify a property within an entity (specified by SchemaEntityIndex). Once set, SchemaProperty will be populated.

This property is not available at design time.

SchemaTypeField Property (OData Component)

The fields (properties) contained within a complex type.

Syntax


public ODataSchemaProperty getSchemaTypeField();


Remarks

This property is used to obtain the fields (properties) contained within a complex type.

It is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the complex type name via SetSchemaType.

This property is read-only and not available at design time.

SchemaTypeFieldCount Property (OData Component)

The number of properties contained within an OData schema complex type.

Syntax


public int getSchemaTypeFieldCount();


Default Value

0

Remarks

This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the type via SetSchemaType.

This property is read-only and not available at design time.

SchemaTypeFieldIndex Property (OData Component)

The index of the current field (property) in an OData schema complex type.

Syntax


public int getSchemaTypeFieldIndex();


public void setSchemaTypeFieldIndex(int schemaTypeFieldIndex);

Default Value

0

Remarks

This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.

This property is not available at design time.

ServiceRootURI Property (OData Component)

The root URI of an OData service.

Syntax


public String getServiceRootURI();


public void setServiceRootURI(String serviceRootURI);

Default Value

""

Remarks

This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) to query feeds and modify entries.

For example, the ServiceRootURI of the OData sample service is: "http://services.odata.org/OData/OData.svc/".

This property is not available at design time.

SSLAcceptServerCert Property (OData Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax


public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

Please note that this functionality is provided only for cases where 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.

SSLCert Property (OData Component)

The certificate to be used during SSL negotiation.

Syntax


public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the component 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 field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (OData Component)

TBD.

Syntax


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

TBD.

SSLServerCert Property (OData Component)

The server certificate for the last established connection.

Syntax


public Certificate getSSLServerCert();


Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (OData Component)

A timeout for the component.

Syntax


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 component will wait for the operation to complete before returning control.

The component will use DoEvents 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 component throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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.

TransferredData Property (OData Component)

The contents of the last response from the server.

Syntax


public byte[] getTransferredData();


Default Value

""

Remarks

This property is used to get the data of the last response from the server.

TransferredData will be populated after a successful QueryService or CustomRequest call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.

This property is read-only and not available at design time.

User Property (OData Component)

A user name if authentication is to be used.

Syntax


public String getUser();


public void setUser(String user);

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the component will attempt to authenticate using the current user's credentials.

Config Method (Odata Component)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

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

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, you must call Config("PROPERTY"). The value will be returned as a string.

CreateEntry Method (Odata Component)

Creates a new entry within the specified OData service resource.

Syntax

public void createEntry();

Remarks

The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

Upon a successful creation, all previous entries contained by the component, prior to the CreateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

CustomRequest Method (Odata Component)

Sends a request to the specified URL using the HTTP Method and Post Data provided.

Syntax

public void customRequest(String HTTPMethod, String URL, String postData);

Remarks

Sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g. POST) and the data sent is determined by PostData. If a custom request does not require data to be sent, you can simply set the PostData parameter to an empty string. Note, all values specified are taken as entered.

OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.

The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved via the TransferredHeaders property as well as through the Header event.

The component will then attempt to parse the search results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryProperties.

DeleteEntry Method (Odata Component)

Deletes an entry within an OData service resource.

Syntax

public void deleteEntry();

Remarks

The component will delete the entry, of an OData service resource, specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).

An "If-Match" header will be sent in the delete request with the value contained within EntryETag.

Upon a successful entry deletion, all previous entries contained by the component, prior to the DeleteEntry call, will be cleared. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

GetEntryProperty Method (Odata Component)

Get an OData entry property.

Syntax

public String getEntryProperty(String XPath);

Remarks

This method is intended for extending functionality of the OData component and will retrieve the value of the entry property specified by XPath. XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by EntryIndex.

entry[x] is the feed's xth entry (or any other root level child), where the indexer x starts at 1.

property is any child of the properties element, and attribute can be any attribute of that field. If an attribute is not supplied, the GetEntryProperty method will return the text portion of property. For example:

ODataControl.GetEntryProperty("entry[5]/content/properties/ID") ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")

Here is an example using a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.GetEntryProperty("ID") ODataControl.GetEntryProperty("ID@type") ODataControl.GetEntryProperty("Address/State")

GetSchema Method (Odata Component)

Retrieves the schema for a service.

Syntax

public void getSchema();

Remarks

This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.

Upon successful retrieval of the schema, you can set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

If you wish to retrieve additional details about the schema, they can be retrieved via XPath.

HasXPath Method (Odata Component)

Determines whether a specific element exists in the document.

Syntax

public boolean hasXPath(String XPath);

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via XPath.

This method returns True if the xpath exists, False if not.

See XPath for details on the XPath syntax.

QueryService Method (Odata Component)

Queries an OData service using the specified parameters.

Syntax

public void queryService();

Remarks

Queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To fetch an OData feed, without performing any filtering, you can leave Query*** and OtherQueryOptions empty and call QueryService.

The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved via the ParsedHeaders property as well as through the Header event.

The component will then attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks,EntryProperties and ResourcePath.

Reset Method (Odata Component)

Reset all properties of the component.

Syntax

public void reset();

Remarks

The Reset method resets all properties to the component's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.

SetEntryProperty Method (Odata Component)

Set an OData entry property.

Syntax

public void setEntryProperty(String XPath, String value);

Remarks

This method is intended for extending functionality of the OData component and will set the value of the entry property (specified by XPath) to the specified Value. Therefore the value of the corresponding property will be updated within EntryProperties.

XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the component will use the specified EntryIndex along with the property specified to update the EntryProperty value.

entry[x] is the feed's xth entry (or any other root level child), where the indexer x starts at 1.

property is any child of the properties element. For example:

ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName")

Here is an example using a relative path to retrieve properties of the first feed entry: ODataControl.EntryIndex = 1 ODataControl.SetEntryProperty("Name", "MyNewName") ODataControl.SetEntryProperty("Address/State", "NC")

SetSchemaEntity Method (Odata Component)

Sets the schema entity.

Syntax

public void setSchemaEntity(String name);

Remarks

The component will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys), properties (via SchemaProperty) and navigation properties (via SchemaAssociation) contained within the specified entity.

SetSchemaProperty Method (Odata Component)

Sets the schema property.

Syntax

public void setSchemaProperty(String name);

Remarks

The component will set the schema property to the Name specified. Once set, you can view the details of the property (via SchemaProperty) along with the complex type details (via SchemaTypeField); provided that the property is derived from the complex type.

SetSchemaType Method (Odata Component)

Sets the schema type.

Syntax

public void setSchemaType(String name);

Remarks

The component will set the schema type to the Name specified. Once set, you can view the details of the complex type (via SchemaTypeField).

UpdateEntry Method (Odata Component)

Update an OData entry.

Syntax

public void updateEntry();

Remarks

The component will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It will update the OData entry with the elements specified by EntryProperties.

Upon a successful update, all previous entries contained by the component, prior to the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

UpdateProperty Method (Odata Component)

Update an OData entry property.

Syntax

public void updateProperty(String XPath, String value);

Remarks

The component will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It will update only the single entry property specified by XPath with the specified Value.

Upon a successful update, all previous entries contained by the component, prior to the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties and ResourcePath. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.

Connected Event (Odata Component)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void connected(OdataConnectedEvent e) {}
  ...
}

public class OdataConnectedEvent {
  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 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 section for more information.

Disconnected Event (Odata Component)

Fired when a connection is closed.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void disconnected(OdataDisconnectedEvent e) {}
  ...
}

public class OdataDisconnectedEvent {
  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 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 section for more information.

EndTransfer Event (Odata Component)

This event fires when a document finishes transferring.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void endTransfer(OdataEndTransferEvent e) {}
  ...
}

public class OdataEndTransferEvent {
  public int direction;

}

Remarks

The EndTransfer event is fired 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.

Entity Event (Odata Component)

Fired once for each entity retrieved.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void entity(OdataEntityEvent e) {}
  ...
}

public class OdataEntityEvent {
  public String name;

}

Remarks

The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) via GetSchema.

Entry Event (Odata Component)

Fired once for each entry retrieved.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void entry(OdataEntryEvent e) {}
  ...
}

public class OdataEntryEvent {
  public String id;

  public String title;

  public String summary;

  public String ETag;

}

Remarks

The Entry event is fired once for each entry found in the response.

The entry properties are provided through EntryProperties.

The entry links are provided through EntryLinks.

Error Event (Odata Component)

Information about errors during data delivery.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void error(OdataErrorEvent e) {}
  ...
}

public class OdataErrorEvent {
  public int errorCode;

  public String description;

}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (Odata Component)

Fired every time a header line comes in.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void header(OdataHeaderEvent e) {}
  ...
}

public class OdataHeaderEvent {
  public String field;

  public String value;

}

Remarks

The Field parameter contains the name of the HTTP header (same case 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).

Log Event (Odata Component)

Fires once for each log message.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void log(OdataLogEvent e) {}
  ...
}

public class OdataLogEvent {
  public int logLevel;

  public String message;

  public String logType;

}

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is 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).

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

  • "Info"
  • "RequestHeaders"
  • "ResponseHeaders"
  • "RequestBody"
  • "ResponseBody"
  • "ProxyRequest"
  • "ProxyResponse"
  • "FirewallRequest"
  • "FirewallResponse"

Property Event (Odata Component)

Fired once for each property found within an entity.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void property(OdataPropertyEvent e) {}
  ...
}

public class OdataPropertyEvent {
  public String name;

  public String typeName;

  public boolean nullable;

}

Remarks

The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.

SetCookie Event (Odata Component)

Fired for every cookie set by the server.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void setCookie(OdataSetCookieEvent e) {}
  ...
}

public class OdataSetCookieEvent {
  public String name;

  public String value;

  public String expires;

  public String domain;

  public String path;

  public boolean secure;

}

Remarks

The SetCookie event is fired for every "Set-Cookie:" header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted through a secure (HTTPS) connection only.

SSLServerAuthentication Event (Odata Component)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void SSLServerAuthentication(OdataSSLServerAuthenticationEvent e) {}
  ...
}

public class OdataSSLServerAuthenticationEvent {
  public byte[] certEncoded;

  public String certSubject;

  public String certIssuer;

  public String status;

  public boolean accept;

}

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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 (Odata Component)

Shows the progress of the secure connection.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void SSLStatus(OdataSSLStatusEvent e) {}
  ...
}

public class OdataSSLStatusEvent {
  public String message;

}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (Odata Component)

This event fires when a document starts transferring (after the headers).

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void startTransfer(OdataStartTransferEvent e) {}
  ...
}

public class OdataStartTransferEvent {
  public int direction;

}

Remarks

The StartTransfer event is fired 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 (Odata Component)

Fired when the HTTP status line is received from the server.

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void status(OdataStatusEvent e) {}
  ...
}

public class OdataStatusEvent {
  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 (Odata Component)

Fired while a document transfers (delivers document).

Syntax

public class DefaultOdataEventListener implements OdataEventListener {
  ...
  public void transfer(OdataTransferEvent e) {}
  ...
}

public class OdataTransferEvent {
  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 is 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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

AtomChannel Type

The information about an Atom feed as it is received from the server.

Remarks

When an Atom feed is parsed by the component, each item is parsed into an AtomEntry type and other information about the feed are presented as AtomChannel.

Fields

AuthorEmail
String

This field contains the email address of the author.

AuthorName
String

This field contains the name of the author.

AuthorUri
String

This field contains the uniform resource identifier (URI) of the author.

CategoryLabel
String

This field contains a textual description of the label for the category.

CategoryScheme
String

This field identifies a categorization scheme.

CategoryTerm
String

This field contains the category to which the entry or feed belongs.

ContributorEmail
String

This field contains the email address of the contributor.

ContributorName
String

This field contains the name of the contributor.

ContributorUri
String

This field contains the uniform resource identifier (URI) of the contributor.

Generator
String

This field identifies the generator of the feed.

Icon
String

This field contains a reference to the image that represents this feed.

Id
String

The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.

LinkHref
String

This field contains the location of the link.

LinkHrefLang
String

This field contains the language of the content at the link.

LinkLength
String

This field contains the length (in bytes) of the content at the link.

LinkRel
String

This field indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:

  • alternate
  • related
  • self
  • enclosure
  • via

LinkTitle
String

This field contains the title of the link.

LinkType
String

This field contains the multipurpose internet mail extension (MIME) type of the content at the link.

This field contains the logo for an image that represents the feed.

Rights
String

This field contains information about the rights of the given feed.

RightsTextType
int

This field contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.

Subtitle
String

This field contains a short description of the Atom feed.

SubtitleTextType
int

This field contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.

Title
String

This field contains the title of the current Atom feed. Typically, the title of the channel is similar to that of the web page where the Atom content is hosted.

TitleTextType
int

This field contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.

Updated
String

This field contains the date and time that the feed was updated.

Constructors

public AtomChannel();



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.

Fields

EffectiveDate
String

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
String

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte []

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

ExpirationDate
String

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
String

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
String

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

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

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

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

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String

This is 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. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of 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.

PrivateKey
String

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
String

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
String

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String

This field contains 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

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
String

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

The field contains 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

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

StoreB
byte []

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

StorePassword
String

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

StoreType
int

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used the component will automatically determine the type. This field can take one of the following values:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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

Subject
String

This is 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=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

SubjectAltNames
String

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
String

This field contains the MD5 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA1
String

This field contains the SHA-1 hash of the certificate. If the hash does not already exist, it is computed.

ThumbprintSHA256
String

This field contains the SHA-256 hash of the certificate. If the hash does not already exist, it is computed.

Usage
String

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

  • Digital Signatures
  • Key Authentication
  • Key Encryption
  • Data Encryption
  • Key Agreement
  • Certificate Signing
  • Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

0x80Digital Signatures
0x40Key Authentication
0x20Key Encryption
0x10Data Encryption
0x08Key Agreement
0x04Certificate Signing
0x02Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

Version
String

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType 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 component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType 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 CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to 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 component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType 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 component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component 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 and the FirewallType.

Fields

AutoDetect
boolean

This field tells the component whether or not 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 etc. Java properties may be set in a variety of ways, please consult the Java documentation for how Firewall and Proxy values can be specified.

If no Java system properties define connection information the component will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

FirewallType
int

This field determines the type of firewall to connect through. The applicable values are the following:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String

This field contains the name or IP address of firewall (optional). If a 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 component throws an exception.

Password
String

This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Port
int

This field contains the TCP port for the firewall Host. See the description of the Host field for details.

Note that this field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String

This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

public Firewall();



Header Type

An HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Field
String

This field contains the name of the HTTP Header (same case as it is delivered).

Value
String

This field contains the Header contents.

Constructors

public Header();



public Header(String field, String value);



HTTPCookie Type

An HTTP cookie either sent to or received from the server.

Remarks

An HTTP cookie can store the cookies that are to be sent to the server. It may also store the cookies set by the server.

Cookies that are to be sent to the server must have the Name and Value fields supplied prior to submitting the URL. However, when the SetCookie event is fired, all of the fields of an HTTPCookie are filled out accordingly.

Fields

Domain
String

The domain of a received cookie. This field contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this field will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

Expiration
String

This field contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this field will contain an empty string. The convention is to drop the cookie at the end of the session.

Name
String

The name of the cookie.

This field, along with Value store the cookie that is to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

Path
String

This field contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path field will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

Secure
boolean

This field contains the security flag of the received cookie. This field specifies whether the cookie is secure. If the value of this field is True, the cookie value must be submitted through a secure (HTTPS) connection only.

Value
String

This field contains the value of the cookie. The cookie specified by Name has a corresponding value associated with it. This property holds that value.

The SetCookie event provides the cookies set by the server.

Constructors

public HTTPCookie();



public HTTPCookie(String name, String value);



ODataEntryLink Type

An object representing a single OData entry link.

Remarks

An object representing a single OData entry link.

Fields

ResourcePath
String

The Resource Path of the OData entry element link.

By setting this value to ResourcePath and calling QueryService, you can retrieve the related entries of the current entry (as specified by EntryIndex).

Title
String

The Title of the OData entry element link.

Constructors

public ODataEntryLink();



ODataEntryProperty Type

An object representing a single OData entry property.

Remarks

An object representing a single OData entry property.

Fields

Attributes
String

A space-separated list of attributes (name-value pairs) contained within an OData entry element. For example: name1="value1" name2="value2"

IsNull
boolean

Indicates whether a property value of a primitive type is null.

Name
String

The Name of the OData entry element.

Note: For properties derived from a complex type, the name of the property and it's sub-property will be separated by '/'. For example, let's say you have a property called "MailingAddress" that is derived from a complex type called "Address". The "Address" complex type contains a property called "City". This particular property will be returned as "MailingAddress/City".

Setting this property to empty string prior to calling UpdateEntry will result in the item not being sent in the update request. Thus removing it from the OData entry.

Type
String

The type of the OData schema property.

Value
String

The Value of the OData entry element.

XPath
String

The XPath of the OData entry property. This value can be used to set XPath or can be used within UpdateProperty to update a specific property.

Constructors

public ODataEntryProperty();



public ODataEntryProperty(String name, String value);



public ODataEntryProperty(String name, String value, String type);



ODataSchemaAssociation Type

An object representing a single OData schema navigation property and its corresponding association.

Remarks

An object representing a single OData schema navigation property and its corresponding association.

Fields

ContainsTarget
boolean

Whether the navigation property contains a target. If True the navigation property is a containment navigation property.

This field is only applicable to OData Version 4.

Description
String

The documentation long description of the OData schema association.

FromRole
String

The name of the starting point of the navigation.

FromRoleDescription
String

The documentation long description of the OData schema FromRole association end point.

FromRoleEntity
String

The name of the entity that FromRole association end point maps to.

FromRoleMultiplicity
int

The multiplicity of the FromRole association end point. This is used along with ToRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) Zero-One (0..1)
nmOne (1) One (1)
nmMany (2) Many (*)

FromRoleSummary
String

The documentation summary of the OData schema FromRole association end point.

Name
String

The Name of the OData schema navigation property.

Nullable
boolean

Whether the property defined by the schema can be a null value. If False then the object must contain a value.

This field is only applicable to OData Version 4.

OnDelete
int

The delete action to be performed.

Possible values are:

0 (daNone) Only the specified entry instance within FromRoleEntity is deleted. This is the default value.
1 (daCascade) After the specified entry instance is deleted within FromRoleEntity, the action is applied to the entry instance within the ToRoleEntity. For example, a single Customer is associated with multiple Orders. When a Customer is deleted, all Orders associated with the Customer will be deleted.
2 (daSetNull) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to null. This value is only applicable to OData Version 4.
3 (daSetDefault) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to their default value. This value is only applicable to OData Version 4.

Partner
String

The partner value identifying a navigation property (if any).

This field is only applicable to OData Version 4.

RefConstraintCount
int

The number of referential constraints. To examine the individual referential constraints set RefConstraintIndex to a value from 0 to RefConstraintCount -1. For instance: For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1 odata.SchemaAssociation.RefConstraintIndex = i; Console.Write(odata.SchemaAssociation.RefConstraintProperty); Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty); Next i

This field is only applicable to OData Version 4.

RefConstraintIndex
int

The current index of the referential constraint. See RefConstraintCount for details.

This field is only applicable to OData Version 4.

RefConstraintProperty
String

The property that takes part in the referential constraint.

This field is only applicable to OData Version 4.

RefConstraintReferencedProperty
String

The corresponding property of the principal entity type.

This field is only applicable to OData Version 4.

Relationship
String

The name of the relationship (association) of the navigation property.

Summary
String

The documentation summary of the OData schema association.

ToRole
String

The name of the end point of the navigation.

ToRoleDescription
String

The documentation long description of the OData schema ToRole association end point.

ToRoleEntity
String

The name of the entity that ToRole association end point maps to.

ToRoleMultiplicity
int

The multiplicity of the ToRole association end point. This is used along with FromRoleMultiplicity to determine the cardinality of the relationship (i.e. one-to-one or one-to-many).

The available values are:

nmZeroOne (0) Zero-One (0..1)
nmOne (1) One (1)
nmMany (2) Many (*)

ToRoleSummary
String

The documentation summary of the OData schema ToRole association end point.

Type
String

The entity type.

This field is only applicable to OData Version 4.

Constructors

public ODataSchemaAssociation();



ODataSchemaEntity Type

An object representing a single OData schema entity.

Remarks

An object representing a single OData schema entity.

Fields

Description
String

The documentation long description of the OData schema entity.

Name
String

The name of the OData schema entity.

Summary
String

The documentation summary of the OData schema entity.

Constructors

public ODataSchemaEntity();



ODataSchemaProperty Type

An object representing a single OData schema property.

Remarks

An object representing a single OData schema property.

Fields

Attributes
String

A space-separated list of attributes (name-value pairs) contained within an OData property element. For example: name1="value1" name2="value2"

Description
String

The documentation long description of the OData schema property.

IsComplexType
boolean

Indicates whether a property is derived from a complex type.

When 'True', SchemaTypeField can be used to navigate the properties contained within the complex type.

Name
String

The Name of the OData schema property.

Nullable
boolean

Indicates whether a property can be null.

Summary
String

The documentation summary of the OData schema property.

Type
String

The type of the OData schema property.

Constructors

public ODataSchemaProperty();



Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

AuthScheme
int

This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
boolean

This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Note: This setting is only applicable in Windows.

Password
String

This field contains a password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int

This field contains the TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
int

This field determines when to use SSL for the connection to the proxy. The applicable values are the following:

psAutomatic (0)Default setting. If the URL is an "https" URL, the component will use the psTunnel option. If the URL is a "http" URL, the component 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 through a tunneling (HTTP) proxy.

User
String

This field contains a user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

public Proxy();



public Proxy(String server, int port);



public Proxy(String server, int port, String user, String password);



Configuration Settings (Odata Component)

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.

OData Configuration Settings

EncodeResourcePath:   Whether the ResourcePath is URL encoded.

This setting specified whether ResourcePath is URL encoded in the request. By default this is True and the value is URL encoded. This may be set to False to prevent encoding.

NameAndEmailFormat:   Determines how the data of the name and e-mail properties will be formatted.

This property allows you to control how the data of the name and e-mail properties will be formatted. The available formats are:

0 (default)SMTP Format: Name <e-mail address>
1Name only.
2E-mail address only.

TransferredHeaders:   The full set of headers as received from the server.

This property returns the complete set of raw headers as received from the server.

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 setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It will then uncompress the data it has received. The component will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the component adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. 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 setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable when HTTPVersion is set to "2.0".

If set to True (default) the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the component 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 setting only applies when AuthScheme is set to Negotiate. If set to True the component will automatically use NTLM if the server does not support Negotiate authentication. Note that the server must indicate it supports NTLM authentication via 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 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.

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.

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

If set to True the URL passed to the component 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 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.

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

This property specifies the HTTP version used by the component. Possible values are:

  • "1.0"
  • "1.1" (default)
  • "2.0"

When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details.

HTTP/2 Notes

When using HTTP/2 only secure (TLS/SSL) connections are currently supported. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2 the component will automatically use HTTP/1.1 instead. This is done in order to provide compatibility without the need for any additional settings. To see which version was used check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/2 is supported on all platforms. The component will use the internal security implementation in all cases when connecting.

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

If this setting contains a non-empty 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. An example is: 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 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.

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 setting controls the level of detail that is logged through the Log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is 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 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.

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.

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.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This 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" the component will fallback to using "1.1" automatically. This setting will indicate which was used.

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 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 setting is provided for use by components that do not directly expose Proxy properties.

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

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 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 setting is provided for use by components 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.

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 setting contains the contents of the last response from the server.

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.

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 config to ON before making a request to enable it. Examples are below.

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ 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 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.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

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

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 setting specifies whether the platform 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.

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 "IPWorks HTTP Component - www.nsoftware.com".

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

IPPort Configuration Settings

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.

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 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 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 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 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.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

NOTE: 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 setting is provided for use by components 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 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 macOS.

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.

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

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.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

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

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

UseNTLMv2:   Whether to use NTLM V2.

When authenticating with NTLM this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Configuration Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When the UseInternalSecurityAPI configuration setting is True, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if UseInternalSecurityAPI is False.

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.

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

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.

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.

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.

Note: This value must be set after UseInternalSecurityAPI is set.

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 when UseInternalSecurityAPI is False (default) 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

Possible values when UseInternalSecurityAPI is True include:

  • 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_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • 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) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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.312288 (Hex 3000)
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 setting.

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

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when UseInternalSecurityAPI is set to true.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication 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 event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True 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 setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the component 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 traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.

Note: This setting is only applicable when UseInternalSecurityAPI is set to True.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedProtocol:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedProtocol[connId]");

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.

The special value "Internal" picks the internal SSL implementation. This does not rely on any system libraries. This is equivalent to setting UseInternalSecurityAPI to True.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed except to a value of "Internal".

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when 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 setting should only be set 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 setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
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 UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component throws an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance: IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this 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.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This 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 UseInternalSecurityAPI is set to True, 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 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 round trip 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 setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified 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"

TLS13Provider:   The TLS 1.3 implementation to be used.

This setting specifies the TLS 1.3 implementation which will be used when TLS 1.3 is enabled via SSLEnabledProtocols. Possible values are:

  • 0 (Internal - Default)
  • 1 (Platform)

The platform provider is only supported 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 only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above 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.

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified 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

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)

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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

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.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
UseDaemonThreads:   Whether threads created by the component are daemon threads.

If set to True (default), when the component creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the component will not set the Daemon property on the created thread. The default value is True.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Trappable Errors (Odata Component)

OData Errors

601   The feed URL is required.

HTTP Errors

118   Firewall Error. Error description contains 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   Can't open AttachedFile.

IPPort 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 at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   Cannot change UseConnection option while the component 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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 Android Edition - Version 22.0 [Build 8171]