Docs

IPWorks 2022 Python Edition

Version 22.0 [Build 8171]

OData Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class ipworks.OData

Remarks

The OData Class supports both plaintext and 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).

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.

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.

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.

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.

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.

authorizationThe Authorization string to be sent to the server.
auth_schemeThe authentication scheme to use when server authorization is required.
channel_author_emailThis property contains the email address of the author.
channel_author_nameThis property contains the name of the author.
channel_author_uriThis property contains the uniform resource identifier (URI) of the author.
channel_category_labelThis property contains a textual description of the label for the category.
channel_category_schemeThis property identifies a categorization scheme.
channel_category_termThis property contains the category to which the entry or feed belongs.
channel_contributor_emailThis property contains the email address of the contributor.
channel_contributor_nameThis property contains the name of the contributor.
channel_contributor_uriThis property contains the uniform resource identifier (URI) of the contributor.
channel_generatorThis property identifies the generator of the feed.
channel_iconThis property contains a reference to the image that represents this feed.
channel_idThe Id conveys a permanent, universally unique identifier for an entry or feed.
channel_link_hrefThis property contains the location of the link.
channel_link_href_langThis property contains the language of the content at the link.
channel_link_lengthThis property contains the length (in bytes) of the content at the link.
channel_link_relThis property indicates the relation of the linked content to the feed.
channel_link_titleThis property contains the title of the link.
channel_link_typeThis property contains the multipurpose internet mail extension (MIME) type of the content at the link.
channel_logoThis property contains the logo for an image that represents the feed.
channel_rightsThis property contains information about the rights of the given feed.
channel_rights_text_typeThis property contains the text type of the rights of the feed.
channel_subtitleThis property contains a short description of the Atom feed.
channel_subtitle_text_typeThis property contains the text type of the subtitle of the feed.
channel_titleThis property contains the title of the current Atom feed.
channel_title_text_typeThis property contains the text type of the title of the feed.
channel_updatedThis property contains the date and time that the feed was updated.
cookie_countThe number of records in the Cookie arrays.
cookie_domainThe domain of a received cookie.
cookie_expirationThis property contains an expiration time for the cookie (if provided by the server).
cookie_nameThe name of the cookie.
cookie_pathThis property contains a path name to limit the cookie to (if provided by the server).
cookie_secureThis property contains the security flag of the received cookie.
cookie_valueThis property contains the value of the cookie.
entry_authorThe Author of the current entry in an OData feed.
entry_countThe number of entries contained within an OData feed.
entry_e_tagThe ETag of the current entry in an OData feed.
entry_idThe ID of the current entry in an OData feed.
entry_indexThe index of the current entry in an OData feed.
entry_links_countThe number of records in the EntryLinks arrays.
entry_links_resource_pathThe Resource Path of the OData entry element link.
entry_links_titleThe Title of the OData entry element link.
entry_properties_countThe number of records in the EntryProperties arrays.
entry_properties_attributesA space-separated list of attributes (name-value pairs) contained within an OData entry element.
entry_properties_is_nullIndicates whether a property value of a primitive type is null.
entry_properties_nameThe Name of the OData entry element.
entry_properties_typeThe type of the OData schema property.
entry_properties_valueThe Value of the OData entry element.
entry_properties_x_pathThe XPath of the OData entry property.
entry_summaryThe Summary of the current entry in an OData feed.
entry_titleThe Title of the current entry in an OData feed.
entry_typeThe entry category or type.
entry_updatedThe Date-Time when current entry in an OData feed was updated.
entry_xmlThe raw XML of the current entry in an OData feed.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
idleThe current status of the class.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
o_data_versionThe OData Version.
other_headersOther headers as determined by the user (optional).
other_query_optionsAdditional Query Options to be used when querying a service.
parsed_header_countThe number of records in the ParsedHeader arrays.
parsed_header_fieldThis property contains the name of the HTTP header (same case as it is delivered).
parsed_header_valueThis property contains the header contents.
passwordA password if authentication is to be used.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the TCP port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use SSL for the connection to the proxy.
proxy_userThis property contains a user name, if authentication is to be used for the proxy.
query_filterSelects only the entries that satisfy the specified filter (expression).
query_order_byThe value used to order entries when querying a service.
query_selectSelects only the specified properties to be returned in an entry when querying a service.
query_skipThe number of entries to skip when querying a service.
query_skip_tokenToken given by an OData server when the last query result collection is too large.
query_topSelects the first N entries when querying a service.
resource_pathThe Resource Path of an OData service.
schema_association_contains_targetWhether the navigation property contains a target.
schema_association_descriptionThe documentation long description of the OData schema association.
schema_association_from_roleThe name of the starting point of the navigation.
schema_association_from_role_descriptionThe documentation long description of the OData schema FromRole association end point.
schema_association_from_role_entityThe name of the entity that FromRole association end point maps to.
schema_association_from_role_multiplicityThe multiplicity of the FromRole association end point.
schema_association_from_role_summaryThe documentation summary of the OData schema FromRole association end point.
schema_association_nameThe Name of the OData schema navigation property.
schema_association_nullableWhether the property defined by the schema can be a null value.
schema_association_on_deleteThe delete action to be performed.
schema_association_partnerThe partner value identifying a navigation property (if any).
schema_association_ref_constraint_countThe number of referential constraints.
schema_association_ref_constraint_indexThe current index of the referential constraint.
schema_association_ref_constraint_propertyThe property that takes part in the referential constraint.
schema_association_ref_constraint_referenced_propertyThe corresponding property of the principal entity type.
schema_association_relationshipThe name of the relationship (association) of the navigation property.
schema_association_summaryThe documentation summary of the OData schema association.
schema_association_to_roleThe name of the end point of the navigation.
schema_association_to_role_descriptionThe documentation long description of the OData schema ToRole association end point.
schema_association_to_role_entityThe name of the entity that ToRole association end point maps to.
schema_association_to_role_multiplicityThe multiplicity of the ToRole association end point.
schema_association_to_role_summaryThe documentation summary of the OData schema ToRole association end point.
schema_association_typeThe entity type.
schema_association_countThe number of navigation properties contained within an OData schema entity.
schema_association_indexThe index of the current navigation property in an OData schema entity.
schema_entity_descriptionThe documentation long description of the OData schema entity.
schema_entity_nameThe name of the OData schema entity.
schema_entity_summaryThe documentation summary of the OData schema entity.
schema_entity_countThe number of entities contained within an OData schema.
schema_entity_indexThe index of the current entity in an OData schema.
schema_keys_countThe number of records in the SchemaKeys array.
schema_keysThe keys of a schema entity.
schema_property_attributesA space-separated list of attributes (name-value pairs) contained within an OData property element.
schema_property_descriptionThe documentation long description of the OData schema property.
schema_property_is_complex_typeIndicates whether a property is derived from a complex type.
schema_property_nameThe Name of the OData schema property.
schema_property_nullableIndicates whether a property can be null.
schema_property_summaryThe documentation summary of the OData schema property.
schema_property_typeThe type of the OData schema property.
schema_property_countThe number of properties contained within an OData schema entity.
schema_property_indexThe index of the current property in an OData schema entity.
schema_type_field_attributesA space-separated list of attributes (name-value pairs) contained within an OData property element.
schema_type_field_descriptionThe documentation long description of the OData schema property.
schema_type_field_is_complex_typeIndicates whether a property is derived from a complex type.
schema_type_field_nameThe Name of the OData schema property.
schema_type_field_nullableIndicates whether a property can be null.
schema_type_field_summaryThe documentation summary of the OData schema property.
schema_type_field_typeThe type of the OData schema property.
schema_type_field_countThe number of properties contained within an OData schema complex type.
schema_type_field_indexThe index of the current field (property) in an OData schema complex type.
service_root_uriThe root URI of an OData service.
ssl_accept_server_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerTBD.
ssl_server_cert_encodedThis is the certificate (PEM/base64 encoded).
timeoutA timeout for the class.
transferred_dataThe contents of the last response from the server.
userA user name if authentication is to be used.

Method List


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

configSets or retrieves a configuration setting.
create_entryCreates a new entry within the specified OData service resource.
custom_requestSends a request to the specified URL using the HTTP Method and Post Data provided.
delete_entryDeletes an entry within an OData service resource.
get_entry_propertyGet an OData entry property.
get_schemaRetrieves the schema for a service.
has_x_pathDetermines whether a specific element exists in the document.
query_serviceQueries an OData service using the specified parameters.
resetReset all properties of the class.
set_entry_propertySet an OData entry property.
set_schema_entitySets the schema entity.
set_schema_propertySets the schema property.
set_schema_typeSets the schema type.
update_entryUpdate an OData entry.
update_propertyUpdate 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_connectedFired immediately after a connection completes (or fails).
on_disconnectedFired when a connection is closed.
on_end_transferThis event fires when a document finishes transferring.
on_entityFired once for each entity retrieved.
on_entryFired once for each entry retrieved.
on_errorInformation about errors during data delivery.
on_headerFired every time a header line comes in.
on_logFires once for each log message.
on_propertyFired once for each property found within an entity.
on_set_cookieFired for every cookie set by the server.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_start_transferThis event fires when a document starts transferring (after the headers).
on_statusFired when the HTTP status line is received from the server.
on_transferFired while a document transfers (delivers document).

Configuration Settings


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

EncodeResourcePathWhether the ResourcePath is URL encoded.
NameAndEmailFormatDetermines how the data of the name and e-mail properties will be formatted.
TransferredHeadersThe full set of headers as received from the server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13ProviderThe TLS 1.3 implementation to be used.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

authorization Property

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 non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

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

This property is provided so that the HTTP 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 authorization 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 basic authentication. If AuthScheme is set to authDigest (1), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

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

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

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

For security purposes, changing the value of this property will cause the 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

The domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

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

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

The name of the cookie.

This property, along with cookie_value store the cookie that is to be sent to the server. The on_set_cookie event displays the cookies set 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 through a secure (HTTPS) connection only.

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. The cookie specified by cookie_name has a corresponding value associated with it. 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

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

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

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 entry_index is set.

This property is also used when retrieving, updating or deleting an entry. When EntryETag contains a non-empty string, an "If-None-Match" header will be sent with the entered value when 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

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

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 will also 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

The Resource Path of the OData entry element link.

Syntax

def get_entry_links_resource_path(entry_links_index: int) -> str: ...

Default Value

""

Remarks

The Resource Path of the OData entry element link.

By setting this value to resource_path and calling on_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

The Title of the OData entry element link.

Syntax

def get_entry_links_title(entry_links_index: int) -> str: ...

Default Value

""

Remarks

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:

The array indices start at 0 and end at entry_properties_count - 1.

entry_properties_attributes Property

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

A space-separated list of attributes (name-value pairs) contained within an OData entry element. For example: 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

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

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

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

The Name of the OData entry element.

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

Setting this property to empty string prior to calling on_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

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

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

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

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_x_path Property

The XPath of the OData entry property.

Syntax

def get_entry_properties_x_path(entry_properties_index: int) -> str: ...

Default Value

""

Remarks

The XPath of the OData entry property. This value can be used to set x_path or can be used within on_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

The 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 the 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

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

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

The Date-Time when 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 the specified entry within an OData feed was updated. This value will be populated once entry_index is set (provided that a Title can be found).

This property is not applicable to OData V4 feeds.

This property is read-only.

entry_xml Property

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 the 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 the following:

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 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 TCP port for the firewall firewall_host. See the description of the firewall_host property for details.

Note that 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

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:

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

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

other_headers Property

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

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

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

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

other_query_options Property

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

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 config 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 only used 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 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 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 and 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 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 SSL for the connection to the proxy. The applicable values are the following:

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

proxy_user Property

This property contains a user name, 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 user name, 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.

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

Below are the operators supported in the expression language.

Logical Operators

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

Arithmetic Operators

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

Grouping Operators

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

Below are the functions supported in the expression language.

String Functions

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

Date Functions

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

Math Functions

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

Type Functions

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

query_order_by Property

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

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 only have 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

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

By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. However you can use query_order_by to specify how the entries should be sorted prior to 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 only return the third and fourth items).

query_skip_token Property

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

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

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

resource_path Property

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

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

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

This property is only applicable 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

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

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

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

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

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

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

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

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

The name of the entity that FromRole association end point 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

The name of the entity that schema_association_from_role association end point 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

The multiplicity of the FromRole association end point.

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

The multiplicity of the schema_association_from_role association end point. 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:

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

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

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

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

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

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

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

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

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

This property is only applicable 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

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

The delete action to be performed.

Possible values are:

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 will be deleted.
2 (daSetNull) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to null. This value is only applicable to OData Version 4.
3 (daSetDefault) All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to their default value. This value is only applicable to OData Version 4.

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

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

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

This property is only applicable 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

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

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. For instance: For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1 odata.SchemaAssociation.RefConstraintIndex = i; Console.Write(odata.SchemaAssociation.RefConstraintProperty); Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty); Next i

This property is only applicable 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

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

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

This property is only applicable 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

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

The property that takes part in the referential constraint.

This property is only applicable 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

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

The corresponding property of the principal entity type.

This property is only applicable 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

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

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

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

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

The name of the end point 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

The name of the end 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_to_role_description Property

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

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

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

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

The name of the entity that ToRole association end point 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

The name of the entity that schema_association_to_role association end point 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

The multiplicity of the ToRole association end point.

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

The multiplicity of the schema_association_to_role association end point. 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:

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

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

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

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

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

The entity type.

Syntax

def get_schema_association_type() -> str: ...


schema_association_type = property(get_schema_association_type, None)

Default Value

""

Remarks

The entity type.

This property is only applicable 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

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

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

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

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

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

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

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

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

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

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

The keys of a schema entity.

Syntax

def get_schema_keys(schema_keys_index: int) -> str: ...

Default Value

"0"

Remarks

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

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

This property is read-only.

schema_property_attributes Property

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

A space-separated list of attributes (name-value pairs) contained within an OData property element. For example: 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

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

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

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

Indicates whether a property is derived from a complex type.

When '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

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

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

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

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

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

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

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

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

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

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

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

A space-separated list of attributes (name-value pairs) contained within an OData property element. For example: 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

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

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

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

Indicates whether a property is derived from a complex type.

When '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

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

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

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

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

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

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

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

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

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

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

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.

For 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 are designations of the most common User and Machine certificate stores in Windows:

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

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

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstSecurityKey, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 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 certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

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 properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

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

ssl_provider Property

TBD.

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

TBD.

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

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

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

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

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, prior to the on_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

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

Syntax

def custom_request(http_method: str, url: str, post_data: str) -> None: ...

Remarks

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

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 via 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 will also be set to 1, thus populating entry_properties.

delete_entry 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, prior to the DeleteEntry call, will be cleared. other_headers will also be cleared and thus will need to be reset accordingly with each call made.

get_entry_property Method

Get an OData entry property.

Syntax

def get_entry_property(x_path: str) -> str: ...

Remarks

This method is intended for extending 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 can also be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by 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 properties element, and attribute can be any attribute of that field. If an attribute is not supplied, the on_get_entry_property method will return the text portion of property. For example:

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

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

get_schema 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, you can set schema_entity_index to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

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

has_x_path Method

Determines whether a specific element exists in the document.

Syntax

def has_x_path(x_path: 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 x_path.

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

See x_path for details on the XPath syntax.

query_service Method

Queries an OData service using the specified parameters.

Syntax

def query_service() -> None: ...

Remarks

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 on_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 via the parsed_headers property as well as through the on_header event.

The class will then 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

Reset all properties of the class.

Syntax

def reset() -> None: ...

Remarks

The on_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

Set an OData entry property.

Syntax

def set_entry_property(x_path: str, value: str) -> None: ...

Remarks

This method is intended for extending 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 properties element. For example:

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

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

set_schema_entity 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

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

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

Update 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 will update the OData entry with the elements specified by entry_properties.

Upon a successful update, all previous entries contained by the component, prior to the on_update_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, 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

Update an OData entry property.

Syntax

def update_property(x_path: 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, prior to the on_update_property 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, 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

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

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

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) via get_schema.

on_entry Event

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

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

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

on_header Event

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 (same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log 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:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

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

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

on_property Event

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

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 through a secure (HTTPS) connection only.

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

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

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. Used to track 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

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

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 is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

OData Configuration

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 Configuration Settings

EncodeResourcePath:   Whether the ResourcePath is URL encoded.

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

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

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

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

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

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

HTTP Configuration Settings

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

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

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable when http_version is set to "2.0".

If set to True (default) the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This setting determines whether data is appended when writing to local_file. When set to True downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is only applicable when local_file is set. The default value is False.

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

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP 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]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

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

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

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

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to true, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-encoding" header is also added to the outgoing request.

The default value is False.

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

If set to True the URL passed to the class will be URL encoded. The default value is False.

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

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same, otherwise the class fails with an error.

Note that following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

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

Valid options are:

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

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

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

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically these headers are inserted into the table via incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

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

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

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

HTTP/2 Notes

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

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

HTTP/2 is supported on Windows 8.1/Server 2012 R2 or later. If HTTP/2 is used on a version of Windows prior to these versions the class fails with an error.

Note: HTTP/2 is currently only supported on Windows.

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

If this setting contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting other_headers to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This setting controls the level of detail that is logged through the on_log event. Possible values are:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data is logged.
3 (Debug) Debug data is logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

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

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

NegotiatedHTTPVersion:   The negotiated HTTP version.

This setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" if the server does not support "2.0" the class will fallback to using "1.1" automatically. This setting will indicate which was used.

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

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

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

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

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

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

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

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

This setting is provided for use by classs that do not directly expose Proxy properties.

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

This setting is provided for use by classs that do not directly expose Proxy properties.

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

This setting is provided for use by classs that do not directly expose Proxy properties.

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

This setting is provided for use by classs that do not directly expose Proxy properties.

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

This setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This setting contains the contents of the last response from the server.

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

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise this reflects the maximum number of incoming bytes that can be stored by the class.

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

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

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this config to ON before making a request to enable it. Examples are below.

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to true, the class will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the class will not use HTTP chunked encoding. The default value is false.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True if a hostname contains non-ASCII characters it is encoded using Punycode to an IDN.

The default value is False and the hostname will always be used exactly as specified. 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.

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

If True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

Note: This setting is only applicable to Mac/iOS editions.

UserAgent:   Information about the user agent (browser).

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

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

IPPort Configuration Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

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

This setting is provided for use by classs that do not directly expose Firewall properties.

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

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

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

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

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

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

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

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

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

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

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

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the 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).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by 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.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the 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.

MaxTransferRate:   The transfer rate limit in bytes per second.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

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

This setting optionally specifies a semicolon separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Configuration Settings

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

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

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

Enabling this setting has no effect if UseInternalSecurityAPI is False.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

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.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

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.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

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

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

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

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to True the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to False (default) the CRL check will not be performed by the class.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the 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.

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

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the 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 UseInternalSecurityAPI is False (default): obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when UseInternalSecurityAPI is False (default) 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
Example values when UseInternalSecurityAPI is True: 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 UseInternalSecurityAPI is True include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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

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

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

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

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

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

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.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the 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 UseInternalSecurityAPI is set to True.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

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

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

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

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

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

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

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

SSLNegotiatedProtocol:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLProvider:   The name of the security provider to use.

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

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

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

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

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

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

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

When specified the 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: IPPort.Config("UseInternalSecurityAPI=true"); IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2 IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

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

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13Provider:   The TLS 1.3 implementation to be used.

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

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

The platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Configuration Settings

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

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

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the 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 Configuration Settings

BuildInfo:   Information about the product's build.

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

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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

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

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.

IPPort 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   Cannot change 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).

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