OData Class
Properties Methods Events Config Settings Errors
The OData class implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.
Syntax
class ipworks.OData
Remarks
The OData Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config method.
The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the service_root_uri to the service's root URI and resource_path to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. query_service 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 service_root_uri to the service's root URI and resource_path 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. create_entry 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 service_root_uri to the service's root URI and resource_path to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. update_entry 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 service_root_uri to the service's root URI and resource_path to the specific entry you wish to delete. delete_entry 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 service_root_uri to the root URI of the service, get_schema 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 class with short descriptions. Click on the links for further details.
authorization | This property includes the Authorization string to be sent to the server. |
auth_scheme | The authentication scheme to use when server authentication is required. |
channel_author_email | This property contains the email address of the author. |
channel_author_name | This property contains the name of the author. |
channel_author_uri | This property contains the uniform resource identifier (URI) of the author. |
channel_category_label | This property contains a textual description of the label for the category. |
channel_category_scheme | This property identifies a categorization scheme. |
channel_category_term | This property contains the category to which the entry or feed belongs. |
channel_contributor_email | This property contains the email address of the contributor. |
channel_contributor_name | This property contains the name of the contributor. |
channel_contributor_uri | This property contains the uniform resource identifier (URI) of the contributor. |
channel_generator | This property identifies the generator of the feed. |
channel_icon | This property contains a reference to the image that represents this feed. |
channel_id | The Id conveys a permanent, universally unique identifier for an entry or feed. |
channel_link_href | This property contains the location of the link. |
channel_link_href_lang | This property contains the language of the content at the link. |
channel_link_length | This property contains the length (in bytes) of the content at the link. |
channel_link_rel | This property indicates the relation of the linked content to the feed. |
channel_link_title | This property contains the title of the link. |
channel_link_type | This property contains the multipurpose internet mail extension (MIME) type of the content at the link. |
channel_logo | This property contains the logo for an image that represents the feed. |
channel_rights | This property contains information about the rights of the given feed. |
channel_rights_text_type | This property contains the text type of the rights of the feed. |
channel_subtitle | This property contains a short description of the Atom feed. |
channel_subtitle_text_type | This property contains the text type of the subtitle of the feed. |
channel_title | This property contains the title of the current Atom feed. |
channel_title_text_type | This property contains the text type of the title of the feed. |
channel_updated | This property contains the date and time that the feed was updated. |
cookie_count | The number of records in the Cookie arrays. |
cookie_domain | This is the domain of a received cookie. |
cookie_expiration | This property contains an expiration time for the cookie (if provided by the server). |
cookie_name | This property, contains the name of the cookie. |
cookie_path | This property contains a path name to limit the cookie to (if provided by the server). |
cookie_secure | This property contains the security flag of the received cookie. |
cookie_value | This property contains the value of the cookie. |
entry_author | This property includes the author of the current entry in an OData feed. |
entry_count | This property includes the number of entries contained within an OData feed. |
entry_e_tag | This property includes the ETag of the current entry in an OData feed. |
entry_id | This property includes the Id of the current entry in an OData feed. |
entry_index | This property includes the index of the current entry in an OData feed. |
entry_links_count | The number of records in the EntryLinks arrays. |
entry_links_resource_path | This property contains the resource path of the OData entry element link. |
entry_links_title | This property contains the title of the OData entry element link. |
entry_properties_count | The number of records in the EntryProperties arrays. |
entry_properties_attributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. |
entry_properties_is_null | This property indicates whether a property value of a primitive type is null. |
entry_properties_name | This property contains the name of the OData entry element. |
entry_properties_type | This property contains the type of the OData schema property. |
entry_properties_value | This property contains the value of the OData entry element. |
entry_properties_xpath | This property contains the XPath of the OData entry property. |
entry_summary | This property includes a summary of the current entry in an OData feed. |
entry_title | This property includes the title of the current entry in an OData feed. |
entry_type | This property includes the entry category or type. |
entry_updated | This property includes the date-time when a current entry in an OData feed was updated. |
entry_xml | This property includes the raw XML of the current entry in an OData feed. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the transmission control protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
idle | The current status of the class. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
o_data_version | This property includes the OData version. |
other_headers | This property includes other headers as determined by the user (optional). |
other_query_options | This property includes additional query options to be used when querying a service. |
parsed_header_count | The number of records in the ParsedHeader arrays. |
parsed_header_field | This property contains the name of the HTTP header (this is the same case as it is delivered). |
parsed_header_value | This property contains the header contents. |
password | This property includes a password if authentication is to be used. |
proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
proxy_password | This property contains a password if authentication is to be used for the proxy. |
proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a username if authentication is to be used for the proxy. |
query_filter | This property selects only the entries that satisfy the specified filter (expression). |
query_order_by | This property includes the value used to order entries when querying a service. |
query_select | This property selects only the specified properties to be returned in an entry when querying a service. |
query_skip | This property includes the number of entries to skip when querying a service. |
query_skip_token | This property includes the token given by an OData server when the last query result collection is too large. |
query_top | This property selects the first N entries when querying a service. |
resource_path | This property includes the resource path of an OData service. |
schema_association_contains_target | This property indicates whether the navigation property contains a target. |
schema_association_description | This property contains the documentation long description of the OData schema association. |
schema_association_from_role | This property contains the name of the starting point of the navigation. |
schema_association_from_role_description | This property contains the documentation long description of the OData schema FromRole association endpoint. |
schema_association_from_role_entity | This property contains the name of the entity that the FromRole association endpoint maps to. |
schema_association_from_role_multiplicity | This property contains the multiplicity of the FromRole association endpoint. |
schema_association_from_role_summary | This property contains the documentation summary of the OData schema FromRole association endpoint. |
schema_association_name | This property contains the name of the OData schema navigation property. |
schema_association_nullable | This property indicates whether the property defined by the schema can be a null value. |
schema_association_on_delete | This property contains the delete action to be performed. |
schema_association_partner | This property contains the partner value identifying a navigation property (if any). |
schema_association_ref_constraint_count | This property contains the number of referential constraints. |
schema_association_ref_constraint_index | This property contains the current index of the referential constraint. |
schema_association_ref_constraint_property | This property contains the property that takes part in the referential constraint. |
schema_association_ref_constraint_referenced_property | This property contains the corresponding property of the principal entity type. |
schema_association_relationship | This property contains the name of the relationship (association) of the navigation property. |
schema_association_summary | This property contains the documentation summary of the OData schema association. |
schema_association_to_role | This property contains the name of the endpoint of the navigation. |
schema_association_to_role_description | This property contains the documentation long description of the OData schema ToRole association endpoint. |
schema_association_to_role_entity | This property contains the name of the entity that the ToRole association endpoint maps to. |
schema_association_to_role_multiplicity | This property contains the multiplicity of the ToRole association endpoint. |
schema_association_to_role_summary | This property contains the documentation summary of the OData schema ToRole association endpoint. |
schema_association_type | This property contains the entity type. |
schema_association_count | This property includes the number of navigation properties contained within an OData schema entity. |
schema_association_index | This property includes the index of the current navigation property in an OData schema entity. |
schema_entity_description | This property contains the documentation long description of the OData schema entity. |
schema_entity_name | This property contains the name of the OData schema entity. |
schema_entity_summary | This property contains the documentation summary of the OData schema entity. |
schema_entity_count | This property includes the number of entities contained within an OData schema. |
schema_entity_index | This property includes the index of the current entity in an OData schema. |
schema_keys_count | The number of records in the SchemaKeys array. |
schema_keys | This property includes the keys for a schema entity. |
schema_property_attributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
schema_property_description | This property contains the documentation long description of the OData schema property. |
schema_property_is_complex_type | This property indicates whether a property is derived from a complex type. |
schema_property_name | This property contains the Name of the OData schema property. |
schema_property_nullable | This property indicates whether a property can be null. |
schema_property_summary | This property contains the documentation summary of the OData schema property. |
schema_property_type | This property contains the type of the OData schema property. |
schema_property_count | This property includes the number of properties contained within an OData schema entity. |
schema_property_index | This property includes the index of the current property in an OData schema entity. |
schema_type_field_attributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
schema_type_field_description | This property contains the documentation long description of the OData schema property. |
schema_type_field_is_complex_type | This property indicates whether a property is derived from a complex type. |
schema_type_field_name | This property contains the Name of the OData schema property. |
schema_type_field_nullable | This property indicates whether a property can be null. |
schema_type_field_summary | This property contains the documentation summary of the OData schema property. |
schema_type_field_type | This property contains the type of the OData schema property. |
schema_type_field_count | This property includes the number of properties contained within an OData schema complex type. |
schema_type_field_index | This property includes the index of the current field (property) in an OData schema complex type. |
service_root_uri | This property includes the root URI of an OData service. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_encoded | This is the certificate (PEM/Base64 encoded). |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_cert_store_type | This is the type of certificate store for this certificate. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_provider | This specifies the SSL/TLS implementation to use. |
ssl_server_cert_encoded | This is the certificate (PEM/Base64 encoded). |
timeout | A timeout for the class. |
transferred_data | 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 class with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
create_entry | This method creates a new entry within the specified OData service resource. |
custom_request | This method sends a request to the specified URL using the HTTPMethod and PostData provided. |
delete_entry | This method deletes an entry within an OData service resource. |
get_entry_property | This method gets an OData entry property. |
get_schema | This method retrieves the schema for a service. |
has_xpath | Determines whether a specific element exists in the document. |
query_service | This method queries an OData service using the specified parameters. |
reset | This method resets all of properties of the class. |
set_entry_property | This method is used to set an OData entry property. |
set_schema_entity | This method sets the schema entity. |
set_schema_property | This method sets the schema property. |
set_schema_type | This method sets the schema type. |
update_entry | This method updates an OData entry. |
update_property | This method updates an OData entry property. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_connected | This event is fired immediately after a connection completes (or fails). |
on_disconnected | This event is fired when a connection is closed. |
on_end_transfer | This event fires when a document finishes transferring. |
on_entity | This event is fired once for each entity retrieved. |
on_entry | This event is fired once for each entry retrieved. |
on_error | Fired when information is available about errors during data delivery. |
on_header | This event is fired every time a header line comes in. |
on_log | This event fires once for each log message. |
on_property | This event is fired once for each property found within an entity. |
on_set_cookie | This event is fired for every cookie set by the server. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Fired when secure connection progress messages are available. |
on_start_transfer | This event fires when a document starts transferring (after the headers). |
on_status | This event is fired when the HTTP status line is received from the server. |
on_transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
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. |
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 class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class 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 class. |
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. |
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 class. |
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. |
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). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
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 class 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. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
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. |
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 certificate 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. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
authorization Property
This property includes the Authorization string to be sent to the server.
Syntax
def get_authorization() -> str: ... def set_authorization(value: str) -> None: ...
authorization = property(get_authorization, set_authorization)
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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme 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]".
auth_scheme Property
The authentication scheme to use when server authentication is required.
Syntax
def get_auth_scheme() -> int: ... def set_auth_scheme(value: int) -> None: ...
auth_scheme = property(get_auth_scheme, set_auth_scheme)
Default Value
0
Remarks
This property will tell the class 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 class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.
If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.
If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.
Note: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class.
For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.
channel_author_email Property
This property contains the email address of the author.
Syntax
def get_channel_author_email() -> str: ... def set_channel_author_email(value: str) -> None: ...
channel_author_email = property(get_channel_author_email, set_channel_author_email)
Default Value
""
Remarks
This property contains the email address of the author.
channel_author_name Property
This property contains the name of the author.
Syntax
def get_channel_author_name() -> str: ... def set_channel_author_name(value: str) -> None: ...
channel_author_name = property(get_channel_author_name, set_channel_author_name)
Default Value
""
Remarks
This property contains the name of the author.
channel_author_uri Property
This property contains the uniform resource identifier (URI) of the author.
Syntax
def get_channel_author_uri() -> str: ... def set_channel_author_uri(value: str) -> None: ...
channel_author_uri = property(get_channel_author_uri, set_channel_author_uri)
Default Value
""
Remarks
This property contains the uniform resource identifier (URI) of the author.
channel_category_label Property
This property contains a textual description of the label for the category.
Syntax
def get_channel_category_label() -> str: ... def set_channel_category_label(value: str) -> None: ...
channel_category_label = property(get_channel_category_label, set_channel_category_label)
Default Value
""
Remarks
This property contains a textual description of the label for the category.
channel_category_scheme Property
This property identifies a categorization scheme.
Syntax
def get_channel_category_scheme() -> str: ... def set_channel_category_scheme(value: str) -> None: ...
channel_category_scheme = property(get_channel_category_scheme, set_channel_category_scheme)
Default Value
""
Remarks
This property identifies a categorization scheme.
channel_category_term Property
This property contains the category to which the entry or feed belongs.
Syntax
def get_channel_category_term() -> str: ... def set_channel_category_term(value: str) -> None: ...
channel_category_term = property(get_channel_category_term, set_channel_category_term)
Default Value
""
Remarks
This property contains the category to which the entry or feed belongs.
channel_contributor_email Property
This property contains the email address of the contributor.
Syntax
def get_channel_contributor_email() -> str: ... def set_channel_contributor_email(value: str) -> None: ...
channel_contributor_email = property(get_channel_contributor_email, set_channel_contributor_email)
Default Value
""
Remarks
This property contains the email address of the contributor.
channel_contributor_name Property
This property contains the name of the contributor.
Syntax
def get_channel_contributor_name() -> str: ... def set_channel_contributor_name(value: str) -> None: ...
channel_contributor_name = property(get_channel_contributor_name, set_channel_contributor_name)
Default Value
""
Remarks
This property contains the name of the contributor.
channel_contributor_uri Property
This property contains the uniform resource identifier (URI) of the contributor.
Syntax
def get_channel_contributor_uri() -> str: ... def set_channel_contributor_uri(value: str) -> None: ...
channel_contributor_uri = property(get_channel_contributor_uri, set_channel_contributor_uri)
Default Value
""
Remarks
This property contains the uniform resource identifier (URI) of the contributor.
channel_generator Property
This property identifies the generator of the feed.
Syntax
def get_channel_generator() -> str: ... def set_channel_generator(value: str) -> None: ...
channel_generator = property(get_channel_generator, set_channel_generator)
Default Value
""
Remarks
This property identifies the generator of the feed.
channel_icon Property
This property contains a reference to the image that represents this feed.
Syntax
def get_channel_icon() -> str: ... def set_channel_icon(value: str) -> None: ...
channel_icon = property(get_channel_icon, set_channel_icon)
Default Value
""
Remarks
This property contains a reference to the image that represents this feed.
channel_id Property
The Id conveys a permanent, universally unique identifier for an entry or feed.
Syntax
def get_channel_id() -> str: ... def set_channel_id(value: str) -> None: ...
channel_id = property(get_channel_id, set_channel_id)
Default Value
""
Remarks
The Id conveys a permanent, universally unique identifier for an entry or feed. This contains an IRI as defined by RFC 3987.
channel_link_href Property
This property contains the location of the link.
Syntax
def get_channel_link_href() -> str: ... def set_channel_link_href(value: str) -> None: ...
channel_link_href = property(get_channel_link_href, set_channel_link_href)
Default Value
""
Remarks
This property contains the location of the link.
channel_link_href_lang Property
This property contains the language of the content at the link.
Syntax
def get_channel_link_href_lang() -> str: ... def set_channel_link_href_lang(value: str) -> None: ...
channel_link_href_lang = property(get_channel_link_href_lang, set_channel_link_href_lang)
Default Value
""
Remarks
This property contains the language of the content at the link.
channel_link_length Property
This property contains the length (in bytes) of the content at the link.
Syntax
def get_channel_link_length() -> str: ... def set_channel_link_length(value: str) -> None: ...
channel_link_length = property(get_channel_link_length, set_channel_link_length)
Default Value
""
Remarks
This property contains the length (in bytes) of the content at the link.
channel_link_rel Property
This property indicates the relation of the linked content to the feed.
Syntax
def get_channel_link_rel() -> str: ... def set_channel_link_rel(value: str) -> None: ...
channel_link_rel = property(get_channel_link_rel, set_channel_link_rel)
Default Value
""
Remarks
This property indicates the relation of the linked content to the feed. The following relations are defined by RFC 4287:
- alternate
- related
- self
- enclosure
- via
channel_link_title Property
This property contains the title of the link.
Syntax
def get_channel_link_title() -> str: ... def set_channel_link_title(value: str) -> None: ...
channel_link_title = property(get_channel_link_title, set_channel_link_title)
Default Value
""
Remarks
This property contains the title of the link.
channel_link_type Property
This property contains the multipurpose internet mail extension (MIME) type of the content at the link.
Syntax
def get_channel_link_type() -> str: ... def set_channel_link_type(value: str) -> None: ...
channel_link_type = property(get_channel_link_type, set_channel_link_type)
Default Value
""
Remarks
This property contains the multipurpose internet mail extension (MIME) type of the content at the link.
channel_logo Property
This property contains the logo for an image that represents the feed.
Syntax
def get_channel_logo() -> str: ... def set_channel_logo(value: str) -> None: ...
channel_logo = property(get_channel_logo, set_channel_logo)
Default Value
""
Remarks
This property contains the logo for an image that represents the feed.
channel_rights Property
This property contains information about the rights of the given feed.
Syntax
def get_channel_rights() -> str: ... def set_channel_rights(value: str) -> None: ...
channel_rights = property(get_channel_rights, set_channel_rights)
Default Value
""
Remarks
This property contains information about the rights of the given feed.
channel_rights_text_type Property
This property contains the text type of the rights of the feed.
Syntax
def get_channel_rights_text_type() -> int: ... def set_channel_rights_text_type(value: int) -> None: ...
channel_rights_text_type = property(get_channel_rights_text_type, set_channel_rights_text_type)
Default Value
0
Remarks
This property contains the text type of the rights of the feed. Atom textual content can be HTML, XHTML, or text.
channel_subtitle Property
This property contains a short description of the Atom feed.
Syntax
def get_channel_subtitle() -> str: ... def set_channel_subtitle(value: str) -> None: ...
channel_subtitle = property(get_channel_subtitle, set_channel_subtitle)
Default Value
""
Remarks
This property contains a short description of the Atom feed.
channel_subtitle_text_type Property
This property contains the text type of the subtitle of the feed.
Syntax
def get_channel_subtitle_text_type() -> int: ... def set_channel_subtitle_text_type(value: int) -> None: ...
channel_subtitle_text_type = property(get_channel_subtitle_text_type, set_channel_subtitle_text_type)
Default Value
0
Remarks
This property contains the text type of the subtitle of the feed. Atom textual content can be HTML, XHTML, or text.
channel_title Property
This property contains the title of the current Atom feed.
Syntax
def get_channel_title() -> str: ... def set_channel_title(value: str) -> None: ...
channel_title = property(get_channel_title, set_channel_title)
Default Value
""
Remarks
This property 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.
channel_title_text_type Property
This property contains the text type of the title of the feed.
Syntax
def get_channel_title_text_type() -> int: ... def set_channel_title_text_type(value: int) -> None: ...
channel_title_text_type = property(get_channel_title_text_type, set_channel_title_text_type)
Default Value
0
Remarks
This property contains the text type of the title of the feed. Atom textual content can be HTML, XHTML, or text.
channel_updated Property
This property contains the date and time that the feed was updated.
Syntax
def get_channel_updated() -> str: ... def set_channel_updated(value: str) -> None: ...
channel_updated = property(get_channel_updated, set_channel_updated)
Default Value
""
Remarks
This property contains the date and time that the feed was updated.
cookie_count Property
The number of records in the Cookie arrays.
Syntax
def get_cookie_count() -> int: ... def set_cookie_count(value: int) -> None: ...
cookie_count = property(get_cookie_count, set_cookie_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at cookie_count - 1.cookie_domain Property
This is the domain of a received cookie.
Syntax
def get_cookie_domain(cookie_index: int) -> str: ...
Default Value
""
Remarks
This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_expiration Property
This property contains an expiration time for the cookie (if provided by the server).
Syntax
def get_cookie_expiration(cookie_index: int) -> str: ...
Default Value
""
Remarks
This property 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 property will contain an empty string. The convention is to drop the cookie at the end of the session.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_name Property
This property, contains the name of the cookie.
Syntax
def get_cookie_name(cookie_index: int) -> str: ... def set_cookie_name(cookie_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property, contains the name of the cookie.
This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
cookie_path Property
This property contains a path name to limit the cookie to (if provided by the server).
Syntax
def get_cookie_path(cookie_index: int) -> str: ...
Default Value
""
Remarks
This property 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 property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_secure Property
This property contains the security flag of the received cookie.
Syntax
def get_cookie_secure(cookie_index: int) -> bool: ...
Default Value
FALSE
Remarks
This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_value Property
This property contains the value of the cookie.
Syntax
def get_cookie_value(cookie_index: int) -> str: ... def set_cookie_value(cookie_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.
The on_set_cookie event provides the cookies set by the server.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
entry_author Property
This property includes the author of the current entry in an OData feed.
Syntax
def get_entry_author() -> str: ... def set_entry_author(value: str) -> None: ...
entry_author = property(get_entry_author, set_entry_author)
Default Value
""
Remarks
This property contains the author of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an author can be found).
This property is not applicable to OData V4 feeds.
entry_count Property
This property includes the number of entries contained within an OData feed.
Syntax
def get_entry_count() -> int: ...
entry_count = property(get_entry_count, None)
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.
entry_e_tag Property
This property includes the ETag of the current entry in an OData feed.
Syntax
def get_entry_e_tag() -> str: ... def set_entry_e_tag(value: str) -> None: ...
entry_e_tag = property(get_entry_e_tag, set_entry_e_tag)
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 entry_index 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 query_service is called. When delete_entry or update_entry is called, an If-Match header will be sent with the entered value.
entry_id Property
This property includes the Id of the current entry in an OData feed.
Syntax
def get_entry_id() -> str: ... def set_entry_id(value: str) -> None: ...
entry_id = property(get_entry_id, set_entry_id)
Default Value
""
Remarks
This property contains the Id of the specified entry within an OData feed. This value will be populated once entry_index is set (provided that an Id can be found).
entry_index Property
This property includes the index of the current entry in an OData feed.
Syntax
def get_entry_index() -> int: ... def set_entry_index(value: int) -> None: ...
entry_index = property(get_entry_index, set_entry_index)
Default Value
-1
Remarks
This property is used to specify an entry within a retrieved OData feed. Once set, entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path will be populated with their respective values found within the entry.
This property takes index values from 0 to entry_count -1.
Setting EntryIndex to -1 will clear the entries contained by the component and also will reset entry_properties and entry_count.
entry_links_count Property
The number of records in the EntryLinks arrays.
Syntax
def get_entry_links_count() -> int: ... def set_entry_links_count(value: int) -> None: ...
entry_links_count = property(get_entry_links_count, set_entry_links_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at entry_links_count - 1.entry_links_resource_path Property
This property contains the resource path of the OData entry element link.
Syntax
def get_entry_links_resource_path(entry_links_index: int) -> str: ...
Default Value
""
Remarks
This property contains the resource path of the OData entry element link.
By setting this value to resource_path and calling query_service, you can retrieve the related entries of the current entry (as specified by entry_index).
The entry_links_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_links_count property.
This property is read-only.
entry_links_title Property
This property contains the title of the OData entry element link.
Syntax
def get_entry_links_title(entry_links_index: int) -> str: ...
Default Value
""
Remarks
This property contains the title of the OData entry element link.
The entry_links_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_links_count property.
This property is read-only.
entry_properties_count Property
The number of records in the EntryProperties arrays.
Syntax
def get_entry_properties_count() -> int: ... def set_entry_properties_count(value: int) -> None: ...
entry_properties_count = property(get_entry_properties_count, set_entry_properties_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
- entry_properties_attributes
- entry_properties_is_null
- entry_properties_name
- entry_properties_type
- entry_properties_value
- entry_properties_xpath
entry_properties_attributes Property
This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element.
Syntax
def get_entry_properties_attributes(entry_properties_index: int) -> str: ... def set_entry_properties_attributes(entry_properties_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
entry_properties_is_null Property
This property indicates whether a property value of a primitive type is null.
Syntax
def get_entry_properties_is_null(entry_properties_index: int) -> bool: ... def set_entry_properties_is_null(entry_properties_index: int, value: bool) -> None: ...
Default Value
FALSE
Remarks
This property indicates whether a property value of a primitive type is null.
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
entry_properties_name Property
This property contains the name of the OData entry element.
Syntax
def get_entry_properties_name(entry_properties_index: int) -> str: ... def set_entry_properties_name(entry_properties_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property 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 update_entry will result in the item not being sent in the update request, thus removing it from the OData entry.
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
entry_properties_type Property
This property contains the type of the OData schema property.
Syntax
def get_entry_properties_type(entry_properties_index: int) -> str: ... def set_entry_properties_type(entry_properties_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the type of the OData schema property.
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
entry_properties_value Property
This property contains the value of the OData entry element.
Syntax
def get_entry_properties_value(entry_properties_index: int) -> str: ... def set_entry_properties_value(entry_properties_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the value of the OData entry element.
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
entry_properties_xpath Property
This property contains the XPath of the OData entry property.
Syntax
def get_entry_properties_xpath(entry_properties_index: int) -> str: ...
Default Value
""
Remarks
This property contains the XPath of the OData entry property. This value can be used to set xpath or can be used within update_property to update a specific property.
The entry_properties_index parameter specifies the index of the item in the array. The size of the array is controlled by the entry_properties_count property.
This property is read-only.
entry_summary Property
This property includes a summary of the current entry in an OData feed.
Syntax
def get_entry_summary() -> str: ... def set_entry_summary(value: str) -> None: ...
entry_summary = property(get_entry_summary, set_entry_summary)
Default Value
""
Remarks
This property contains the summary of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a summary can be found).
This property is not applicable to OData V4 feeds.
entry_title Property
This property includes the title of the current entry in an OData feed.
Syntax
def get_entry_title() -> str: ... def set_entry_title(value: str) -> None: ...
entry_title = property(get_entry_title, set_entry_title)
Default Value
""
Remarks
This property contains the title of a specified entry within an OData feed. This value will be populated once entry_index is set (provided that a title can be found).
entry_type Property
This property includes the entry category or type.
Syntax
def get_entry_type() -> str: ... def set_entry_type(value: str) -> None: ...
entry_type = property(get_entry_type, set_entry_type)
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.
entry_updated Property
This property includes the date-time when a current entry in an OData feed was updated.
Syntax
def get_entry_updated() -> str: ...
entry_updated = property(get_entry_updated, None)
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 entry_index is set (provided that a data-time can be found).
This property is not applicable to OData V4 feeds.
This property is read-only.
entry_xml Property
This property includes the raw XML of the current entry in an OData feed.
Syntax
def get_entry_xml() -> str: ... def set_entry_xml(value: str) -> None: ...
entry_xml = property(get_entry_xml, set_entry_xml)
Default Value
""
Remarks
This property contains the raw XML of a specified entry within an OData feed. This value will be populated once entry_index is set.
firewall_auto_detect Property
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines the type of firewall to connect through.
Syntax
def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
Default Value
0
Remarks
This property 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. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of firewall (optional).
Syntax
def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ...
firewall_host = property(get_firewall_host, set_firewall_host)
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.
firewall_password Property
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
firewall_port Property
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.
Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.
firewall_user Property
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ...
firewall_user = property(get_firewall_user, set_firewall_user)
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
idle Property
The current status of the class.
Syntax
def get_idle() -> bool: ...
idle = property(get_idle, None)
Default Value
TRUE
Remarks
idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: local_host is not persistent. You must always set it in code, and never in the property window.
o_data_version Property
This property includes the OData version.
Syntax
def get_o_data_version() -> int: ... def set_o_data_version(value: int) -> None: ...
o_data_version = property(get_o_data_version, set_o_data_version)
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.
other_headers Property
This property includes other headers as determined by the user (optional).
Syntax
def get_other_headers() -> str: ... def set_other_headers(value: str) -> None: ...
other_headers = property(get_other_headers, set_other_headers)
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 content_type and from_.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
other_query_options Property
This property includes additional query options to be used when querying a service.
Syntax
def get_other_query_options() -> str: ... def set_other_query_options(value: str) -> None: ...
other_query_options = property(get_other_query_options, set_other_query_options)
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 service_root_uri, resource_path, and any Query*** properties specified).
parsed_header_count Property
The number of records in the ParsedHeader arrays.
Syntax
def get_parsed_header_count() -> int: ...
parsed_header_count = property(get_parsed_header_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at parsed_header_count - 1.This property is read-only.
parsed_header_field Property
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
def get_parsed_header_field(parsed_header_index: int) -> str: ...
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.
This property is read-only.
parsed_header_value Property
This property contains the header contents.
Syntax
def get_parsed_header_value(parsed_header_index: int) -> str: ...
Default Value
""
Remarks
This property contains the Header contents.
The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.
This property is read-only.
password Property
This property includes a password if authentication is to be used.
Syntax
def get_password() -> str: ... def set_password(value: str) -> None: ...
password = property(get_password, set_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.
proxy_auth_scheme Property
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ...
proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.
proxy_auth_scheme should be set to authNone (3) when no authentication is expected.
By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.
If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.
If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of proxy_user and proxy_password.
proxy_auto_detect Property
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ...
proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
This property contains a password if authentication is to be used for the proxy.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
proxy_port Property
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.
proxy_server Property
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ...
proxy_server = property(get_proxy_server, set_proxy_server)
Default Value
""
Remarks
If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.
proxy_ssl Property
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ...
proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)
Default Value
0
Remarks
This property 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 class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a username if authentication is to be used for the proxy.
Syntax
def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ...
proxy_user = property(get_proxy_user, set_proxy_user)
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
query_filter Property
This property selects only the entries that satisfy the specified filter (expression).
Syntax
def get_query_filter() -> str: ... def set_query_filter(value: str) -> None: ...
query_filter = property(get_query_filter, set_query_filter)
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')" |
query_order_by Property
This property includes the value used to order entries when querying a service.
Syntax
def get_query_order_by() -> str: ... def set_query_order_by(value: str) -> None: ...
query_order_by = property(get_query_order_by, set_query_order_by)
Default Value
""
Remarks
This property allows you to specify a value by which the returned entries will be ordered after a call to query_service.
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 query_order_by to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.
query_select Property
This property selects only the specified properties to be returned in an entry when querying a service.
Syntax
def get_query_select() -> str: ... def set_query_select(value: str) -> None: ...
query_select = property(get_query_select, set_query_select)
Default Value
""
Remarks
This property allows you to specify the specific properties you want returned within an entry when calling query_service. 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 query_select to Name,Price.
Note: The specified values can be a property name, navigation property name (entry_links_title), or the "*" character, which returns all the properties for each entry.
query_skip Property
This property includes the number of entries to skip when querying a service.
Syntax
def get_query_skip() -> str: ... def set_query_skip(value: str) -> None: ...
query_skip = property(get_query_skip, set_query_skip)
Default Value
""
Remarks
This property allows you to specify the number of entries to skip (from the top of the list) when calling query_service. 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 query_order_by to specify how the entries should be sorted before skipping the top N items.
This property can be used in conjunction with query_order_by and query_top to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set query_order_by to Rating desc (to order the items by Rating from highest to lowest), set query_skip to 2 (to skip the first and second items), and finally set query_top to 2 (to return only the third and fourth items).
query_skip_token Property
This property includes the token given by an OData server when the last query result collection is too large.
Syntax
def get_query_skip_token() -> str: ... def set_query_skip_token(value: str) -> None: ...
query_skip_token = property(get_query_skip_token, set_query_skip_token)
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 query_skip_token with the returned value. Calling query_service again will return the next page of results.
query_top Property
This property selects the first N entries when querying a service.
Syntax
def get_query_top() -> str: ... def set_query_top(value: str) -> None: ...
query_top = property(get_query_top, set_query_top)
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 query_service. 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 query_order_by to specify how the entries should be sorted before selecting the top N items.
resource_path Property
This property includes the resource path of an OData service.
Syntax
def get_resource_path() -> str: ... def set_resource_path(value: str) -> None: ...
resource_path = property(get_resource_path, set_resource_path)
Default Value
""
Remarks
This property contains the resource path of an OData service and is used in conjunction with service_root_uri (service_root_uri/resource_path) to query feeds and modify entries.
This property will be populated when entry_index is set. You can change the value if you wish to send the request to a different resource path.
For example, a valid resource_path for the OData sample service is Products.
schema_association_contains_target Property
This property indicates whether the navigation property contains a target.
Syntax
def get_schema_association_contains_target() -> bool: ...
schema_association_contains_target = property(get_schema_association_contains_target, None)
Default Value
FALSE
Remarks
This property indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_description Property
This property contains the documentation long description of the OData schema association.
Syntax
def get_schema_association_description() -> str: ...
schema_association_description = property(get_schema_association_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema association.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_from_role Property
This property contains the name of the starting point of the navigation.
Syntax
def get_schema_association_from_role() -> str: ...
schema_association_from_role = property(get_schema_association_from_role, None)
Default Value
""
Remarks
This property contains the name of the starting point of the navigation.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_from_role_description Property
This property contains the documentation long description of the OData schema FromRole association endpoint.
Syntax
def get_schema_association_from_role_description() -> str: ...
schema_association_from_role_description = property(get_schema_association_from_role_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema FromRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_from_role_entity Property
This property contains the name of the entity that the FromRole association endpoint maps to.
Syntax
def get_schema_association_from_role_entity() -> str: ...
schema_association_from_role_entity = property(get_schema_association_from_role_entity, None)
Default Value
""
Remarks
This property contains the name of the entity that the schema_association_from_role association endpoint maps to.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_from_role_multiplicity Property
This property contains the multiplicity of the FromRole association endpoint.
Syntax
def get_schema_association_from_role_multiplicity() -> int: ...
schema_association_from_role_multiplicity = property(get_schema_association_from_role_multiplicity, None)
Default Value
0
Remarks
This property contains the multiplicity of the schema_association_from_role association endpoint. This is used along with schema_association_to_role_multiplicity 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 (*) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_from_role_summary Property
This property contains the documentation summary of the OData schema FromRole association endpoint.
Syntax
def get_schema_association_from_role_summary() -> str: ...
schema_association_from_role_summary = property(get_schema_association_from_role_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema FromRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_name Property
This property contains the name of the OData schema navigation property.
Syntax
def get_schema_association_name() -> str: ...
schema_association_name = property(get_schema_association_name, None)
Default Value
""
Remarks
This property contains the name of the OData schema navigation property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_nullable Property
This property indicates whether the property defined by the schema can be a null value.
Syntax
def get_schema_association_nullable() -> bool: ...
schema_association_nullable = property(get_schema_association_nullable, None)
Default Value
TRUE
Remarks
This property indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_on_delete Property
This property contains the delete action to be performed.
Syntax
def get_schema_association_on_delete() -> int: ...
schema_association_on_delete = property(get_schema_association_on_delete, None)
Default Value
0
Remarks
This property contains the delete action to be performed.
The possible values are as follows:
0 (daNone) | Only the specified entry instance within schema_association_from_role_entity is deleted. This is the default value. |
1 (daCascade) | After the specified entry instance is deleted within schema_association_from_role_entity, the action is applied to the entry instance within the schema_association_to_role_entity. 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. |
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_partner Property
This property contains the partner value identifying a navigation property (if any).
Syntax
def get_schema_association_partner() -> str: ...
schema_association_partner = property(get_schema_association_partner, None)
Default Value
""
Remarks
This property contains the partner value identifying a navigation property (if any).
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_ref_constraint_count Property
This property contains the number of referential constraints.
Syntax
def get_schema_association_ref_constraint_count() -> int: ...
schema_association_ref_constraint_count = property(get_schema_association_ref_constraint_count, None)
Default Value
0
Remarks
This property contains the number of referential constraints. To examine the individual referential constraints set schema_association_ref_constraint_index
to a value from 0 to schema_association_ref_constraint_count -1.
Example. Referential Contraints:
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 property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_ref_constraint_index Property
This property contains the current index of the referential constraint.
Syntax
def get_schema_association_ref_constraint_index() -> int: ... def set_schema_association_ref_constraint_index(value: int) -> None: ...
schema_association_ref_constraint_index = property(get_schema_association_ref_constraint_index, set_schema_association_ref_constraint_index)
Default Value
0
Remarks
This property contains the current index of the referential constraint. See schema_association_ref_constraint_count for details.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
schema_association_ref_constraint_property Property
This property contains the property that takes part in the referential constraint.
Syntax
def get_schema_association_ref_constraint_property() -> str: ...
schema_association_ref_constraint_property = property(get_schema_association_ref_constraint_property, None)
Default Value
""
Remarks
This property contains the property that takes part in the referential constraint.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_ref_constraint_referenced_property Property
This property contains the corresponding property of the principal entity type.
Syntax
def get_schema_association_ref_constraint_referenced_property() -> str: ...
schema_association_ref_constraint_referenced_property = property(get_schema_association_ref_constraint_referenced_property, None)
Default Value
""
Remarks
This property contains the corresponding property of the principal entity type.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_relationship Property
This property contains the name of the relationship (association) of the navigation property.
Syntax
def get_schema_association_relationship() -> str: ...
schema_association_relationship = property(get_schema_association_relationship, None)
Default Value
""
Remarks
This property contains the name of the relationship (association) of the navigation property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_summary Property
This property contains the documentation summary of the OData schema association.
Syntax
def get_schema_association_summary() -> str: ...
schema_association_summary = property(get_schema_association_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema association.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_to_role Property
This property contains the name of the endpoint of the navigation.
Syntax
def get_schema_association_to_role() -> str: ...
schema_association_to_role = property(get_schema_association_to_role, None)
Default Value
""
Remarks
This property contains the name of the endpoint of the navigation.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_to_role_description Property
This property contains the documentation long description of the OData schema ToRole association endpoint.
Syntax
def get_schema_association_to_role_description() -> str: ...
schema_association_to_role_description = property(get_schema_association_to_role_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema ToRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_to_role_entity Property
This property contains the name of the entity that the ToRole association endpoint maps to.
Syntax
def get_schema_association_to_role_entity() -> str: ...
schema_association_to_role_entity = property(get_schema_association_to_role_entity, None)
Default Value
""
Remarks
This property contains the name of the entity that the schema_association_to_role association endpoint maps to.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_to_role_multiplicity Property
This property contains the multiplicity of the ToRole association endpoint.
Syntax
def get_schema_association_to_role_multiplicity() -> int: ...
schema_association_to_role_multiplicity = property(get_schema_association_to_role_multiplicity, None)
Default Value
0
Remarks
This property contains the multiplicity of the schema_association_to_role association endpoint. This is used along with schema_association_from_role_multiplicity 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 (*) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_to_role_summary Property
This property contains the documentation summary of the OData schema ToRole association endpoint.
Syntax
def get_schema_association_to_role_summary() -> str: ...
schema_association_to_role_summary = property(get_schema_association_to_role_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema ToRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_type Property
This property contains the entity type.
Syntax
def get_schema_association_type() -> str: ...
schema_association_type = property(get_schema_association_type, None)
Default Value
""
Remarks
This property contains the entity type.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_association_count property.
This property is read-only.
schema_association_count Property
This property includes the number of navigation properties contained within an OData schema entity.
Syntax
def get_schema_association_count() -> int: ...
schema_association_count = property(get_schema_association_count, None)
Default Value
0
Remarks
This property is updated to reflect the total number of navigation properties within the schema entity specified by schema_entity_index.
This property is read-only.
schema_association_index Property
This property includes the index of the current navigation property in an OData schema entity.
Syntax
def get_schema_association_index() -> int: ... def set_schema_association_index(value: int) -> None: ...
schema_association_index = property(get_schema_association_index, set_schema_association_index)
Default Value
0
Remarks
This property is used to specify a navigation property within an entity (specified by schema_entity_index). Once set, schema_association will be populated.
schema_entity_description Property
This property contains the documentation long description of the OData schema entity.
Syntax
def get_schema_entity_description() -> str: ...
schema_entity_description = property(get_schema_entity_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.
This property is read-only.
schema_entity_name Property
This property contains the name of the OData schema entity.
Syntax
def get_schema_entity_name() -> str: ...
schema_entity_name = property(get_schema_entity_name, None)
Default Value
""
Remarks
This property contains the name of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.
This property is read-only.
schema_entity_summary Property
This property contains the documentation summary of the OData schema entity.
Syntax
def get_schema_entity_summary() -> str: ...
schema_entity_summary = property(get_schema_entity_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_entity_count property.
This property is read-only.
schema_entity_count Property
This property includes the number of entities contained within an OData schema.
Syntax
def get_schema_entity_count() -> int: ...
schema_entity_count = property(get_schema_entity_count, None)
Default Value
0
Remarks
This property is updated to reflect the total number of entities within a schema (retrieved via get_schema).
This property is read-only.
schema_entity_index Property
This property includes the index of the current entity in an OData schema.
Syntax
def get_schema_entity_index() -> int: ... def set_schema_entity_index(value: int) -> None: ...
schema_entity_index = property(get_schema_entity_index, set_schema_entity_index)
Default Value
0
Remarks
This property is used to specify an entity within a retrieved OData schema. Once set, schema_entity will be populated.
schema_keys_count Property
The number of records in the SchemaKeys array.
Syntax
def get_schema_keys_count() -> int: ...
schema_keys_count = property(get_schema_keys_count, None)
Default Value
0
Remarks
This property is read-only.
schema_keys Property
This property includes the keys for a schema entity.
Syntax
def get_schema_keys(schema_keys_index: int) -> str: ...
Default Value
"0"
Remarks
This property is used to obtain the keys contained within an entity for a service schema and is populated after setting schema_entity_index.
Note: Key values map to a property of the entity, details of which can be retrieved via schema_property.
This property is read-only.
schema_property_attributes Property
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.
Syntax
def get_schema_property_attributes() -> str: ...
schema_property_attributes = property(get_schema_property_attributes, None)
Default Value
""
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_description Property
This property contains the documentation long description of the OData schema property.
Syntax
def get_schema_property_description() -> str: ...
schema_property_description = property(get_schema_property_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_is_complex_type Property
This property indicates whether a property is derived from a complex type.
Syntax
def get_schema_property_is_complex_type() -> bool: ...
schema_property_is_complex_type = property(get_schema_property_is_complex_type, None)
Default Value
FALSE
Remarks
This property indicates whether a property is derived from a complex type.
When set tp True, schema_type_field can be used to navigate the properties contained within the complex type.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_name Property
This property contains the Name of the OData schema property.
Syntax
def get_schema_property_name() -> str: ...
schema_property_name = property(get_schema_property_name, None)
Default Value
""
Remarks
This property contains the Name of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_nullable Property
This property indicates whether a property can be null.
Syntax
def get_schema_property_nullable() -> bool: ...
schema_property_nullable = property(get_schema_property_nullable, None)
Default Value
FALSE
Remarks
This property indicates whether a property can be null.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_summary Property
This property contains the documentation summary of the OData schema property.
Syntax
def get_schema_property_summary() -> str: ...
schema_property_summary = property(get_schema_property_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_type Property
This property contains the type of the OData schema property.
Syntax
def get_schema_property_type() -> str: ...
schema_property_type = property(get_schema_property_type, None)
Default Value
""
Remarks
This property contains the type of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_property_count property.
This property is read-only.
schema_property_count Property
This property includes the number of properties contained within an OData schema entity.
Syntax
def get_schema_property_count() -> int: ...
schema_property_count = property(get_schema_property_count, None)
Default Value
0
Remarks
This property is updated to reflect the total number of properties within the schema entity specified by schema_entity_index.
This property is read-only.
schema_property_index Property
This property includes the index of the current property in an OData schema entity.
Syntax
def get_schema_property_index() -> int: ... def set_schema_property_index(value: int) -> None: ...
schema_property_index = property(get_schema_property_index, set_schema_property_index)
Default Value
0
Remarks
This property is used to specify a property within an entity (specified by schema_entity_index). Once set, schema_property will be populated.
schema_type_field_attributes Property
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.
Syntax
def get_schema_type_field_attributes() -> str: ...
schema_type_field_attributes = property(get_schema_type_field_attributes, None)
Default Value
""
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_description Property
This property contains the documentation long description of the OData schema property.
Syntax
def get_schema_type_field_description() -> str: ...
schema_type_field_description = property(get_schema_type_field_description, None)
Default Value
""
Remarks
This property contains the documentation long description of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_is_complex_type Property
This property indicates whether a property is derived from a complex type.
Syntax
def get_schema_type_field_is_complex_type() -> bool: ...
schema_type_field_is_complex_type = property(get_schema_type_field_is_complex_type, None)
Default Value
FALSE
Remarks
This property indicates whether a property is derived from a complex type.
When set tp True, schema_type_field can be used to navigate the properties contained within the complex type.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_name Property
This property contains the Name of the OData schema property.
Syntax
def get_schema_type_field_name() -> str: ...
schema_type_field_name = property(get_schema_type_field_name, None)
Default Value
""
Remarks
This property contains the Name of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_nullable Property
This property indicates whether a property can be null.
Syntax
def get_schema_type_field_nullable() -> bool: ...
schema_type_field_nullable = property(get_schema_type_field_nullable, None)
Default Value
FALSE
Remarks
This property indicates whether a property can be null.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_summary Property
This property contains the documentation summary of the OData schema property.
Syntax
def get_schema_type_field_summary() -> str: ...
schema_type_field_summary = property(get_schema_type_field_summary, None)
Default Value
""
Remarks
This property contains the documentation summary of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_type Property
This property contains the type of the OData schema property.
Syntax
def get_schema_type_field_type() -> str: ...
schema_type_field_type = property(get_schema_type_field_type, None)
Default Value
""
Remarks
This property contains the type of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the schema_type_field_count property.
This property is read-only.
schema_type_field_count Property
This property includes the number of properties contained within an OData schema complex type.
Syntax
def get_schema_type_field_count() -> int: ...
schema_type_field_count = property(get_schema_type_field_count, None)
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 schema_property_index or by explicitly setting the type via set_schema_type.
This property is read-only.
schema_type_field_index Property
This property includes the index of the current field (property) in an OData schema complex type.
Syntax
def get_schema_type_field_index() -> int: ... def set_schema_type_field_index(value: int) -> None: ...
schema_type_field_index = property(get_schema_type_field_index, set_schema_type_field_index)
Default Value
0
Remarks
This property is used to specify a field (property) within a complex type. Once set, schema_type_field will be populated.
service_root_uri Property
This property includes the root URI of an OData service.
Syntax
def get_service_root_uri() -> str: ... def set_service_root_uri(value: str) -> None: ...
service_root_uri = property(get_service_root_uri, set_service_root_uri)
Default Value
""
Remarks
This property contains the root URI of an OData service. This value is used in conjunction with resource_path (service_root_uri/resource_path) to query feeds and modify entries.
Example.
The service_root_uri of the OData sample service is "http://services.odata.org/OData/OData.svc/".
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property 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).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property 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 class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password 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. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
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.
ssl_provider Property
This specifies the SSL/TLS implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
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 class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
ssl_server_cert_encoded Property
This is the certificate (PEM/Base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
timeout Property
A timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
Default Value
60
Remarks
If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
transferred_data Property
This property includes the contents of the last response from the server.
Syntax
def get_transferred_data() -> bytes: ...
transferred_data = property(get_transferred_data, None)
Default Value
""
Remarks
This property is used to get the data of the last response from the server.
transferred_data will be populated after a successful query_service or custom_request call, provided that local_file is not set. If local_file is set, the object data will be written to the file specified.
This property is read-only.
user Property
This property includes a user name if authentication is to be used.
Syntax
def get_user() -> str: ... def set_user(value: str) -> None: ...
user = property(get_user, set_user)
Default Value
""
Remarks
This property contains a user name if authentication is to be used. If auth_scheme 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 auth_scheme 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 auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
create_entry Method
This method creates a new entry within the specified OData service resource.
Syntax
def create_entry() -> None: ...
Remarks
The component will use the items contained within entry_properties to create a new entry within the feed service resource by service_root_uri and resource_path (service_root_uri/resource_path).
Upon a successful creation, all previous entries contained by the component, before the create_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to 0 (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, and entry_properties properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.
custom_request Method
This method sends a request to the specified URL using the HTTPMethod and PostData provided.
Syntax
def custom_request(http_method: str, url: str, post_data: str) -> None: ...
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.
other_headers 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 transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the transferred_headers property as well as through the on_header event.
The class will then attempt to parse the search results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index also will be set to 1, thus populating entry_properties.
delete_entry Method
This method deletes an entry within an OData service resource.
Syntax
def delete_entry() -> None: ...
Remarks
The component will delete the entry, of an OData service resource, specified by service_root_uri and resource_path (service_root_uri/resource_path).
An "If-Match" header will be sent in the delete request with the value contained within entry_e_tag.
Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. other_headers also will be cleared and thus will need to be reset accordingly with each call made.
get_entry_property Method
This method gets an OData entry property.
Syntax
def get_entry_property(xpath: str) -> str: ...
Remarks
This method is intended to extend the functionality of the OData class 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 entry_index 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 entry_index.
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 get_entry_property 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")
get_schema Method
This method retrieves the schema for a service.
Syntax
def get_schema() -> None: ...
Remarks
This method will retrieve the schema (metadata document) of the service specified by service_root_uri.
Upon successful retrieval of the schema, set schema_entity_index 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.
has_xpath Method
Determines whether a specific element exists in the document.
Syntax
def has_xpath(xpath: str) -> bool: ...
Remarks
This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it via xpath.
This method returns True if the xpath exists, False if not.
See xpath for details on the XPath syntax.
query_service Method
This method queries an OData service using the specified parameters.
Syntax
def query_service() -> None: ...
Remarks
This method queries an OData feed specified by service_root_uri and resource_path (service_root_uri/resource_path) using the query options specified in the Query*** properties and other_query_options. To fetch an OData feed, without performing any filtering, you can leave Query*** and other_query_options empty and call query_service.
The query results are delivered in the transferred_data property, as well as through the on_transfer event. The response headers can be retrieved through the parsed_headers property as well as through the on_header event.
The class will attempt to parse the query results. Upon successfully parsing the response, channel will be set with their associated feed element values and entry_count will be populated with the total number of entries contained within the feed. entry_index will also be set to 1, thus populating entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path.
reset Method
This method resets all of properties of the class.
Syntax
def reset() -> None: ...
Remarks
The reset method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.
set_entry_property Method
This method is used to set an OData entry property.
Syntax
def set_entry_property(xpath: str, value: str) -> None: ...
Remarks
This method is intended to extend functionality of the OData class 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 entry_properties.
XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When entry_index 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 class will use the specified entry_index 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")
set_schema_entity Method
This method sets the schema entity.
Syntax
def set_schema_entity(name: str) -> None: ...
Remarks
The class will set the schema entity to the Name specified. Once set, you can view the keys (via schema_keys), properties (via schema_property), and navigation properties (via schema_association) contained within the specified entity.
set_schema_property Method
This method sets the schema property.
Syntax
def set_schema_property(name: str) -> None: ...
Remarks
The class will set the schema property to the Name specified. Once set, you can view the details of the property (via schema_property) along with the complex type details (via schema_type_field); provided that the property is derived from the complex type.
set_schema_type Method
This method sets the schema type.
Syntax
def set_schema_type(name: str) -> None: ...
Remarks
The class will set the schema type to the Name specified. Once set, you can view the details of the complex type (via schema_type_field).
update_entry Method
This method updates an OData entry.
Syntax
def update_entry() -> None: ...
Remarks
The class will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). It also will update the OData entry with the elements specified by entry_properties.
Upon a successful update, all previous entries contained by the component, before the update_entry call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path properties. other_headers will also be cleared and thus will need to be reset accordingly with each call made.
update_property Method
This method updates an OData entry property.
Syntax
def update_property(xpath: str, value: str) -> None: ...
Remarks
The class will update the OData entry specified by service_root_uri and resource_path (service_root_uri/resource_path). 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 update_property call, will be cleared and replaced with the response entry data. entry_index will then be set to zero (the first entry within the response), populating the entry_author, entry_e_tag, entry_title, entry_summary, entry_updated, entry_links, entry_properties, and resource_path. other_headers will also be cleared and thus will need to be reset accordingly with each call made.
on_connected Event
This event is fired immediately after a connection completes (or fails).
Syntax
class ODataConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class OData: @property def on_connected() -> Callable[[ODataConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[ODataConnectedEventParams], None]) -> None: ...
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.
on_disconnected Event
This event is fired when a connection is closed.
Syntax
class ODataDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class OData: @property def on_disconnected() -> Callable[[ODataDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[ODataDisconnectedEventParams], None]) -> None: ...
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.
on_end_transfer Event
This event fires when a document finishes transferring.
Syntax
class ODataEndTransferEventParams(object): @property def direction() -> int: ... # In class OData: @property def on_end_transfer() -> Callable[[ODataEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[ODataEndTransferEventParams], None]) -> None: ...
Remarks
The on_end_transfer 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.
on_entity Event
This event is fired once for each entity retrieved.
Syntax
class ODataEntityEventParams(object): @property def name() -> str: ... # In class OData: @property def on_entity() -> Callable[[ODataEntityEventParams], None]: ... @on_entity.setter def on_entity(event_hook: Callable[[ODataEntityEventParams], None]) -> None: ...
Remarks
The on_entity event is fired once for each entity found when retrieving a service's schema (metadata document) through get_schema.
on_entry Event
This event is fired once for each entry retrieved.
Syntax
class ODataEntryEventParams(object): @property def id() -> str: ... @property def title() -> str: ... @property def summary() -> str: ... @property def e_tag() -> str: ... # In class OData: @property def on_entry() -> Callable[[ODataEntryEventParams], None]: ... @on_entry.setter def on_entry(event_hook: Callable[[ODataEntryEventParams], None]) -> None: ...
Remarks
The on_entry event is fired once for each entry found in the response.
The entry properties are provided through entry_properties.
The entry links are provided through entry_links.
on_error Event
Fired when information is available about errors during data delivery.
Syntax
class ODataErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OData: @property def on_error() -> Callable[[ODataErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[ODataErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
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.
on_header Event
This event is fired every time a header line comes in.
Syntax
class ODataHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class OData: @property def on_header() -> Callable[[ODataHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[ODataHeaderEventParams], None]) -> None: ...
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).
on_log Event
This event fires once for each log message.
Syntax
class ODataLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class OData: @property def on_log() -> Callable[[ODataLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[ODataLogEventParams], None]) -> None: ...
Remarks
This event fires once for each log message generated by the class. 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"
on_property Event
This event is fired once for each property found within an entity.
Syntax
class ODataPropertyEventParams(object): @property def name() -> str: ... @property def type_name() -> str: ... @property def nullable() -> bool: ... # In class OData: @property def on_property() -> Callable[[ODataPropertyEventParams], None]: ... @on_property.setter def on_property(event_hook: Callable[[ODataPropertyEventParams], None]) -> None: ...
Remarks
The on_property event is fired once for each property found within an entity after setting schema_entity_index.
on_set_cookie Event
This event is fired for every cookie set by the server.
Syntax
class ODataSetCookieEventParams(object): @property def name() -> str: ... @property def value() -> str: ... @property def expires() -> str: ... @property def domain() -> str: ... @property def path() -> str: ... @property def secure() -> bool: ... # In class OData: @property def on_set_cookie() -> Callable[[ODataSetCookieEventParams], None]: ... @on_set_cookie.setter def on_set_cookie(event_hook: Callable[[ODataSetCookieEventParams], None]) -> None: ...
Remarks
The on_set_cookie 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 (url_server) 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 (url_path) 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.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class ODataSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class OData: @property def on_ssl_server_authentication() -> Callable[[ODataSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[ODataSSLServerAuthenticationEventParams], None]) -> None: ...
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.
on_ssl_status Event
Fired when secure connection progress messages are available.
Syntax
class ODataSSLStatusEventParams(object): @property def message() -> str: ... # In class OData: @property def on_ssl_status() -> Callable[[ODataSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[ODataSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
on_start_transfer Event
This event fires when a document starts transferring (after the headers).
Syntax
class ODataStartTransferEventParams(object): @property def direction() -> int: ... # In class OData: @property def on_start_transfer() -> Callable[[ODataStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[ODataStartTransferEventParams], None]) -> None: ...
Remarks
The on_start_transfer 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.
on_status Event
This event is fired when the HTTP status line is received from the server.
Syntax
class ODataStatusEventParams(object): @property def http_version() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class OData: @property def on_status() -> Callable[[ODataStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[ODataStatusEventParams], None]) -> None: ...
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").
on_transfer Event
This event is fired while a document transfers (delivers document).
Syntax
class ODataTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class OData: @property def on_transfer() -> Callable[[ODataTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[ODataTransferEventParams], None]) -> None: ...
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.
OData Config Settings
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config 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 class 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 class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The auth_scheme 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 class fails with an error.
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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error 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 class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
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).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.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. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs 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 classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs 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 class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.
local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in 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 on_data_in 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 config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class 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:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but 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 only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include:
- 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_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- 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 value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions which are designed to run on Windows ssl_provider 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 only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This setting is only applicable when ssl_provider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when ssl_provider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection 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 not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
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 setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider 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 setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "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 UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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 classes: 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 class 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.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
OData Errors
OData Errors
601 The feed URL is required. |
The class may also return one of the following error codes, which are inherited from other classes.
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 url_scheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the remote_port at this time. A connection is in progress. | |
101 You cannot change the remote_host (Server) at this time. A connection is in progress. | |
102 The remote_host 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 local_port at this time. A connection is in progress. | |
107 You cannot change the local_host at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 remote_port cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |