OData Component
Properties Methods Events Config Settings Errors
The OData component implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.
Syntax
nsoftware.IPWorks.OData
Remarks
The OData Component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (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 through 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).
Example 1. Query a Service:
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.
Example 2. Create a New 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.
Example 3. Update an 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.
Example 4. Delete an 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.
Example 5. Retrieve the Scheme:
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.
Authorization | This property includes the Authorization string to be sent to the server. |
AuthScheme | This property specifies the authentication scheme to use when server authentication is required. |
Channel | This includes the feed elements of a feed. |
Cookies | This property includes a collection of cookies. |
EntryAuthor | This property includes the author of the current entry in an OData feed. |
EntryCount | This property includes the number of entries contained within an OData feed. |
EntryETag | This property includes the ETag of the current entry in an OData feed. |
EntryId | This property includes the Id of the current entry in an OData feed. |
EntryIndex | This property includes the index of the current entry in an OData feed. |
EntryLinks | This property includes a collection of links in the current OData entry. |
EntryProperties | This property includes a collection of elements in the current OData entry. |
EntrySummary | This property includes a summary of the current entry in an OData feed. |
EntryTitle | This property includes the title of the current entry in an OData feed. |
EntryType | This property includes the entry category or type. |
EntryUpdated | This property includes the date-time when a current entry in an OData feed was updated. |
EntryXML | This property includes the raw XML of the current entry in an OData feed. |
Firewall | A set of properties related to firewall access. |
Idle | This property specifies the current status of the component. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
ODataVersion | This property includes the OData version. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
OtherQueryOptions | This property includes additional query options to be used when querying a service. |
ParsedHeaders | This property includes a collection of headers returned from the last request. |
Password | This property includes a password if authentication is to be used. |
Proxy | A set of properties related to proxy access. |
QueryFilter | This property selects only the entries that satisfy the specified filter (expression). |
QueryOrderBy | This property includes the value used to order entries when querying a service. |
QuerySelect | This property selects only the specified properties to be returned in an entry when querying a service. |
QuerySkip | This property includes the number of entries to skip when querying a service. |
QuerySkipToken | This property includes the token given by an OData server when the last query result collection is too large. |
QueryTop | This property selects the first N entries when querying a service. |
ResourcePath | This property includes the resource path of an OData service. |
SchemaAssociation | This property includes the navigation properties and their corresponding associations contained within an entity of a service schema. |
SchemaAssociationCount | This property includes the number of navigation properties contained within an OData schema entity. |
SchemaAssociationIndex | This property includes the index of the current navigation property in an OData schema entity. |
SchemaEntity | This property includes the entities contained within a service schema. |
SchemaEntityCount | This property includes the number of entities contained within an OData schema. |
SchemaEntityIndex | This property includes the index of the current entity in an OData schema. |
SchemaKeys | This property includes the keys for a schema entity. |
SchemaProperty | This property includes the properties contained within an entity of a service schema. |
SchemaPropertyCount | This property includes the number of properties contained within an OData schema entity. |
SchemaPropertyIndex | This property includes the index of the current property in an OData schema entity. |
SchemaTypeField | This property includes the fields (properties) contained within a complex type. |
SchemaTypeFieldCount | This property includes the number of properties contained within an OData schema complex type. |
SchemaTypeFieldIndex | This property includes the index of the current field (property) in an OData schema complex type. |
ServiceRootURI | This property includes the root URI of an OData service. |
SSLAcceptServerCert | This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
Timeout | This property includes the timeout for the component. |
TransferredData | This property includes the contents of the last response from the server. |
User | This property includes a 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.
Config | Sets or retrieves a configuration setting. |
CreateEntry | This method creates a new entry within the specified OData service resource. |
CustomRequest | This method sends a request to the specified URL using the HTTPMethod and PostData provided. |
DeleteEntry | This method deletes an entry within an OData service resource. |
GetEntryProperty | This method gets an OData entry property. |
GetSchema | This method retrieves the schema for a service. |
HasXPath | This method determines whether a specific element exists in the document. |
QueryService | This method queries an OData service using the specified parameters. |
Reset | This method resets all of properties of the component. |
SetEntryProperty | This method is used to set an OData entry property. |
SetSchemaEntity | This method sets the schema entity. |
SetSchemaProperty | This method sets the schema property. |
SetSchemaType | This method sets the schema type. |
UpdateEntry | This method updates an OData entry. |
UpdateProperty | This method updates 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.
Connected | This event is fired immediately after a connection completes (or fails). |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event fires when a document finishes transferring. |
Entity | This event is fired once for each entity retrieved. |
Entry | This event is fired once for each entry retrieved. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
Property | This event is fired once for each property found within an entity. |
SetCookie | This event is fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
EncodeResourcePath | Whether the ResourcePath is URL encoded. |
NameAndEmailFormat | Determines how the data of the name and e-mail properties will be formatted. |
TransferredHeaders | The full set of headers as received from the server. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Authorization Property (OData Component)
This property includes the Authorization string to be sent to the server.
Syntax
Default Value
""
Remarks
If the Authorization property contains a nonempty 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)
This property specifies the authentication scheme to use when server authentication is required.
Syntax
public ODataAuthSchemes AuthScheme { get; set; }
enum ODataAuthSchemes { authBasic, authDigest, authProprietary, authNone, authNtlm, authNegotiate, authOAuth }
Public Property AuthScheme As OdataAuthSchemes
Enum ODataAuthSchemes authBasic authDigest authProprietary authNone authNtlm authNegotiate authOAuth End Enum
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 HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.
If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.
Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the component.
For security, 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 Channel { get; set; }
Public Property Channel As AtomChannel
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.
Please refer to the AtomChannel type for a complete list of fields.Cookies Property (OData Component)
This property includes a collection of cookies.
Syntax
public HTTPCookieList Cookies { get; }
Public Property Cookies As HTTPCookieList
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 also are added to Cookies.
MaxHTTPCookies can be used to control the maximum number of cookies saved.
This collection is indexed from 0 to count -1.
This property is not available at design time.
Please refer to the HTTPCookie type for a complete list of fields.EntryAuthor Property (OData Component)
This property includes the author of the current entry in an OData feed.
Syntax
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)
This property includes the number of entries contained within an OData feed.
Syntax
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)
This property includes the ETag of the current entry in an OData feed.
Syntax
Default Value
""
Remarks
This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the EntryIndex is set.
This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty 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)
This property includes the Id of the current entry in an OData feed.
Syntax
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)
This property includes the index of the current entry in an OData feed.
Syntax
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 also will reset EntryProperties and EntryCount.
This property is not available at design time.
EntryLinks Property (OData Component)
This property includes a collection of links in the current OData entry.
Syntax
public ODataEntryLinkList EntryLinks { get; }
Public Property EntryLinks As ODataEntryLinkList
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.
Please refer to the ODataEntryLink type for a complete list of fields.EntryProperties Property (OData Component)
This property includes a collection of elements in the current OData entry.
Syntax
public ODataEntryPropertyList EntryProperties { get; }
Public Property EntryProperties As ODataEntryPropertyList
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.
Please refer to the ODataEntryProperty type for a complete list of fields.EntrySummary Property (OData Component)
This property includes a summary of the current entry in an OData feed.
Syntax
Default Value
""
Remarks
This property contains the summary of a 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)
This property includes the title of the current entry in an OData feed.
Syntax
Default Value
""
Remarks
This property contains the title of a 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)
This property includes the entry category or type.
Syntax
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)
This property includes the date-time when a current entry in an OData feed was updated.
Syntax
Default Value
""
Remarks
This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a data-time can be found).
This property is not applicable to OData V4 feeds.
This property is read-only.
EntryXML Property (OData Component)
This property includes the raw XML of the current entry in an OData feed.
Syntax
Default Value
""
Remarks
This property contains the raw XML of a 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
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.
Please refer to the Firewall type for a complete list of fields.Idle Property (OData Component)
This property specifies the current status of the component.
Syntax
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
LocalHost Property (OData Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the 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 multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
ODataVersion Property (OData Component)
This property includes the OData version.
Syntax
public ODataODataVersions ODataVersion { get; set; }
enum ODataODataVersions { odV2, odV3, odV4, odAuto }
Public Property ODataVersion As OdataODataVersions
Enum ODataODataVersions odV2 odV3 odV4 odAuto End Enum
Default Value
3
Remarks
This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:
- 0 (odV2)
- 1 (odv3)
- 3 (odV4)
- 4 (odAuto - default)
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)
This property includes other headers as determined by the user (optional).
Syntax
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the component beyond what is provided.
This property is not available at design time.
OtherQueryOptions Property (OData Component)
This property includes additional query options to be used when querying a service.
Syntax
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)
This property includes a collection of headers returned from the last request.
Syntax
public HeaderList ParsedHeaders { get; }
Public ReadOnly Property ParsedHeaders As HeaderList
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 count -1.
This property is read-only and not available at design time.
Please refer to the Header type for a complete list of fields.Password Property (OData Component)
This property includes a password if authentication is to be used.
Syntax
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 configuration 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
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.QueryFilter Property (OData Component)
This property selects only the entries that satisfy the specified filter (expression).
Syntax
Default Value
""
Remarks
This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.
The following operators are 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 " |
The following functions are 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)
This property includes the value used to order entries when querying a service.
Syntax
Default Value
""
Remarks
This property allows you to specify a value by which the returned entries will be ordered 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)
This property selects only the specified properties to be returned in an entry when querying a service.
Syntax
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 have only 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)
This property includes the number of entries to skip when querying a service.
Syntax
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 zero.
By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before 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 return only the third and fourth items).
This property is not available at design time.
QuerySkipToken Property (OData Component)
This property includes the token given by an OData server when the last query result collection is too large.
Syntax
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)
This property selects the first N entries when querying a service.
Syntax
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 zero.
By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before selecting the top N items.
This property is not available at design time.
ResourcePath Property (OData Component)
This property includes the resource path of an OData service.
Syntax
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)
This property includes the navigation properties and their corresponding associations contained within an entity of a service schema.
Syntax
public ODataSchemaAssociation SchemaAssociation { get; }
Public ReadOnly Property SchemaAssociation As ODataSchemaAssociation
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.
Please refer to the ODataSchemaAssociation type for a complete list of fields.SchemaAssociationCount Property (OData Component)
This property includes the number of navigation properties contained within an OData schema entity.
Syntax
public int SchemaAssociationCount { get; }
Public ReadOnly Property SchemaAssociationCount As Integer
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)
This property includes the index of the current navigation property in an OData schema entity.
Syntax
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)
This property includes the entities contained within a service schema.
Syntax
public ODataSchemaEntity SchemaEntity { get; }
Public ReadOnly Property SchemaEntity As ODataSchemaEntity
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.
Please refer to the ODataSchemaEntity type for a complete list of fields.SchemaEntityCount Property (OData Component)
This property includes the number of entities contained within an OData schema.
Syntax
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)
This property includes the index of the current entity in an OData schema.
Syntax
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)
This property includes the keys for a schema entity.
Syntax
Default Value
Remarks
This property is used to obtain the keys contained within an entity for a service schema and is populated after setting SchemaEntityIndex.
Note: Key values map 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)
This property includes the properties contained within an entity of a service schema.
Syntax
public ODataSchemaProperty SchemaProperty { get; }
Public ReadOnly Property SchemaProperty As ODataSchemaProperty
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.
Please refer to the ODataSchemaProperty type for a complete list of fields.SchemaPropertyCount Property (OData Component)
This property includes the number of properties contained within an OData schema entity.
Syntax
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)
This property includes the index of the current property in an OData schema entity.
Syntax
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)
This property includes the fields (properties) contained within a complex type.
Syntax
public ODataSchemaProperty SchemaTypeField { get; }
Public ReadOnly Property SchemaTypeField As ODataSchemaProperty
Remarks
This property is used to obtain the fields (properties) contained within a complex type.
Note: 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.
Please refer to the ODataSchemaProperty type for a complete list of fields.SchemaTypeFieldCount Property (OData Component)
This property includes the number of properties contained within an OData schema complex type.
Syntax
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)
This property includes the index of the current field (property) in an OData schema complex type.
Syntax
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)
This property includes the root URI of an OData service.
Syntax
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.
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)
This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
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.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (OData Component)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
This property includes 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.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (OData Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public ODataSSLProviders SSLProvider { get; set; }
enum ODataSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As OdataSSLProviders
Enum ODataSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows, the component will use the platform implementation. On Linux/macOS, the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (OData Component)
This property includes the server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
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.
Please refer to the Certificate type for a complete list of fields.Timeout Property (OData Component)
This property includes the timeout for the component.
Syntax
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.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
TransferredData Property (OData Component)
This property includes the contents of the last response from the server.
Syntax
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)
This property includes a user name if authentication is to be used.
Syntax
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
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)
This method creates a new entry within the specified OData service resource.
Syntax
public void CreateEntry(); Async Version public async Task CreateEntry(); public async Task CreateEntry(CancellationToken cancellationToken);
Public Sub CreateEntry() Async Version Public Sub CreateEntry() As Task Public Sub CreateEntry(cancellationToken As CancellationToken) As Task
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, before 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)
This method sends a request to the specified URL using the HTTPMethod and PostData provided.
Syntax
public void CustomRequest(string HTTPMethod, string URL, string postData); Async Version public async Task CustomRequest(string HTTPMethod, string URL, string postData); public async Task CustomRequest(string HTTPMethod, string URL, string postData, CancellationToken cancellationToken);
Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) Async Version Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String) As Task Public Sub CustomRequest(ByVal HTTPMethod As String, ByVal URL As String, ByVal PostData As String, cancellationToken As CancellationToken) As Task
Remarks
This method sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g., POST) and the data sent are determined by PostData. If a custom request does not require data to be sent, 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 through 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 also will be set to 1, thus populating EntryProperties.
DeleteEntry Method (OData Component)
This method deletes an entry within an OData service resource.
Syntax
public void DeleteEntry(); Async Version public async Task DeleteEntry(); public async Task DeleteEntry(CancellationToken cancellationToken);
Public Sub DeleteEntry() Async Version Public Sub DeleteEntry() As Task Public Sub DeleteEntry(cancellationToken As CancellationToken) As Task
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, before the DeleteEntry call, will be cleared. OtherHeaders also will be cleared and thus will need to be reset accordingly with each call made.
GetEntryProperty Method (OData Component)
This method gets an OData entry property.
Syntax
Remarks
This method is intended to extend the 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 also can 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 property's 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.
Example 1. Attribute Not Supplied:
ODataControl.GetEntryProperty("entry[5]/content/properties/ID")
ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")
Example 2. Relative Path: In the following example, a relative path is used 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)
This method retrieves the schema for a service.
Syntax
public void GetSchema(); Async Version public async Task GetSchema(); public async Task GetSchema(CancellationToken cancellationToken);
Public Sub GetSchema() Async Version Public Sub GetSchema() As Task Public Sub GetSchema(cancellationToken As CancellationToken) As Task
Remarks
This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.
Upon successful retrieval of the schema, set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.
Additional details about the schema can be retrieved via XPath.
HasXPath Method (OData Component)
This method determines whether a specific element exists in the document.
Syntax
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 through XPath.
This method returns True if the xpath exists, and False if not.
See XPath for details on the XPath syntax.
QueryService Method (OData Component)
This method queries an OData service using the specified parameters.
Syntax
public void QueryService(); Async Version public async Task QueryService(); public async Task QueryService(CancellationToken cancellationToken);
Public Sub QueryService() Async Version Public Sub QueryService() As Task Public Sub QueryService(cancellationToken As CancellationToken) As Task
Remarks
This method queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To retrieve 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 through the ParsedHeaders property as well as through the Header event.
The component will 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)
This method resets all of properties of the component.
Syntax
public void Reset(); Async Version public async Task Reset(); public async Task Reset(CancellationToken cancellationToken);
Public Sub Reset() Async Version Public Sub Reset() As Task Public Sub Reset(cancellationToken As CancellationToken) As Task
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)
This method is used to set an OData entry property.
Syntax
Remarks
This method is intended to extend 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 property's element.
Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName")
Example 2. Retrieve Properties:
The following example uses 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)
This method sets the schema entity.
Syntax
public void SetSchemaEntity(string name); Async Version public async Task SetSchemaEntity(string name); public async Task SetSchemaEntity(string name, CancellationToken cancellationToken);
Public Sub SetSchemaEntity(ByVal Name As String) Async Version Public Sub SetSchemaEntity(ByVal Name As String) As Task Public Sub SetSchemaEntity(ByVal Name As String, cancellationToken As CancellationToken) As Task
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)
This method sets the schema property.
Syntax
public void SetSchemaProperty(string name); Async Version public async Task SetSchemaProperty(string name); public async Task SetSchemaProperty(string name, CancellationToken cancellationToken);
Public Sub SetSchemaProperty(ByVal Name As String) Async Version Public Sub SetSchemaProperty(ByVal Name As String) As Task Public Sub SetSchemaProperty(ByVal Name As String, cancellationToken As CancellationToken) As Task
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)
This method sets the schema type.
Syntax
public void SetSchemaType(string name); Async Version public async Task SetSchemaType(string name); public async Task SetSchemaType(string name, CancellationToken cancellationToken);
Public Sub SetSchemaType(ByVal Name As String) Async Version Public Sub SetSchemaType(ByVal Name As String) As Task Public Sub SetSchemaType(ByVal Name As String, cancellationToken As CancellationToken) As Task
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)
This method updates an OData entry.
Syntax
public void UpdateEntry(); Async Version public async Task UpdateEntry(); public async Task UpdateEntry(CancellationToken cancellationToken);
Public Sub UpdateEntry() Async Version Public Sub UpdateEntry() As Task Public Sub UpdateEntry(cancellationToken As CancellationToken) As Task
Remarks
The component will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It also will update the OData entry with the elements specified by EntryProperties.
Upon a successful update, all previous entries contained by the component, before the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (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)
This method updates an OData entry property.
Syntax
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, before the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (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)
This event is fired immediately after a connection completes (or fails).
Syntax
public event OnConnectedHandler OnConnected; public delegate void OnConnectedHandler(object sender, ODataConnectedEventArgs e); public class ODataConnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnConnected As OnConnectedHandler Public Delegate Sub OnConnectedHandler(sender As Object, e As ODataConnectedEventArgs) Public Class ODataConnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
Disconnected Event (OData Component)
This event is fired when a connection is closed.
Syntax
public event OnDisconnectedHandler OnDisconnected; public delegate void OnDisconnectedHandler(object sender, ODataDisconnectedEventArgs e); public class ODataDisconnectedEventArgs : EventArgs { public int StatusCode { get; } public string Description { get; } }
Public Event OnDisconnected As OnDisconnectedHandler Public Delegate Sub OnDisconnectedHandler(sender As Object, e As ODataDisconnectedEventArgs) Public Class ODataDisconnectedEventArgs Inherits EventArgs Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (OData Component)
This event fires when a document finishes transferring.
Syntax
public event OnEndTransferHandler OnEndTransfer; public delegate void OnEndTransferHandler(object sender, ODataEndTransferEventArgs e); public class ODataEndTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnEndTransfer As OnEndTransferHandler Public Delegate Sub OnEndTransferHandler(sender As Object, e As ODataEndTransferEventArgs) Public Class ODataEndTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
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)
This event is fired once for each entity retrieved.
Syntax
public event OnEntityHandler OnEntity; public delegate void OnEntityHandler(object sender, ODataEntityEventArgs e); public class ODataEntityEventArgs : EventArgs { public string Name { get; } }
Public Event OnEntity As OnEntityHandler Public Delegate Sub OnEntityHandler(sender As Object, e As ODataEntityEventArgs) Public Class ODataEntityEventArgs Inherits EventArgs Public ReadOnly Property Name As String End Class
Remarks
The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through GetSchema.
Entry Event (OData Component)
This event is fired once for each entry retrieved.
Syntax
public event OnEntryHandler OnEntry; public delegate void OnEntryHandler(object sender, ODataEntryEventArgs e); public class ODataEntryEventArgs : EventArgs { public string Id { get; } public string Title { get; } public string Summary { get; } public string ETag { get; } }
Public Event OnEntry As OnEntryHandler Public Delegate Sub OnEntryHandler(sender As Object, e As ODataEntryEventArgs) Public Class ODataEntryEventArgs Inherits EventArgs Public ReadOnly Property Id As String Public ReadOnly Property Title As String Public ReadOnly Property Summary As String Public ReadOnly Property ETag As String End Class
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)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, ODataErrorEventArgs e); public class ODataErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As ODataErrorEventArgs) Public Class ODataErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (OData Component)
This event is fired every time a header line comes in.
Syntax
public event OnHeaderHandler OnHeader; public delegate void OnHeaderHandler(object sender, ODataHeaderEventArgs e); public class ODataHeaderEventArgs : EventArgs { public string Field { get; } public string Value { get; } }
Public Event OnHeader As OnHeaderHandler Public Delegate Sub OnHeaderHandler(sender As Object, e As ODataHeaderEventArgs) Public Class ODataHeaderEventArgs Inherits EventArgs Public ReadOnly Property Field As String Public ReadOnly Property Value As String End Class
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (OData Component)
This event fires once for each log message.
Syntax
public event OnLogHandler OnLog; public delegate void OnLogHandler(object sender, ODataLogEventArgs e); public class ODataLogEventArgs : EventArgs { public int LogLevel { get; } public string Message { get; } public string LogType { get; } }
Public Event OnLog As OnLogHandler Public Delegate Sub OnLogHandler(sender As Object, e As ODataLogEventArgs) Public Class ODataLogEventArgs Inherits EventArgs Public ReadOnly Property LogLevel As Integer Public ReadOnly Property Message As String Public ReadOnly Property LogType As String End Class
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 as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
Property Event (OData Component)
This event is fired once for each property found within an entity.
Syntax
public event OnPropertyHandler OnProperty; public delegate void OnPropertyHandler(object sender, ODataPropertyEventArgs e); public class ODataPropertyEventArgs : EventArgs { public string Name { get; } public string TypeName { get; } public bool Nullable { get; } }
Public Event OnProperty As OnPropertyHandler Public Delegate Sub OnPropertyHandler(sender As Object, e As ODataPropertyEventArgs) Public Class ODataPropertyEventArgs Inherits EventArgs Public ReadOnly Property Name As String Public ReadOnly Property TypeName As String Public ReadOnly Property Nullable As Boolean End Class
Remarks
The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.
SetCookie Event (OData Component)
This event is fired for every cookie set by the server.
Syntax
public event OnSetCookieHandler OnSetCookie; public delegate void OnSetCookieHandler(object sender, ODataSetCookieEventArgs e); public class ODataSetCookieEventArgs : EventArgs { public string Name { get; } public string Value { get; } public string Expires { get; } public string Domain { get; } public string Path { get; } public bool Secure { get; } }
Public Event OnSetCookie As OnSetCookieHandler Public Delegate Sub OnSetCookieHandler(sender As Object, e As ODataSetCookieEventArgs) Public Class ODataSetCookieEventArgs Inherits EventArgs Public ReadOnly Property Name As String Public ReadOnly Property Value As String Public ReadOnly Property Expires As String Public ReadOnly Property Domain As String Public ReadOnly Property Path As String Public ReadOnly Property Secure As Boolean End Class
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 only through a secure (HTTPS) connection.
SSLServerAuthentication Event (OData Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, ODataSSLServerAuthenticationEventArgs e); public class ODataSSLServerAuthenticationEventArgs : EventArgs { public string CertEncoded { get; }
public byte[] CertEncodedB { get; } public string CertSubject { get; } public string CertIssuer { get; } public string Status { get; } public bool Accept { get; set; } }
Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As ODataSSLServerAuthenticationEventArgs) Public Class ODataSSLServerAuthenticationEventArgs Inherits EventArgs Public ReadOnly Property CertEncoded As String
Public ReadOnly Property CertEncodedB As Byte() Public ReadOnly Property CertSubject As String Public ReadOnly Property CertIssuer As String Public ReadOnly Property Status As String Public Property Accept As Boolean End Class
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (OData Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, ODataSSLStatusEventArgs e); public class ODataSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As ODataSSLStatusEventArgs) Public Class ODataSSLStatusEventArgs Inherits EventArgs Public ReadOnly Property Message As String End Class
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (OData Component)
This event fires when a document starts transferring (after the headers).
Syntax
public event OnStartTransferHandler OnStartTransfer; public delegate void OnStartTransferHandler(object sender, ODataStartTransferEventArgs e); public class ODataStartTransferEventArgs : EventArgs { public int Direction { get; } }
Public Event OnStartTransfer As OnStartTransferHandler Public Delegate Sub OnStartTransferHandler(sender As Object, e As ODataStartTransferEventArgs) Public Class ODataStartTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer End Class
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)
This event is fired when the HTTP status line is received from the server.
Syntax
public event OnStatusHandler OnStatus; public delegate void OnStatusHandler(object sender, ODataStatusEventArgs e); public class ODataStatusEventArgs : EventArgs { public string HTTPVersion { get; } public int StatusCode { get; } public string Description { get; } }
Public Event OnStatus As OnStatusHandler Public Delegate Sub OnStatusHandler(sender As Object, e As ODataStatusEventArgs) Public Class ODataStatusEventArgs Inherits EventArgs Public ReadOnly Property HTTPVersion As String Public ReadOnly Property StatusCode As Integer Public ReadOnly Property Description As String End Class
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)
This event is fired while a document transfers (delivers document).
Syntax
public event OnTransferHandler OnTransfer; public delegate void OnTransferHandler(object sender, ODataTransferEventArgs e); public class ODataTransferEventArgs : EventArgs { public int Direction { get; } public long BytesTransferred { get; } public int PercentDone { get; } public string Text { get; }
public byte[] TextB { get; } }
Public Event OnTransfer As OnTransferHandler Public Delegate Sub OnTransferHandler(sender As Object, e As ODataTransferEventArgs) Public Class ODataTransferEventArgs Inherits EventArgs Public ReadOnly Property Direction As Integer Public ReadOnly Property BytesTransferred As Long Public ReadOnly Property PercentDone As Integer Public ReadOnly Property Text As String
Public ReadOnly Property TextB As Byte() End Class
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
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
Default: ""
This field contains the email address of the author.
AuthorName
string
Default: ""
This field contains the name of the author.
AuthorUri
string
Default: ""
This field contains the uniform resource identifier (URI) of the author.
CategoryLabel
string
Default: ""
This field contains a textual description of the label for the category.
CategoryScheme
string
Default: ""
This field identifies a categorization scheme.
CategoryTerm
string
Default: ""
This field contains the category to which the entry or feed belongs.
ContributorEmail
string
Default: ""
This field contains the email address of the contributor.
ContributorName
string
Default: ""
This field contains the name of the contributor.
ContributorUri
string
Default: ""
This field contains the uniform resource identifier (URI) of the contributor.
Generator
string
Default: ""
This field identifies the generator of the feed.
Icon
string
Default: ""
This field contains a reference to the image that represents this feed.
Id
string
Default: ""
The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.
LinkHref
string
Default: ""
This field contains the location of the link.
LinkHrefLang
string
Default: ""
This field contains the language of the content at the link.
LinkLength
string
Default: ""
This field contains the length (in bytes) of the content at the link.
LinkRel
string
Default: ""
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
Default: ""
This field contains the title of the link.
LinkType
string
Default: ""
This field contains the multipurpose internet mail extension (MIME) type of the content at the link.
Logo
string
Default: ""
This field contains the logo for an image that represents the feed.
Rights
string
Default: ""
This field contains information about the rights of the given feed.
RightsTextType
ChannelRightsTextTypes
Default: 0
This field contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.
Subtitle
string
Default: ""
This field contains a short description of the Atom feed.
SubtitleTextType
ChannelSubtitleTextTypes
Default: 0
This field contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.
Title
string
Default: ""
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
ChannelTitleTextTypes
Default: 0
This field contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.
Updated
string
Default: ""
This field contains the date and time that the feed was updated.
Constructors
public AtomChannel();
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 (read-only)
Default: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
string (read-only)
Default: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string (read-only)
Default: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
string (read-only)
Default: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
string (read-only)
Default: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
string (read-only)
Default: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
string (read-only)
Default: ""
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
bool (read-only)
Default: False
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 (read-only)
Default: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string (read-only)
Default: ""
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 (read-only)
Default: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default: ""
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 (read-only)
Default: ""
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
Default: "MY"
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
StoreB
byte []
Default: "MY"
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
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., PKCS#12 certificate store).
StorePassword
string
Default: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default: 0
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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
string (read-only)
Default: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
string (read-only)
Default: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
string (read-only)
Default: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
string (read-only)
Default: ""
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 Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
string (read-only)
Default: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
string
Default: ""
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
string
Default: ""
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 []
Default: ""
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.
Constructors
public Certificate();
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);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] encoded);
Public Certificate(ByVal Encoded As Byte())
Parses Encoded as an X.509 public key.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to 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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
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 X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)
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 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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
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 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 X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);
Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
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 X.509 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
bool
Default: False
This field tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType
FirewallTypes
Default: 0
This field determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. Port 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
Default: ""
This field contains the name or IP address of the 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
Default: ""
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
Default: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
string
Default: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.
Constructors
Header Type
This is 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
Default: ""
This field contains the name of the HTTP Header (this is the same case as it is delivered).
Value
string
Default: ""
This field contains the Header contents.
Constructors
HTTPCookie Type
An HTTP cookie can be 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 also may store the cookies sent by the server.
Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.
Fields
Domain
string (read-only)
Default: ""
This is 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 (read-only)
Default: ""
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
Default: ""
This field, contains the name of the cookie.
This field, along with Value, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
Path
string (read-only)
Default: ""
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
bool (read-only)
Default: False
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 only through a secure (HTTPS) connection.
Value
string
Default: ""
This field contains the value of the cookie. A corresponding value is associated with the cookie specified by Name. This property holds that value.
The SetCookie event provides the cookies set by the server.
Constructors
public HTTPCookie();
Public HTTPCookie()
public HTTPCookie(string name, string value);
Public HTTPCookie(ByVal Name As String, ByVal Value As String)
ODataEntryLink Type
This is an object representing a single OData entry link.
Remarks
This is an object representing a single OData entry link.
Fields
ResourcePath
string (read-only)
Default: ""
This field contains 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 (read-only)
Default: ""
This field contains the title of the OData entry element link.
Constructors
public ODataEntryLink();
Public ODataEntryLink()
ODataEntryProperty Type
This is an object representing a single OData entry property.
Remarks
This is an object representing a single OData entry property.
Fields
Attributes
string
Default: ""
This field contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".
IsNull
bool
Default: False
This field indicates whether a property value of a primitive type is null.
Name
string
Default: ""
This field contains the name of the OData entry element.
Note: For properties derived from a complex type, the name of the property and its subproperty will be separated by a slash (/). 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 an empty string before calling UpdateEntry will result in the item not being sent in the update request, thus removing it from the OData entry.
Type
string
Default: ""
This field contains the type of the OData schema property.
Value
string
Default: ""
This field contains the value of the OData entry element.
XPath
string (read-only)
Default: ""
This field contains 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()
public ODataEntryProperty(string name, string value);
Public ODataEntryProperty(ByVal Name As String, ByVal Value As String)
public ODataEntryProperty(string name, string value, string type);
Public ODataEntryProperty(ByVal Name As String, ByVal Value As String, ByVal Type As String)
ODataSchemaAssociation Type
This is an object representing a single OData schema navigation property and its corresponding association.
Remarks
This is an object representing a single OData schema navigation property and its corresponding association.
Fields
ContainsTarget
bool (read-only)
Default: False
This field indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.
This field is applicable only to OData Version 4.
Description
string (read-only)
Default: ""
This field contains the documentation long description of the OData schema association.
FromRole
string (read-only)
Default: ""
This field contains the name of the starting point of the navigation.
FromRoleDescription
string (read-only)
Default: ""
This field contains the documentation long description of the OData schema FromRole association endpoint.
FromRoleEntity
string (read-only)
Default: ""
This field contains the name of the entity that the FromRole association endpoint maps to.
FromRoleMultiplicity
AssociationMultiplicities (read-only)
Default: 0
This field contains the multiplicity of the FromRole association endpoint. 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 as follows:
nmZeroOne (0) | Zero-One (0..1) |
nmOne (1) | One (1) |
nmMany (2) | Many (*) |
FromRoleSummary
string (read-only)
Default: ""
This field contains the documentation summary of the OData schema FromRole association endpoint.
Name
string (read-only)
Default: ""
This field contains the name of the OData schema navigation property.
Nullable
bool (read-only)
Default: True
This field indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.
This field is applicable only to OData Version 4.
OnDelete
AssociationDeleteActions (read-only)
Default: 0
This field contains the delete action to be performed.
The possible values are as follows:
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 also will be deleted. |
2 (daSetNull) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to null. This value is applicable only to OData Version 4. |
3 (daSetDefault) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to their default value. This value is applicable only to OData Version 4. |
Partner
string (read-only)
Default: ""
This field contains the partner value identifying a navigation property (if any).
This field is applicable only to OData Version 4.
RefConstraintCount
int (read-only)
Default: 0
This field contains the number of referential constraints. To examine the individual referential constraints set RefConstraintIndex
to a value from 0 to RefConstraintCount -1.
Example. Referential Constraints:
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 applicable only to OData Version 4.
RefConstraintIndex
int
Default: 0
This field contains the current index of the referential constraint. See RefConstraintCount for details.
This field is applicable only to OData Version 4.
RefConstraintProperty
string (read-only)
Default: ""
This field contains the property that takes part in the referential constraint.
This field is applicable only to OData Version 4.
RefConstraintReferencedProperty
string (read-only)
Default: ""
This field contains the corresponding property of the principal entity type.
This field is applicable only to OData Version 4.
Relationship
string (read-only)
Default: ""
This field contains the name of the relationship (association) of the navigation property.
Summary
string (read-only)
Default: ""
This field contains the documentation summary of the OData schema association.
ToRole
string (read-only)
Default: ""
This field contains the name of the endpoint of the navigation.
ToRoleDescription
string (read-only)
Default: ""
This field contains the documentation long description of the OData schema ToRole association endpoint.
ToRoleEntity
string (read-only)
Default: ""
This field contains the name of the entity that the ToRole association endpoint maps to.
ToRoleMultiplicity
AssociationMultiplicities (read-only)
Default: 0
This field contains the multiplicity of the ToRole association endpoint. 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 as follows:
nmZeroOne (0) | Zero-One (0..1) |
nmOne (1) | One (1) |
nmMany (2) | Many (*) |
ToRoleSummary
string (read-only)
Default: ""
This field contains the documentation summary of the OData schema ToRole association endpoint.
Type
string (read-only)
Default: ""
This field contains the entity type.
This field is applicable only to OData Version 4.
Constructors
public ODataSchemaAssociation();
Public ODataSchemaAssociation()
ODataSchemaEntity Type
This is an object representing a single OData schema entity.
Remarks
This is an object representing a single OData schema entity.
Fields
Description
string (read-only)
Default: ""
This field contains the documentation long description of the OData schema entity.
Name
string (read-only)
Default: ""
This field contains the name of the OData schema entity.
Summary
string (read-only)
Default: ""
This field contains the documentation summary of the OData schema entity.
Constructors
public ODataSchemaEntity();
Public ODataSchemaEntity()
ODataSchemaProperty Type
This is an object representing a single OData schema property.
Remarks
This is an object representing a single OData schema property.
Fields
Attributes
string (read-only)
Default: ""
This field contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".
Description
string (read-only)
Default: ""
This field contains the documentation long description of the OData schema property.
IsComplexType
bool (read-only)
Default: False
This field indicates whether a property is derived from a complex type.
When set to True, SchemaTypeField can be used to navigate the properties contained within the complex type.
Name
string (read-only)
Default: ""
This field contains the Name of the OData schema property.
Nullable
bool (read-only)
Default: False
This field indicates whether a property can be null.
Summary
string (read-only)
Default: ""
This field contains the documentation summary of the OData schema property.
Type
string (read-only)
Default: ""
This field contains the type of the OData schema property.
Constructors
public ODataSchemaProperty();
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
ProxyAuthSchemes
Default: 0
This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only 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
bool
Default: False
This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default: ""
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 fields 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
Default: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
string
Default: ""
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. 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
ProxySSLTypes
Default: 0
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an 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 made through a tunneling (HTTP) proxy. |
User
string
Default: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields 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
Config 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 Config Settings
0 (default) | SMTP Format: Name <e-mail address> |
1 | Name only. |
2 | E-mail address only. |
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
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.
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]".
The default value is False.
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: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
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.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect 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.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime 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 are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed 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 multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
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 configuration setting has no effect if SSLProvider is set to Platform.
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.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), 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.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
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 SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
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 traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "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 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 Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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 Config Settings
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.
- 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).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (OData Component)
OData Errors
601 | The feed URL is required. |
The component may also return one of the following error codes, which are inherited from other components.
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. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost 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 | You cannot change the 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |