OData Class
Properties Methods Events Config Settings Errors
The OData class implements the Open Data Protocol (OData). It can be used to query, parse, and update or modify data contained within an OData service.
Class Name
IPWorks_OData
Procedural Interface
ipworks_odata_open(); ipworks_odata_close($res); ipworks_odata_register_callback($res, $id, $function); ipworks_odata_get_last_error($res); ipworks_odata_get_last_error_code($res); ipworks_odata_set($res, $id, $index, $value); ipworks_odata_get($res, $id, $index); ipworks_odata_do_config($res, $configurationstring); ipworks_odata_do_createentry($res); ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata); ipworks_odata_do_deleteentry($res); ipworks_odata_do_getentryproperty($res, $xpath); ipworks_odata_do_getschema($res); ipworks_odata_do_hasxpath($res, $xpath); ipworks_odata_do_queryservice($res); ipworks_odata_do_reset($res); ipworks_odata_do_setentryproperty($res, $xpath, $value); ipworks_odata_do_setschemaentity($res, $name); ipworks_odata_do_setschemaproperty($res, $name); ipworks_odata_do_setschematype($res, $name); ipworks_odata_do_updateentry($res); ipworks_odata_do_updateproperty($res, $xpath, $value);
Remarks
The OData Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.
The OData component allows you to easily query OData services and create, update, and delete entries within a service. To query a service, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to query. Optionally you can set the Query*** properties to filter the results. QueryService can then be called to retrieve the results (which can be viewed via the Entry*** properties).
Example 1. Query a Service:
OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
OData1.ResourcePath = "Products"
OData1.QueryService()
To create a new entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the collection within the service that you wish to add the entry to. The Entry*** properties can be set to the values you wish to use to create the entry. CreateEntry can then be called to create the entry.
Example 2. Create a New Entry:
OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
OData1.ResourcePath = "Products"
OData1.EntryProperties
OData1.CreateEntry()
If you wish to update an entry, you can set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to update. The Entry*** properties can be set to the values you wish to update. UpdateEntry can then be called to update the entry.
Example 3. Update an Entry:
OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
OData1.ResourcePath = "Products(1)"
// Index 1 is the "Name" property.
OData1.EntryProperties[1].Value = "MyNewName"
OData1.UpdateEntry()
Deleting an entry requires that you first set the ServiceRootURI to the service's root URI and ResourcePath to the specific entry you wish to delete. DeleteEntry can then be called to delete the entry.
Example 4. Delete an Entry:
OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
OData1.ResourcePath = "Products(1)"
OData1.DeleteEntry()
In addition to querying a service and manipulating its containing data, the OData component also allows you to retrieve the schema (metadata document) to determine the structure of a service. After setting ServiceRootURI to the root URI of the service, GetSchema can be called to retrieve the metadata document. The Schema*** properties will be populated upon successful retrieval of the metadata document allowing you to identify the structure of the service.
Example 5. Retrieve the Scheme:
OData1.ServiceRootURI = "http://services.odata.org/OData/OData.svc"
OData1.GetSchema()
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
Authorization | This property includes the Authorization string to be sent to the server. |
AuthScheme | This property specifies the authentication scheme to use when server authentication is required. |
ChannelAuthorEmail | This property contains the email address of the author. |
ChannelAuthorName | This property contains the name of the author. |
ChannelAuthorUri | This property contains the uniform resource identifier (URI) of the author. |
ChannelCategoryLabel | This property contains a textual description of the label for the category. |
ChannelCategoryScheme | This property identifies a categorization scheme. |
ChannelCategoryTerm | This property contains the category to which the entry or feed belongs. |
ChannelContributorEmail | This property contains the email address of the contributor. |
ChannelContributorName | This property contains the name of the contributor. |
ChannelContributorUri | This property contains the uniform resource identifier (URI) of the contributor. |
ChannelGenerator | This property identifies the generator of the feed. |
ChannelIcon | This property contains a reference to the image that represents this feed. |
ChannelId | The Id conveys a permanent, universally unique identifier for an entry or feed. |
ChannelLinkHref | This property contains the location of the link. |
ChannelLinkHrefLang | This property contains the language of the content at the link. |
ChannelLinkLength | This property contains the length (in bytes) of the content at the link. |
ChannelLinkRel | This property indicates the relation of the linked content to the feed. |
ChannelLinkTitle | This property contains the title of the link. |
ChannelLinkType | This property contains the multipurpose internet mail extension (MIME) type of the content at the link. |
ChannelLogo | This property contains the logo for an image that represents the feed. |
ChannelRights | This property contains information about the rights of the given feed. |
ChannelRightsTextType | This property contains the text type of the rights of the feed. |
ChannelSubtitle | This property contains a short description of the Atom feed. |
ChannelSubtitleTextType | This property contains the text type of the subtitle of the feed. |
ChannelTitle | This property contains the title of the current Atom feed. |
ChannelTitleTextType | This property contains the text type of the title of the feed. |
ChannelUpdated | This property contains the date and time that the feed was updated. |
CookieCount | The number of records in the Cookie arrays. |
CookieDomain | This is the domain of a received cookie. |
CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
CookieName | This property, contains the name of the cookie. |
CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
CookieSecure | This property contains the security flag of the received cookie. |
CookieValue | This property contains the value of the cookie. |
EntryAuthor | This property includes the author of the current entry in an OData feed. |
EntryCount | This property includes the number of entries contained within an OData feed. |
EntryETag | This property includes the ETag of the current entry in an OData feed. |
EntryId | This property includes the Id of the current entry in an OData feed. |
EntryIndex | This property includes the index of the current entry in an OData feed. |
EntryLinksCount | The number of records in the EntryLinks arrays. |
EntryLinksResourcePath | This property contains the resource path of the OData entry element link. |
EntryLinksTitle | This property contains the title of the OData entry element link. |
EntryPropertiesCount | The number of records in the EntryProperties arrays. |
EntryPropertiesAttributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. |
EntryPropertiesIsNull | This property indicates whether a property value of a primitive type is null. |
EntryPropertiesName | This property contains the name of the OData entry element. |
EntryPropertiesType | This property contains the type of the OData schema property. |
EntryPropertiesValue | This property contains the value of the OData entry element. |
EntryPropertiesXPath | This property contains the XPath of the OData entry property. |
EntrySummary | This property includes a summary of the current entry in an OData feed. |
EntryTitle | This property includes the title of the current entry in an OData feed. |
EntryType | This property includes the entry category or type. |
EntryUpdated | This property includes the date-time when a current entry in an OData feed was updated. |
EntryXML | This property includes the raw XML of the current entry in an OData feed. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of the firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the Transmission Control Protocol (TCP) port for the firewall Host . |
FirewallUser | This property contains a username if authentication is to be used when connecting through a firewall. |
Idle | This property specifies the current status of the class. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
ODataVersion | This property includes the OData version. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
OtherQueryOptions | This property includes additional query options to be used when querying a service. |
ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
ParsedHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
Password | This property includes a password if authentication is to be used. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username if authentication is to be used for the proxy. |
QueryFilter | This property selects only the entries that satisfy the specified filter (expression). |
QueryOrderBy | This property includes the value used to order entries when querying a service. |
QuerySelect | This property selects only the specified properties to be returned in an entry when querying a service. |
QuerySkip | This property includes the number of entries to skip when querying a service. |
QuerySkipToken | This property includes the token given by an OData server when the last query result collection is too large. |
QueryTop | This property selects the first N entries when querying a service. |
ResourcePath | This property includes the resource path of an OData service. |
SchemaAssociationContainsTarget | This property indicates whether the navigation property contains a target. |
SchemaAssociationDescription | This property contains the documentation long description of the OData schema association. |
SchemaAssociationFromRole | This property contains the name of the starting point of the navigation. |
SchemaAssociationFromRoleDescription | This property contains the documentation long description of the OData schema FromRole association endpoint. |
SchemaAssociationFromRoleEntity | This property contains the name of the entity that the FromRole association endpoint maps to. |
SchemaAssociationFromRoleMultiplicity | This property contains the multiplicity of the FromRole association endpoint. |
SchemaAssociationFromRoleSummary | This property contains the documentation summary of the OData schema FromRole association endpoint. |
SchemaAssociationName | This property contains the name of the OData schema navigation property. |
SchemaAssociationNullable | This property indicates whether the property defined by the schema can be a null value. |
SchemaAssociationOnDelete | This property contains the delete action to be performed. |
SchemaAssociationPartner | This property contains the partner value identifying a navigation property (if any). |
SchemaAssociationRefConstraintCount | This property contains the number of referential constraints. |
SchemaAssociationRefConstraintIndex | This property contains the current index of the referential constraint. |
SchemaAssociationRefConstraintProperty | This property contains the property that takes part in the referential constraint. |
SchemaAssociationRefConstraintReferencedProperty | This property contains the corresponding property of the principal entity type. |
SchemaAssociationRelationship | This property contains the name of the relationship (association) of the navigation property. |
SchemaAssociationSummary | This property contains the documentation summary of the OData schema association. |
SchemaAssociationToRole | This property contains the name of the endpoint of the navigation. |
SchemaAssociationToRoleDescription | This property contains the documentation long description of the OData schema ToRole association endpoint. |
SchemaAssociationToRoleEntity | This property contains the name of the entity that the ToRole association endpoint maps to. |
SchemaAssociationToRoleMultiplicity | This property contains the multiplicity of the ToRole association endpoint. |
SchemaAssociationToRoleSummary | This property contains the documentation summary of the OData schema ToRole association endpoint. |
SchemaAssociationType | This property contains the entity type. |
SchemaAssociationCount | This property includes the number of navigation properties contained within an OData schema entity. |
SchemaAssociationIndex | This property includes the index of the current navigation property in an OData schema entity. |
SchemaEntityDescription | This property contains the documentation long description of the OData schema entity. |
SchemaEntityName | This property contains the name of the OData schema entity. |
SchemaEntitySummary | This property contains the documentation summary of the OData schema entity. |
SchemaEntityCount | This property includes the number of entities contained within an OData schema. |
SchemaEntityIndex | This property includes the index of the current entity in an OData schema. |
SchemaKeysCount | The number of records in the SchemaKeys array. |
SchemaKeys | This property includes the keys for a schema entity. |
SchemaPropertyAttributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
SchemaPropertyDescription | This property contains the documentation long description of the OData schema property. |
SchemaPropertyIsComplexType | This property indicates whether a property is derived from a complex type. |
SchemaPropertyName | This property contains the Name of the OData schema property. |
SchemaPropertyNullable | This property indicates whether a property can be null. |
SchemaPropertySummary | This property contains the documentation summary of the OData schema property. |
SchemaPropertyType | This property contains the type of the OData schema property. |
SchemaPropertyCount | This property includes the number of properties contained within an OData schema entity. |
SchemaPropertyIndex | This property includes the index of the current property in an OData schema entity. |
SchemaTypeFieldAttributes | This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. |
SchemaTypeFieldDescription | This property contains the documentation long description of the OData schema property. |
SchemaTypeFieldIsComplexType | This property indicates whether a property is derived from a complex type. |
SchemaTypeFieldName | This property contains the Name of the OData schema property. |
SchemaTypeFieldNullable | This property indicates whether a property can be null. |
SchemaTypeFieldSummary | This property contains the documentation summary of the OData schema property. |
SchemaTypeFieldType | This property contains the type of the OData schema property. |
SchemaTypeFieldCount | This property includes the number of properties contained within an OData schema complex type. |
SchemaTypeFieldIndex | This property includes the index of the current field (property) in an OData schema complex type. |
ServiceRootURI | This property includes the root URI of an OData service. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
Timeout | This property includes the timeout for the class. |
TransferredData | This property includes the contents of the last response from the server. |
User | This property includes a user name if authentication is to be used. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
CreateEntry | This method creates a new entry within the specified OData service resource. |
CustomRequest | This method sends a request to the specified URL using the HTTPMethod and PostData provided. |
DeleteEntry | This method deletes an entry within an OData service resource. |
GetEntryProperty | This method gets an OData entry property. |
GetSchema | This method retrieves the schema for a service. |
HasXPath | This method determines whether a specific element exists in the document. |
QueryService | This method queries an OData service using the specified parameters. |
Reset | This method resets all of properties of the class. |
SetEntryProperty | This method is used to set an OData entry property. |
SetSchemaEntity | This method sets the schema entity. |
SetSchemaProperty | This method sets the schema property. |
SetSchemaType | This method sets the schema type. |
UpdateEntry | This method updates an OData entry. |
UpdateProperty | This method updates an OData entry property. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Connected | This event is fired immediately after a connection completes (or fails). |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event fires when a document finishes transferring. |
Entity | This event is fired once for each entity retrieved. |
Entry | This event is fired once for each entry retrieved. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
Property | This event is fired once for each property found within an entity. |
SetCookie | This event is fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
EncodeResourcePath | Whether the ResourcePath is URL encoded. |
NameAndEmailFormat | Determines how the data of the name and e-mail properties will be formatted. |
TransferredHeaders | The full set of headers as received from the server. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
Authorization Property (IPWorks_OData Class)
This property includes the Authorization string to be sent to the server.
Object Oriented Interface
public function getAuthorization(); public function setAuthorization($value);
Procedural Interface
ipworks_odata_get($res, 1 ); ipworks_odata_set($res, 1, $value );
Default Value
''
Remarks
If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.
A common use for this property is to specify OAuth authorization string.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
Data Type
String
AuthScheme Property (IPWorks_OData Class)
This property specifies the authentication scheme to use when server authentication is required.
Object Oriented Interface
public function getAuthScheme(); public function setAuthScheme($value);
Procedural Interface
ipworks_odata_get($res, 2 ); ipworks_odata_set($res, 2, $value );
Default Value
0
Remarks
This property will tell the class which type of authorization to perform when the User and Password properties are set.
This property should be set to authNone (3) when no authentication is to be performed.
By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.
If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.
Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.
For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.
Data Type
Integer
ChannelAuthorEmail Property (IPWorks_OData Class)
This property contains the email address of the author.
Object Oriented Interface
public function getChannelAuthorEmail(); public function setChannelAuthorEmail($value);
Procedural Interface
ipworks_odata_get($res, 3 ); ipworks_odata_set($res, 3, $value );
Default Value
''
Remarks
This property contains the email address of the author.
This property is not available at design time.
Data Type
String
ChannelAuthorName Property (IPWorks_OData Class)
This property contains the name of the author.
Object Oriented Interface
public function getChannelAuthorName(); public function setChannelAuthorName($value);
Procedural Interface
ipworks_odata_get($res, 4 ); ipworks_odata_set($res, 4, $value );
Default Value
''
Remarks
This property contains the name of the author.
This property is not available at design time.
Data Type
String
ChannelAuthorUri Property (IPWorks_OData Class)
This property contains the uniform resource identifier (URI) of the author.
Object Oriented Interface
public function getChannelAuthorUri(); public function setChannelAuthorUri($value);
Procedural Interface
ipworks_odata_get($res, 5 ); ipworks_odata_set($res, 5, $value );
Default Value
''
Remarks
This property contains the uniform resource identifier (URI) of the author.
This property is not available at design time.
Data Type
String
ChannelCategoryLabel Property (IPWorks_OData Class)
This property contains a textual description of the label for the category.
Object Oriented Interface
public function getChannelCategoryLabel(); public function setChannelCategoryLabel($value);
Procedural Interface
ipworks_odata_get($res, 6 ); ipworks_odata_set($res, 6, $value );
Default Value
''
Remarks
This property contains a textual description of the label for the category.
This property is not available at design time.
Data Type
String
ChannelCategoryScheme Property (IPWorks_OData Class)
This property identifies a categorization scheme.
Object Oriented Interface
public function getChannelCategoryScheme(); public function setChannelCategoryScheme($value);
Procedural Interface
ipworks_odata_get($res, 7 ); ipworks_odata_set($res, 7, $value );
Default Value
''
Remarks
This property identifies a categorization scheme.
This property is not available at design time.
Data Type
String
ChannelCategoryTerm Property (IPWorks_OData Class)
This property contains the category to which the entry or feed belongs.
Object Oriented Interface
public function getChannelCategoryTerm(); public function setChannelCategoryTerm($value);
Procedural Interface
ipworks_odata_get($res, 8 ); ipworks_odata_set($res, 8, $value );
Default Value
''
Remarks
This property contains the category to which the entry or feed belongs.
This property is not available at design time.
Data Type
String
ChannelContributorEmail Property (IPWorks_OData Class)
This property contains the email address of the contributor.
Object Oriented Interface
public function getChannelContributorEmail(); public function setChannelContributorEmail($value);
Procedural Interface
ipworks_odata_get($res, 9 ); ipworks_odata_set($res, 9, $value );
Default Value
''
Remarks
This property contains the email address of the contributor.
This property is not available at design time.
Data Type
String
ChannelContributorName Property (IPWorks_OData Class)
This property contains the name of the contributor.
Object Oriented Interface
public function getChannelContributorName(); public function setChannelContributorName($value);
Procedural Interface
ipworks_odata_get($res, 10 ); ipworks_odata_set($res, 10, $value );
Default Value
''
Remarks
This property contains the name of the contributor.
This property is not available at design time.
Data Type
String
ChannelContributorUri Property (IPWorks_OData Class)
This property contains the uniform resource identifier (URI) of the contributor.
Object Oriented Interface
public function getChannelContributorUri(); public function setChannelContributorUri($value);
Procedural Interface
ipworks_odata_get($res, 11 ); ipworks_odata_set($res, 11, $value );
Default Value
''
Remarks
This property contains the uniform resource identifier (URI) of the contributor.
This property is not available at design time.
Data Type
String
ChannelGenerator Property (IPWorks_OData Class)
This property identifies the generator of the feed.
Object Oriented Interface
public function getChannelGenerator(); public function setChannelGenerator($value);
Procedural Interface
ipworks_odata_get($res, 12 ); ipworks_odata_set($res, 12, $value );
Default Value
''
Remarks
This property identifies the generator of the feed.
This property is not available at design time.
Data Type
String
ChannelIcon Property (IPWorks_OData Class)
This property contains a reference to the image that represents this feed.
Object Oriented Interface
public function getChannelIcon(); public function setChannelIcon($value);
Procedural Interface
ipworks_odata_get($res, 13 ); ipworks_odata_set($res, 13, $value );
Default Value
''
Remarks
This property contains a reference to the image that represents this feed.
This property is not available at design time.
Data Type
String
ChannelId Property (IPWorks_OData Class)
The Id conveys a permanent, universally unique identifier for an entry or feed.
Object Oriented Interface
public function getChannelId(); public function setChannelId($value);
Procedural Interface
ipworks_odata_get($res, 14 ); ipworks_odata_set($res, 14, $value );
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.
Data Type
String
ChannelLinkHref Property (IPWorks_OData Class)
This property contains the location of the link.
Object Oriented Interface
public function getChannelLinkHref(); public function setChannelLinkHref($value);
Procedural Interface
ipworks_odata_get($res, 15 ); ipworks_odata_set($res, 15, $value );
Default Value
''
Remarks
This property contains the location of the link.
This property is not available at design time.
Data Type
String
ChannelLinkHrefLang Property (IPWorks_OData Class)
This property contains the language of the content at the link.
Object Oriented Interface
public function getChannelLinkHrefLang(); public function setChannelLinkHrefLang($value);
Procedural Interface
ipworks_odata_get($res, 16 ); ipworks_odata_set($res, 16, $value );
Default Value
''
Remarks
This property contains the language of the content at the link.
This property is not available at design time.
Data Type
String
ChannelLinkLength Property (IPWorks_OData Class)
This property contains the length (in bytes) of the content at the link.
Object Oriented Interface
public function getChannelLinkLength(); public function setChannelLinkLength($value);
Procedural Interface
ipworks_odata_get($res, 17 ); ipworks_odata_set($res, 17, $value );
Default Value
''
Remarks
This property contains the length (in bytes) of the content at the link.
This property is not available at design time.
Data Type
String
ChannelLinkRel Property (IPWorks_OData Class)
This property indicates the relation of the linked content to the feed.
Object Oriented Interface
public function getChannelLinkRel(); public function setChannelLinkRel($value);
Procedural Interface
ipworks_odata_get($res, 18 ); ipworks_odata_set($res, 18, $value );
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
This property is not available at design time.
Data Type
String
ChannelLinkTitle Property (IPWorks_OData Class)
This property contains the title of the link.
Object Oriented Interface
public function getChannelLinkTitle(); public function setChannelLinkTitle($value);
Procedural Interface
ipworks_odata_get($res, 19 ); ipworks_odata_set($res, 19, $value );
Default Value
''
Remarks
This property contains the title of the link.
This property is not available at design time.
Data Type
String
ChannelLinkType Property (IPWorks_OData Class)
This property contains the multipurpose internet mail extension (MIME) type of the content at the link.
Object Oriented Interface
public function getChannelLinkType(); public function setChannelLinkType($value);
Procedural Interface
ipworks_odata_get($res, 20 ); ipworks_odata_set($res, 20, $value );
Default Value
''
Remarks
This property contains the multipurpose internet mail extension (MIME) type of the content at the link.
This property is not available at design time.
Data Type
String
ChannelLogo Property (IPWorks_OData Class)
This property contains the logo for an image that represents the feed.
Object Oriented Interface
public function getChannelLogo(); public function setChannelLogo($value);
Procedural Interface
ipworks_odata_get($res, 21 ); ipworks_odata_set($res, 21, $value );
Default Value
''
Remarks
This property contains the logo for an image that represents the feed.
This property is not available at design time.
Data Type
String
ChannelRights Property (IPWorks_OData Class)
This property contains information about the rights of the given feed.
Object Oriented Interface
public function getChannelRights(); public function setChannelRights($value);
Procedural Interface
ipworks_odata_get($res, 22 ); ipworks_odata_set($res, 22, $value );
Default Value
''
Remarks
This property contains information about the rights of the given feed.
This property is not available at design time.
Data Type
String
ChannelRightsTextType Property (IPWorks_OData Class)
This property contains the text type of the rights of the feed.
Object Oriented Interface
public function getChannelRightsTextType(); public function setChannelRightsTextType($value);
Procedural Interface
ipworks_odata_get($res, 23 ); ipworks_odata_set($res, 23, $value );
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.
Data Type
Integer
ChannelSubtitle Property (IPWorks_OData Class)
This property contains a short description of the Atom feed.
Object Oriented Interface
public function getChannelSubtitle(); public function setChannelSubtitle($value);
Procedural Interface
ipworks_odata_get($res, 24 ); ipworks_odata_set($res, 24, $value );
Default Value
''
Remarks
This property contains a short description of the Atom feed.
Data Type
String
ChannelSubtitleTextType Property (IPWorks_OData Class)
This property contains the text type of the subtitle of the feed.
Object Oriented Interface
public function getChannelSubtitleTextType(); public function setChannelSubtitleTextType($value);
Procedural Interface
ipworks_odata_get($res, 25 ); ipworks_odata_set($res, 25, $value );
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.
Data Type
Integer
ChannelTitle Property (IPWorks_OData Class)
This property contains the title of the current Atom feed.
Object Oriented Interface
public function getChannelTitle(); public function setChannelTitle($value);
Procedural Interface
ipworks_odata_get($res, 26 ); ipworks_odata_set($res, 26, $value );
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.
Data Type
String
ChannelTitleTextType Property (IPWorks_OData Class)
This property contains the text type of the title of the feed.
Object Oriented Interface
public function getChannelTitleTextType(); public function setChannelTitleTextType($value);
Procedural Interface
ipworks_odata_get($res, 27 ); ipworks_odata_set($res, 27, $value );
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.
Data Type
Integer
ChannelUpdated Property (IPWorks_OData Class)
This property contains the date and time that the feed was updated.
Object Oriented Interface
public function getChannelUpdated(); public function setChannelUpdated($value);
Procedural Interface
ipworks_odata_get($res, 28 ); ipworks_odata_set($res, 28, $value );
Default Value
''
Remarks
This property contains the date and time that the feed was updated.
Data Type
String
CookieCount Property (IPWorks_OData Class)
The number of records in the Cookie arrays.
Object Oriented Interface
public function getCookieCount(); public function setCookieCount($value);
Procedural Interface
ipworks_odata_get($res, 29 ); ipworks_odata_set($res, 29, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at CookieCount - 1.This property is not available at design time.
Data Type
Integer
CookieDomain Property (IPWorks_OData Class)
This is the domain of a received cookie.
Object Oriented Interface
public function getCookieDomain($cookieindex);
Procedural Interface
ipworks_odata_get($res, 30 , $cookieindex);
Default Value
''
Remarks
This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieExpiration Property (IPWorks_OData Class)
This property contains an expiration time for the cookie (if provided by the server).
Object Oriented Interface
public function getCookieExpiration($cookieindex);
Procedural Interface
ipworks_odata_get($res, 31 , $cookieindex);
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 $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieName Property (IPWorks_OData Class)
This property, contains the name of the cookie.
Object Oriented Interface
public function getCookieName($cookieindex); public function setCookieName($cookieindex, $value);
Procedural Interface
ipworks_odata_get($res, 32 , $cookieindex); ipworks_odata_set($res, 32, $value , $cookieindex);
Default Value
''
Remarks
This property, contains the name of the cookie.
This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is not available at design time.
Data Type
String
CookiePath Property (IPWorks_OData Class)
This property contains a path name to limit the cookie to (if provided by the server).
Object Oriented Interface
public function getCookiePath($cookieindex);
Procedural Interface
ipworks_odata_get($res, 33 , $cookieindex);
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 URLPath as the cookie path.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
String
CookieSecure Property (IPWorks_OData Class)
This property contains the security flag of the received cookie.
Object Oriented Interface
public function getCookieSecure($cookieindex);
Procedural Interface
ipworks_odata_get($res, 34 , $cookieindex);
Default Value
false
Remarks
This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is read-only and not available at design time.
Data Type
Boolean
CookieValue Property (IPWorks_OData Class)
This property contains the value of the cookie.
Object Oriented Interface
public function getCookieValue($cookieindex); public function setCookieValue($cookieindex, $value);
Procedural Interface
ipworks_odata_get($res, 35 , $cookieindex); ipworks_odata_set($res, 35, $value , $cookieindex);
Default Value
''
Remarks
This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.
The SetCookie event provides the cookies set by the server.
The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.
This property is not available at design time.
Data Type
String
EntryAuthor Property (IPWorks_OData Class)
This property includes the author of the current entry in an OData feed.
Object Oriented Interface
public function getEntryAuthor(); public function setEntryAuthor($value);
Procedural Interface
ipworks_odata_get($res, 36 ); ipworks_odata_set($res, 36, $value );
Default Value
''
Remarks
This property contains the author of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an author can be found).
This property is not applicable to OData V4 feeds.
This property is not available at design time.
Data Type
String
EntryCount Property (IPWorks_OData Class)
This property includes the number of entries contained within an OData feed.
Object Oriented Interface
public function getEntryCount();
Procedural Interface
ipworks_odata_get($res, 37 );
Default Value
0
Remarks
This property is updated to reflect the total number of entries returned within a response (whether you are retrieving a feed/entry or making changes to a feed/entry).
This property is read-only and not available at design time.
Data Type
Integer
EntryETag Property (IPWorks_OData Class)
This property includes the ETag of the current entry in an OData feed.
Object Oriented Interface
public function getEntryETag(); public function setEntryETag($value);
Procedural Interface
ipworks_odata_get($res, 38 ); ipworks_odata_set($res, 38, $value );
Default Value
''
Remarks
This property is used to obtain the ETag of the specified entry within an OData feed and will be populated once the EntryIndex is set.
This property is also used when retrieving, updating, or deleting an entry. When EntryETag contains a nonempty string, an If-None-Match header will be sent with the entered value when QueryService is called. When DeleteEntry or UpdateEntry is called, an If-Match header will be sent with the entered value.
This property is not available at design time.
Data Type
String
EntryId Property (IPWorks_OData Class)
This property includes the Id of the current entry in an OData feed.
Object Oriented Interface
public function getEntryId(); public function setEntryId($value);
Procedural Interface
ipworks_odata_get($res, 39 ); ipworks_odata_set($res, 39, $value );
Default Value
''
Remarks
This property contains the Id of the specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that an Id can be found).
This property is not available at design time.
Data Type
String
EntryIndex Property (IPWorks_OData Class)
This property includes the index of the current entry in an OData feed.
Object Oriented Interface
public function getEntryIndex(); public function setEntryIndex($value);
Procedural Interface
ipworks_odata_get($res, 40 ); ipworks_odata_set($res, 40, $value );
Default Value
-1
Remarks
This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath will be populated with their respective values found within the entry.
This property takes index values from 0 to EntryCount -1.
Setting EntryIndex to -1 will clear the entries contained by the component and also will reset EntryProperties and EntryCount.
This property is not available at design time.
Data Type
Integer
EntryLinksCount Property (IPWorks_OData Class)
The number of records in the EntryLinks arrays.
Object Oriented Interface
public function getEntryLinksCount(); public function setEntryLinksCount($value);
Procedural Interface
ipworks_odata_get($res, 41 ); ipworks_odata_set($res, 41, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at EntryLinksCount - 1.This property is not available at design time.
Data Type
Integer
EntryLinksResourcePath Property (IPWorks_OData Class)
This property contains the resource path of the OData entry element link.
Object Oriented Interface
public function getEntryLinksResourcePath($entrylinksindex);
Procedural Interface
ipworks_odata_get($res, 42 , $entrylinksindex);
Default Value
''
Remarks
This property contains the resource path of the OData entry element link.
By setting this value to ResourcePath and calling QueryService, you can retrieve the related entries of the current entry (as specified by EntryIndex).
The $entrylinksindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.
This property is read-only and not available at design time.
Data Type
String
EntryLinksTitle Property (IPWorks_OData Class)
This property contains the title of the OData entry element link.
Object Oriented Interface
public function getEntryLinksTitle($entrylinksindex);
Procedural Interface
ipworks_odata_get($res, 43 , $entrylinksindex);
Default Value
''
Remarks
This property contains the title of the OData entry element link.
The $entrylinksindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryLinksCount property.
This property is read-only and not available at design time.
Data Type
String
EntryPropertiesCount Property (IPWorks_OData Class)
The number of records in the EntryProperties arrays.
Object Oriented Interface
public function getEntryPropertiesCount(); public function setEntryPropertiesCount($value);
Procedural Interface
ipworks_odata_get($res, 44 ); ipworks_odata_set($res, 44, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
- EntryPropertiesAttributes
- EntryPropertiesIsNull
- EntryPropertiesName
- EntryPropertiesType
- EntryPropertiesValue
- EntryPropertiesXPath
This property is not available at design time.
Data Type
Integer
EntryPropertiesAttributes Property (IPWorks_OData Class)
This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element.
Object Oriented Interface
public function getEntryPropertiesAttributes($entrypropertiesindex); public function setEntryPropertiesAttributes($entrypropertiesindex, $value);
Procedural Interface
ipworks_odata_get($res, 45 , $entrypropertiesindex); ipworks_odata_set($res, 45, $value , $entrypropertiesindex);
Default Value
''
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData entry element. Such as name1="value1" name2="value2".
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is not available at design time.
Data Type
String
EntryPropertiesIsNull Property (IPWorks_OData Class)
This property indicates whether a property value of a primitive type is null.
Object Oriented Interface
public function getEntryPropertiesIsNull($entrypropertiesindex); public function setEntryPropertiesIsNull($entrypropertiesindex, $value);
Procedural Interface
ipworks_odata_get($res, 46 , $entrypropertiesindex); ipworks_odata_set($res, 46, $value , $entrypropertiesindex);
Default Value
false
Remarks
This property indicates whether a property value of a primitive type is null.
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is not available at design time.
Data Type
Boolean
EntryPropertiesName Property (IPWorks_OData Class)
This property contains the name of the OData entry element.
Object Oriented Interface
public function getEntryPropertiesName($entrypropertiesindex); public function setEntryPropertiesName($entrypropertiesindex, $value);
Procedural Interface
ipworks_odata_get($res, 47 , $entrypropertiesindex); ipworks_odata_set($res, 47, $value , $entrypropertiesindex);
Default Value
''
Remarks
This property contains the name of the OData entry element.
Note: For properties derived from a complex type, the name of the property and its subproperty will be separated by a slash (/). For example, let's say you have a property called MailingAddress that is derived from a complex type called Address. The Address complex type contains a property called City. This particular property will be returned as MailingAddress/City.
Setting this property to an empty string before calling UpdateEntry will result in the item not being sent in the update request, thus removing it from the OData entry.
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is not available at design time.
Data Type
String
EntryPropertiesType Property (IPWorks_OData Class)
This property contains the type of the OData schema property.
Object Oriented Interface
public function getEntryPropertiesType($entrypropertiesindex); public function setEntryPropertiesType($entrypropertiesindex, $value);
Procedural Interface
ipworks_odata_get($res, 48 , $entrypropertiesindex); ipworks_odata_set($res, 48, $value , $entrypropertiesindex);
Default Value
''
Remarks
This property contains the type of the OData schema property.
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is not available at design time.
Data Type
String
EntryPropertiesValue Property (IPWorks_OData Class)
This property contains the value of the OData entry element.
Object Oriented Interface
public function getEntryPropertiesValue($entrypropertiesindex); public function setEntryPropertiesValue($entrypropertiesindex, $value);
Procedural Interface
ipworks_odata_get($res, 49 , $entrypropertiesindex); ipworks_odata_set($res, 49, $value , $entrypropertiesindex);
Default Value
''
Remarks
This property contains the value of the OData entry element.
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is not available at design time.
Data Type
String
EntryPropertiesXPath Property (IPWorks_OData Class)
This property contains the XPath of the OData entry property.
Object Oriented Interface
public function getEntryPropertiesXPath($entrypropertiesindex);
Procedural Interface
ipworks_odata_get($res, 50 , $entrypropertiesindex);
Default Value
''
Remarks
This property contains the XPath of the OData entry property. This value can be used to set XPath or can be used within UpdateProperty to update a specific property.
The $entrypropertiesindex parameter specifies the index of the item in the array. The size of the array is controlled by the EntryPropertiesCount property.
This property is read-only and not available at design time.
Data Type
String
EntrySummary Property (IPWorks_OData Class)
This property includes a summary of the current entry in an OData feed.
Object Oriented Interface
public function getEntrySummary(); public function setEntrySummary($value);
Procedural Interface
ipworks_odata_get($res, 51 ); ipworks_odata_set($res, 51, $value );
Default Value
''
Remarks
This property contains the summary of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a summary can be found).
This property is not applicable to OData V4 feeds.
This property is not available at design time.
Data Type
String
EntryTitle Property (IPWorks_OData Class)
This property includes the title of the current entry in an OData feed.
Object Oriented Interface
public function getEntryTitle(); public function setEntryTitle($value);
Procedural Interface
ipworks_odata_get($res, 52 ); ipworks_odata_set($res, 52, $value );
Default Value
''
Remarks
This property contains the title of a specified entry within an OData feed. This value will be populated once EntryIndex is set (provided that a title can be found).
This property is not available at design time.
Data Type
String
EntryType Property (IPWorks_OData Class)
This property includes the entry category or type.
Object Oriented Interface
public function getEntryType(); public function setEntryType($value);
Procedural Interface
ipworks_odata_get($res, 53 ); ipworks_odata_set($res, 53, $value );
Default Value
''
Remarks
This property specifies the entry category or type. When communicating with a service using OData V3, this property specifies the category element. When communicating with a service using OData V4, this property specifies the type attribute.
This property is not available at design time.
Data Type
String
EntryUpdated Property (IPWorks_OData Class)
This property includes the date-time when a current entry in an OData feed was updated.
Object Oriented Interface
public function getEntryUpdated();
Procedural Interface
ipworks_odata_get($res, 54 );
Default Value
''
Remarks
This property contains the date-time when a specified entry within an OData feed was updated. This value will be populated once EntryIndex is set (provided that a data-time can be found).
This property is not applicable to OData V4 feeds.
This property is read-only.
Data Type
String
EntryXML Property (IPWorks_OData Class)
This property includes the raw XML of the current entry in an OData feed.
Object Oriented Interface
public function getEntryXML(); public function setEntryXML($value);
Procedural Interface
ipworks_odata_get($res, 55 ); ipworks_odata_set($res, 55, $value );
Default Value
''
Remarks
This property contains the raw XML of a specified entry within an OData feed. This value will be populated once EntryIndex is set.
This property is not available at design time.
Data Type
String
FirewallAutoDetect Property (IPWorks_OData Class)
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Object Oriented Interface
public function getFirewallAutoDetect(); public function setFirewallAutoDetect($value);
Procedural Interface
ipworks_odata_get($res, 56 ); ipworks_odata_set($res, 56, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (IPWorks_OData Class)
This property determines the type of firewall to connect through.
Object Oriented Interface
public function getFirewallType(); public function setFirewallType($value);
Procedural Interface
ipworks_odata_get($res, 57 ); ipworks_odata_set($res, 57, $value );
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. FirewallPort is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Data Type
Integer
FirewallHost Property (IPWorks_OData Class)
This property contains the name or IP address of the firewall (optional).
Object Oriented Interface
public function getFirewallHost(); public function setFirewallHost($value);
Procedural Interface
ipworks_odata_get($res, 58 ); ipworks_odata_set($res, 58, $value );
Default Value
''
Remarks
This property contains the name or IP address of the firewall (optional). If a FirewallHost 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.
Data Type
String
FirewallPassword Property (IPWorks_OData Class)
This property contains a password if authentication is to be used when connecting through the firewall.
Object Oriented Interface
public function getFirewallPassword(); public function setFirewallPassword($value);
Procedural Interface
ipworks_odata_get($res, 59 ); ipworks_odata_set($res, 59, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Data Type
String
FirewallPort Property (IPWorks_OData Class)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Object Oriented Interface
public function getFirewallPort(); public function setFirewallPort($value);
Procedural Interface
ipworks_odata_get($res, 60 ); ipworks_odata_set($res, 60, $value );
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (IPWorks_OData Class)
This property contains a username if authentication is to be used when connecting through a firewall.
Object Oriented Interface
public function getFirewallUser(); public function setFirewallUser($value);
Procedural Interface
ipworks_odata_get($res, 61 ); ipworks_odata_set($res, 61, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Data Type
String
Idle Property (IPWorks_OData Class)
This property specifies the current status of the class.
Object Oriented Interface
public function getIdle();
Procedural Interface
ipworks_odata_get($res, 62 );
Default Value
true
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalHost Property (IPWorks_OData Class)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Object Oriented Interface
public function getLocalHost(); public function setLocalHost($value);
Procedural Interface
ipworks_odata_get($res, 63 ); ipworks_odata_set($res, 63, $value );
Default Value
''
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
ODataVersion Property (IPWorks_OData Class)
This property includes the OData version.
Object Oriented Interface
public function getODataVersion(); public function setODataVersion($value);
Procedural Interface
ipworks_odata_get($res, 64 ); ipworks_odata_set($res, 64, $value );
Default Value
3
Remarks
This property specifies the OData version to be used in the request and expected in the response. Possible values are as follows:
- 0 (odV2)
- 1 (odv3)
- 3 (odV4)
- 4 (odAuto - default)
Once the version of the service has been automatically determined, it will continue to be used until Reset is called.
This property is not available at design time.
Data Type
Integer
OtherHeaders Property (IPWorks_OData Class)
This property includes other headers as determined by the user (optional).
Object Oriented Interface
public function getOtherHeaders(); public function setOtherHeaders($value);
Procedural Interface
ipworks_odata_get($res, 65 ); ipworks_odata_set($res, 65, $value );
Default Value
''
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the class beyond what is provided.
This property is not available at design time.
Data Type
String
OtherQueryOptions Property (IPWorks_OData Class)
This property includes additional query options to be used when querying a service.
Object Oriented Interface
public function getOtherQueryOptions(); public function setOtherQueryOptions($value);
Procedural Interface
ipworks_odata_get($res, 66 ); ipworks_odata_set($res, 66, $value );
Default Value
''
Remarks
This property allows you to specify additional query options that will be used when accessing a service. Query options consist of name-value pairs, and multiple entries should be separated with an "&" (i.e., name1=value1&name2=value2).
Note: All specified values will be appended (unaltered) to the end of the URL (generated by the combination of ServiceRootURI, ResourcePath, and any Query*** properties specified).
This property is not available at design time.
Data Type
String
ParsedHeaderCount Property (IPWorks_OData Class)
The number of records in the ParsedHeader arrays.
Object Oriented Interface
public function getParsedHeaderCount();
Procedural Interface
ipworks_odata_get($res, 67 );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (IPWorks_OData Class)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Object Oriented Interface
public function getParsedHeaderField($parsedheaderindex);
Procedural Interface
ipworks_odata_get($res, 68 , $parsedheaderindex);
Default Value
''
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (IPWorks_OData Class)
This property contains the header contents.
Object Oriented Interface
public function getParsedHeaderValue($parsedheaderindex);
Procedural Interface
ipworks_odata_get($res, 69 , $parsedheaderindex);
Default Value
''
Remarks
This property contains the Header contents.
The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
Password Property (IPWorks_OData Class)
This property includes a password if authentication is to be used.
Object Oriented Interface
public function getPassword(); public function setPassword($value);
Procedural Interface
ipworks_odata_get($res, 70 ); ipworks_odata_set($res, 70, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".
If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.
Data Type
String
ProxyAuthScheme Property (IPWorks_OData Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
ipworks_odata_get($res, 71 ); ipworks_odata_set($res, 71, $value );
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (IPWorks_OData Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
ipworks_odata_get($res, 72 ); ipworks_odata_set($res, 72, $value );
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.
Data Type
Boolean
ProxyPassword Property (IPWorks_OData Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
ipworks_odata_get($res, 73 ); ipworks_odata_set($res, 73, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (IPWorks_OData Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
ipworks_odata_get($res, 74 ); ipworks_odata_set($res, 74, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (IPWorks_OData Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
ipworks_odata_get($res, 75 ); ipworks_odata_set($res, 75, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (IPWorks_OData Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
ipworks_odata_get($res, 76 ); ipworks_odata_set($res, 76, $value );
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (IPWorks_OData Class)
This property contains a username if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
ipworks_odata_get($res, 77 ); ipworks_odata_set($res, 77, $value );
Default Value
''
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryFilter Property (IPWorks_OData Class)
This property selects only the entries that satisfy the specified filter (expression).
Object Oriented Interface
public function getQueryFilter(); public function setQueryFilter($value);
Procedural Interface
ipworks_odata_get($res, 78 ); ipworks_odata_set($res, 78, $value );
Default Value
''
Remarks
This property allows you to specify a filter (expression) in which only the entries that satisfy it will be returned.
The following operators are supported in the expression language.
Logical Operators
Operator | Description | Example |
eq | Equal | "City eq 'Durham'" |
ne | Not Equal | "City ne 'North Carolina'" |
gt | Greater Than | "Price gt 20" |
ge | Greater Than or Equal | "Price ge 10" |
lt | Less Than | "Price lt 20" |
le | Less Than or Equal | "Price le 100" |
and | Logical And | "Price le 200 and Price gt 3.5 " |
or | Logical Or | "Price le 3.5 or Price gt 200" |
not | Logical Not | "not endswith(Description,'milk')" |
Arithmetic Operators
Operator | Description | Example |
add | Addition | "Price add 5 gt 10" |
sub | Subtraction | "Price sub 5 gt 10" |
mul | Multiplication | "Price mul 2 gt 2000" |
div | Division | "Price div 2 gt 4" |
mod | Modulo | "Price mod 2 eq 0" |
Grouping Operators
Operator | Description | Example |
( ) | Precedence Grouping | "(Price sub 5) gt 10 " |
The following functions are supported in the expression language.
String Functions
Function | Example |
bool substringof(string po, string p1) | "substringof('Alfreds', CompanyName) eq true" |
bool endswith(string p0, string p1) | "endswith(CompanyName, 'Futterkiste') eq true" |
bool startswith(string p0, string p1) | "startswith(CompanyName, 'Alfr') eq true" |
int length(string p0) | "length(CompanyName) eq 19" |
int indexof(string p0, string p1) | "indexof(CompanyName, 'lfreds') eq 1" |
string replace(string p0, string find, string replace) | "replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'" |
string substring(string p0, int pos) | "substring(CompanyName, 1) eq 'lfreds Futterkiste'" |
string substring(string p0, int pos, int length) | "substring(CompanyName, 1, 2) eq 'lf'" |
string tolower(string p0) | "tolower(CompanyName) eq 'alfreds futterkiste'" |
string toupper(string p0) | "toupper(CompanyName) eq 'ALFREDS FUTTERKISTE'" |
string trim(string p0) | "trim(CompanyName) eq 'Alfreds Futterkiste'" |
string concat(string p0, string p1) | "concat(concat(City, ', '), Country) eq 'Berlin, Germany'" |
Date Functions
Function | Example |
int day(DateTime p0) | "day(BirthDate) eq 8" |
int hour(DateTime p0) | "hour(BirthDate) eq 0" |
int minute(DateTime p0) | "minute(BirthDate) eq 0" |
int month(DateTime p0) | "month(BirthDate) eq 12" |
int second(DateTime p0) | "second(BirthDate) eq 0" |
int year(DateTime p0) | "year(BirthDate) eq 1948" |
Math Functions
Function | Example |
double round(double p0) | "round(Freight) eq 32" |
decimal round(decimal p0) | "round(Freight) eq 32" |
double floor(double p0) | "round(Freight) eq 32" |
decimal floor(decimal p0) | "floor(Freight) eq 32" |
double ceiling(double p0) | "ceiling(Freight) eq 33" |
decimal ceiling(decimal p0) | "floor(Freight) eq 33" |
Type Functions
Function | Example |
bool IsOf(type p0) | "isof('NorthwindModel.Order')" |
bool IsOf(expression p0, type p1) | "isof(ShipCountry, 'Edm.String')" |
This property is not available at design time.
Data Type
String
QueryOrderBy Property (IPWorks_OData Class)
This property includes the value used to order entries when querying a service.
Object Oriented Interface
public function getQueryOrderBy(); public function setQueryOrderBy($value);
Procedural Interface
ipworks_odata_get($res, 79 ); ipworks_odata_set($res, 79, $value );
Default Value
''
Remarks
This property allows you to specify a value by which the returned entries will be ordered after a call to QueryService.
Note: You can specify the order by which the entries are sorted (either ascending or descending) by appending asc or desc (respectively) to your OrderBy value. For example, if you want to sort the entries by Rating in descending order you would set QueryOrderBy to Rating desc. If a specific order (asc or desc) is not specified, the entries will be returned in ascending order.
This property is not available at design time.
Data Type
String
QuerySelect Property (IPWorks_OData Class)
This property selects only the specified properties to be returned in an entry when querying a service.
Object Oriented Interface
public function getQuerySelect(); public function setQuerySelect($value);
Procedural Interface
ipworks_odata_get($res, 80 ); ipworks_odata_set($res, 80, $value );
Default Value
''
Remarks
This property allows you to specify the specific properties you want returned within an entry when calling QueryService. The specified value should be a comma-separated list of properties (provided you wish to have more than one property returned). For example, if you wish to have only the Name and Price of each item returned you can set QuerySelect to Name,Price.
Note: The specified values can be a property name, navigation property name (EntryLinksTitle), or the "*" character, which returns all the properties for each entry.
This property is not available at design time.
Data Type
String
QuerySkip Property (IPWorks_OData Class)
This property includes the number of entries to skip when querying a service.
Object Oriented Interface
public function getQuerySkip(); public function setQuerySkip($value);
Procedural Interface
ipworks_odata_get($res, 81 ); ipworks_odata_set($res, 81, $value );
Default Value
''
Remarks
This property allows you to specify the number of entries to skip (from the top of the list) when calling QueryService. Therefore when this property set, only the remaining entries (starting with entry N+1) will be returned. The specified value should not be a value less than zero.
By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before skipping the top N items.
This property can be used in conjunction with QueryOrderBy and QueryTop to select specific entries. For example, if you wanted to select the third and fourth highest rated item you would set QueryOrderBy to Rating desc (to order the items by Rating from highest to lowest), set QuerySkip to 2 (to skip the first and second items), and finally set QueryTop to 2 (to return only the third and fourth items).
This property is not available at design time.
Data Type
String
QuerySkipToken Property (IPWorks_OData Class)
This property includes the token given by an OData server when the last query result collection is too large.
Object Oriented Interface
public function getQuerySkipToken(); public function setQuerySkipToken($value);
Procedural Interface
ipworks_odata_get($res, 82 ); ipworks_odata_set($res, 82, $value );
Default Value
''
Remarks
When a returned result collection is very large, it is not uncommon for the results to be broken up into multiple pages. When this occurs, a Skip Token is returned in the response and the component will populate QuerySkipToken with the returned value. Calling QueryService again will return the next page of results.
This property is not available at design time.
Data Type
String
QueryTop Property (IPWorks_OData Class)
This property selects the first N entries when querying a service.
Object Oriented Interface
public function getQueryTop(); public function setQueryTop($value);
Procedural Interface
ipworks_odata_get($res, 83 ); ipworks_odata_set($res, 83, $value );
Default Value
''
Remarks
This property allows you to specify the number of entries (taken from the top of the list) to be returned when calling QueryService. The specified value should not be a value less than zero.
By default, the service you are querying will sort the entries using a scheme selected by the OData service you are querying. You can, however, use QueryOrderBy to specify how the entries should be sorted before selecting the top N items.
This property is not available at design time.
Data Type
String
ResourcePath Property (IPWorks_OData Class)
This property includes the resource path of an OData service.
Object Oriented Interface
public function getResourcePath(); public function setResourcePath($value);
Procedural Interface
ipworks_odata_get($res, 84 ); ipworks_odata_set($res, 84, $value );
Default Value
''
Remarks
This property contains the resource path of an OData service and is used in conjunction with ServiceRootURI (ServiceRootURI/ResourcePath) to query feeds and modify entries.
This property will be populated when EntryIndex is set. You can change the value if you wish to send the request to a different resource path.
For example, a valid ResourcePath for the OData sample service is Products.
This property is not available at design time.
Data Type
String
SchemaAssociationContainsTarget Property (IPWorks_OData Class)
This property indicates whether the navigation property contains a target.
Object Oriented Interface
public function getSchemaAssociationContainsTarget();
Procedural Interface
ipworks_odata_get($res, 85 );
Default Value
false
Remarks
This property indicates whether the navigation property contains a target. If True, the navigation property is a containment navigation property.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaAssociationDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema association.
Object Oriented Interface
public function getSchemaAssociationDescription();
Procedural Interface
ipworks_odata_get($res, 86 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema association.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationFromRole Property (IPWorks_OData Class)
This property contains the name of the starting point of the navigation.
Object Oriented Interface
public function getSchemaAssociationFromRole();
Procedural Interface
ipworks_odata_get($res, 87 );
Default Value
''
Remarks
This property contains the name of the starting point of the navigation.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationFromRoleDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema FromRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationFromRoleDescription();
Procedural Interface
ipworks_odata_get($res, 88 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema FromRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationFromRoleEntity Property (IPWorks_OData Class)
This property contains the name of the entity that the FromRole association endpoint maps to.
Object Oriented Interface
public function getSchemaAssociationFromRoleEntity();
Procedural Interface
ipworks_odata_get($res, 89 );
Default Value
''
Remarks
This property contains the name of the entity that the SchemaAssociationFromRole association endpoint maps to.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationFromRoleMultiplicity Property (IPWorks_OData Class)
This property contains the multiplicity of the FromRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationFromRoleMultiplicity();
Procedural Interface
ipworks_odata_get($res, 90 );
Default Value
0
Remarks
This property contains the multiplicity of the SchemaAssociationFromRole association endpoint. This is used along with SchemaAssociationToRoleMultiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).
The available values are as follows:
nmZeroOne (0) | Zero-One (0..1) |
nmOne (1) | One (1) |
nmMany (2) | Many (*) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Integer
SchemaAssociationFromRoleSummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema FromRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationFromRoleSummary();
Procedural Interface
ipworks_odata_get($res, 91 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema FromRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationName Property (IPWorks_OData Class)
This property contains the name of the OData schema navigation property.
Object Oriented Interface
public function getSchemaAssociationName();
Procedural Interface
ipworks_odata_get($res, 92 );
Default Value
''
Remarks
This property contains the name of the OData schema navigation property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationNullable Property (IPWorks_OData Class)
This property indicates whether the property defined by the schema can be a null value.
Object Oriented Interface
public function getSchemaAssociationNullable();
Procedural Interface
ipworks_odata_get($res, 93 );
Default Value
true
Remarks
This property indicates whether the property defined by the schema can be a null value. If False, then the object must contain a value.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaAssociationOnDelete Property (IPWorks_OData Class)
This property contains the delete action to be performed.
Object Oriented Interface
public function getSchemaAssociationOnDelete();
Procedural Interface
ipworks_odata_get($res, 94 );
Default Value
0
Remarks
This property contains the delete action to be performed.
The possible values are as follows:
0 (daNone) | Only the specified entry instance within SchemaAssociationFromRoleEntity is deleted. This is the default value. |
1 (daCascade) | After the specified entry instance is deleted within SchemaAssociationFromRoleEntity, the action is applied to the entry instance within the SchemaAssociationToRoleEntity. For example, a single customer is associated with multiple Orders. When a customer is deleted, all orders associated with the customer also will be deleted. |
2 (daSetNull) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to null. This value is applicable only to OData Version 4. |
3 (daSetDefault) | All properties of related entities that are tied to properties of the source entity through a referential constraint and that do not participate in other referential constraints will be set to their default value. This value is applicable only to OData Version 4. |
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Integer
SchemaAssociationPartner Property (IPWorks_OData Class)
This property contains the partner value identifying a navigation property (if any).
Object Oriented Interface
public function getSchemaAssociationPartner();
Procedural Interface
ipworks_odata_get($res, 95 );
Default Value
''
Remarks
This property contains the partner value identifying a navigation property (if any).
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationRefConstraintCount Property (IPWorks_OData Class)
This property contains the number of referential constraints.
Object Oriented Interface
public function getSchemaAssociationRefConstraintCount();
Procedural Interface
ipworks_odata_get($res, 96 );
Default Value
0
Remarks
This property contains the number of referential constraints. To examine the individual referential constraints set SchemaAssociationRefConstraintIndex
to a value from 0 to SchemaAssociationRefConstraintCount -1.
Example. Referential Constraints:
For i = 0 to odata.SchemaAssociation.RefConstraintCount - 1
odata.SchemaAssociation.RefConstraintIndex = i;
Console.Write(odata.SchemaAssociation.RefConstraintProperty);
Console.Write(odata.SchemaAssociation.RefConstraintReferencedProperty);
Next i
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Integer
SchemaAssociationRefConstraintIndex Property (IPWorks_OData Class)
This property contains the current index of the referential constraint.
Object Oriented Interface
public function getSchemaAssociationRefConstraintIndex(); public function setSchemaAssociationRefConstraintIndex($value);
Procedural Interface
ipworks_odata_get($res, 97 ); ipworks_odata_set($res, 97, $value );
Default Value
0
Remarks
This property contains the current index of the referential constraint. See SchemaAssociationRefConstraintCount for details.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is not available at design time.
Data Type
Integer
SchemaAssociationRefConstraintProperty Property (IPWorks_OData Class)
This property contains the property that takes part in the referential constraint.
Object Oriented Interface
public function getSchemaAssociationRefConstraintProperty();
Procedural Interface
ipworks_odata_get($res, 98 );
Default Value
''
Remarks
This property contains the property that takes part in the referential constraint.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationRefConstraintReferencedProperty Property (IPWorks_OData Class)
This property contains the corresponding property of the principal entity type.
Object Oriented Interface
public function getSchemaAssociationRefConstraintReferencedProperty();
Procedural Interface
ipworks_odata_get($res, 99 );
Default Value
''
Remarks
This property contains the corresponding property of the principal entity type.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationRelationship Property (IPWorks_OData Class)
This property contains the name of the relationship (association) of the navigation property.
Object Oriented Interface
public function getSchemaAssociationRelationship();
Procedural Interface
ipworks_odata_get($res, 100 );
Default Value
''
Remarks
This property contains the name of the relationship (association) of the navigation property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationSummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema association.
Object Oriented Interface
public function getSchemaAssociationSummary();
Procedural Interface
ipworks_odata_get($res, 101 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema association.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationToRole Property (IPWorks_OData Class)
This property contains the name of the endpoint of the navigation.
Object Oriented Interface
public function getSchemaAssociationToRole();
Procedural Interface
ipworks_odata_get($res, 102 );
Default Value
''
Remarks
This property contains the name of the endpoint of the navigation.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationToRoleDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema ToRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationToRoleDescription();
Procedural Interface
ipworks_odata_get($res, 103 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema ToRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationToRoleEntity Property (IPWorks_OData Class)
This property contains the name of the entity that the ToRole association endpoint maps to.
Object Oriented Interface
public function getSchemaAssociationToRoleEntity();
Procedural Interface
ipworks_odata_get($res, 104 );
Default Value
''
Remarks
This property contains the name of the entity that the SchemaAssociationToRole association endpoint maps to.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationToRoleMultiplicity Property (IPWorks_OData Class)
This property contains the multiplicity of the ToRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationToRoleMultiplicity();
Procedural Interface
ipworks_odata_get($res, 105 );
Default Value
0
Remarks
This property contains the multiplicity of the SchemaAssociationToRole association endpoint. This is used along with SchemaAssociationFromRoleMultiplicity to determine the cardinality of the relationship (i.e., one-to-one or one-to-many).
The available values are as follows:
nmZeroOne (0) | Zero-One (0..1) |
nmOne (1) | One (1) |
nmMany (2) | Many (*) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
Integer
SchemaAssociationToRoleSummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema ToRole association endpoint.
Object Oriented Interface
public function getSchemaAssociationToRoleSummary();
Procedural Interface
ipworks_odata_get($res, 106 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema ToRole association endpoint.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationType Property (IPWorks_OData Class)
This property contains the entity type.
Object Oriented Interface
public function getSchemaAssociationType();
Procedural Interface
ipworks_odata_get($res, 107 );
Default Value
''
Remarks
This property contains the entity type.
This property is applicable only to OData Version 4.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaAssociationCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaAssociationCount Property (IPWorks_OData Class)
This property includes the number of navigation properties contained within an OData schema entity.
Object Oriented Interface
public function getSchemaAssociationCount();
Procedural Interface
ipworks_odata_get($res, 108 );
Default Value
0
Remarks
This property is updated to reflect the total number of navigation properties within the schema entity specified by SchemaEntityIndex.
This property is read-only and not available at design time.
Data Type
Integer
SchemaAssociationIndex Property (IPWorks_OData Class)
This property includes the index of the current navigation property in an OData schema entity.
Object Oriented Interface
public function getSchemaAssociationIndex(); public function setSchemaAssociationIndex($value);
Procedural Interface
ipworks_odata_get($res, 109 ); ipworks_odata_set($res, 109, $value );
Default Value
0
Remarks
This property is used to specify a navigation property within an entity (specified by SchemaEntityIndex). Once set, SchemaAssociation will be populated.
This property is not available at design time.
Data Type
Integer
SchemaEntityDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema entity.
Object Oriented Interface
public function getSchemaEntityDescription();
Procedural Interface
ipworks_odata_get($res, 110 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaEntityName Property (IPWorks_OData Class)
This property contains the name of the OData schema entity.
Object Oriented Interface
public function getSchemaEntityName();
Procedural Interface
ipworks_odata_get($res, 111 );
Default Value
''
Remarks
This property contains the name of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaEntitySummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema entity.
Object Oriented Interface
public function getSchemaEntitySummary();
Procedural Interface
ipworks_odata_get($res, 112 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema entity.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaEntityCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaEntityCount Property (IPWorks_OData Class)
This property includes the number of entities contained within an OData schema.
Object Oriented Interface
public function getSchemaEntityCount();
Procedural Interface
ipworks_odata_get($res, 113 );
Default Value
0
Remarks
This property is updated to reflect the total number of entities within a schema (retrieved via GetSchema).
This property is read-only and not available at design time.
Data Type
Integer
SchemaEntityIndex Property (IPWorks_OData Class)
This property includes the index of the current entity in an OData schema.
Object Oriented Interface
public function getSchemaEntityIndex(); public function setSchemaEntityIndex($value);
Procedural Interface
ipworks_odata_get($res, 114 ); ipworks_odata_set($res, 114, $value );
Default Value
0
Remarks
This property is used to specify an entity within a retrieved OData schema. Once set, SchemaEntity will be populated.
This property is not available at design time.
Data Type
Integer
SchemaKeysCount Property (IPWorks_OData Class)
The number of records in the SchemaKeys array.
Object Oriented Interface
public function getSchemaKeysCount();
Procedural Interface
ipworks_odata_get($res, 115 );
Default Value
0
Remarks
This property is read-only and not available at design time.
Data Type
Integer
SchemaKeys Property (IPWorks_OData Class)
This property includes the keys for a schema entity.
Object Oriented Interface
public function getSchemaKeys($schemakeysindex);
Procedural Interface
ipworks_odata_get($res, 116 , $schemakeysindex);
Default Value
'0'
Remarks
This property is used to obtain the keys contained within an entity for a service schema and is populated after setting SchemaEntityIndex.
Note: Key values map to a property of the entity, details of which can be retrieved via SchemaProperty.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyAttributes Property (IPWorks_OData Class)
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.
Object Oriented Interface
public function getSchemaPropertyAttributes();
Procedural Interface
ipworks_odata_get($res, 117 );
Default Value
''
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema property.
Object Oriented Interface
public function getSchemaPropertyDescription();
Procedural Interface
ipworks_odata_get($res, 118 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyIsComplexType Property (IPWorks_OData Class)
This property indicates whether a property is derived from a complex type.
Object Oriented Interface
public function getSchemaPropertyIsComplexType();
Procedural Interface
ipworks_odata_get($res, 119 );
Default Value
false
Remarks
This property indicates whether a property is derived from a complex type.
When set to True, SchemaTypeField can be used to navigate the properties contained within the complex type.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaPropertyName Property (IPWorks_OData Class)
This property contains the Name of the OData schema property.
Object Oriented Interface
public function getSchemaPropertyName();
Procedural Interface
ipworks_odata_get($res, 120 );
Default Value
''
Remarks
This property contains the Name of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyNullable Property (IPWorks_OData Class)
This property indicates whether a property can be null.
Object Oriented Interface
public function getSchemaPropertyNullable();
Procedural Interface
ipworks_odata_get($res, 121 );
Default Value
false
Remarks
This property indicates whether a property can be null.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaPropertySummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema property.
Object Oriented Interface
public function getSchemaPropertySummary();
Procedural Interface
ipworks_odata_get($res, 122 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyType Property (IPWorks_OData Class)
This property contains the type of the OData schema property.
Object Oriented Interface
public function getSchemaPropertyType();
Procedural Interface
ipworks_odata_get($res, 123 );
Default Value
''
Remarks
This property contains the type of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaPropertyCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaPropertyCount Property (IPWorks_OData Class)
This property includes the number of properties contained within an OData schema entity.
Object Oriented Interface
public function getSchemaPropertyCount();
Procedural Interface
ipworks_odata_get($res, 124 );
Default Value
0
Remarks
This property is updated to reflect the total number of properties within the schema entity specified by SchemaEntityIndex.
This property is read-only and not available at design time.
Data Type
Integer
SchemaPropertyIndex Property (IPWorks_OData Class)
This property includes the index of the current property in an OData schema entity.
Object Oriented Interface
public function getSchemaPropertyIndex(); public function setSchemaPropertyIndex($value);
Procedural Interface
ipworks_odata_get($res, 125 ); ipworks_odata_set($res, 125, $value );
Default Value
0
Remarks
This property is used to specify a property within an entity (specified by SchemaEntityIndex). Once set, SchemaProperty will be populated.
This property is not available at design time.
Data Type
Integer
SchemaTypeFieldAttributes Property (IPWorks_OData Class)
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element.
Object Oriented Interface
public function getSchemaTypeFieldAttributes();
Procedural Interface
ipworks_odata_get($res, 126 );
Default Value
''
Remarks
This property contains a space-separated list of attributes (name-value pairs) contained within an OData property element. Such as name1="value1" name2="value2".
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaTypeFieldDescription Property (IPWorks_OData Class)
This property contains the documentation long description of the OData schema property.
Object Oriented Interface
public function getSchemaTypeFieldDescription();
Procedural Interface
ipworks_odata_get($res, 127 );
Default Value
''
Remarks
This property contains the documentation long description of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaTypeFieldIsComplexType Property (IPWorks_OData Class)
This property indicates whether a property is derived from a complex type.
Object Oriented Interface
public function getSchemaTypeFieldIsComplexType();
Procedural Interface
ipworks_odata_get($res, 128 );
Default Value
false
Remarks
This property indicates whether a property is derived from a complex type.
When set to True, SchemaTypeField can be used to navigate the properties contained within the complex type.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaTypeFieldName Property (IPWorks_OData Class)
This property contains the Name of the OData schema property.
Object Oriented Interface
public function getSchemaTypeFieldName();
Procedural Interface
ipworks_odata_get($res, 129 );
Default Value
''
Remarks
This property contains the Name of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaTypeFieldNullable Property (IPWorks_OData Class)
This property indicates whether a property can be null.
Object Oriented Interface
public function getSchemaTypeFieldNullable();
Procedural Interface
ipworks_odata_get($res, 130 );
Default Value
false
Remarks
This property indicates whether a property can be null.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SchemaTypeFieldSummary Property (IPWorks_OData Class)
This property contains the documentation summary of the OData schema property.
Object Oriented Interface
public function getSchemaTypeFieldSummary();
Procedural Interface
ipworks_odata_get($res, 131 );
Default Value
''
Remarks
This property contains the documentation summary of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaTypeFieldType Property (IPWorks_OData Class)
This property contains the type of the OData schema property.
Object Oriented Interface
public function getSchemaTypeFieldType();
Procedural Interface
ipworks_odata_get($res, 132 );
Default Value
''
Remarks
This property contains the type of the OData schema property.
The parameter specifies the index of the item in the array. The size of the array is controlled by the SchemaTypeFieldCount property.
This property is read-only and not available at design time.
Data Type
String
SchemaTypeFieldCount Property (IPWorks_OData Class)
This property includes the number of properties contained within an OData schema complex type.
Object Oriented Interface
public function getSchemaTypeFieldCount();
Procedural Interface
ipworks_odata_get($res, 133 );
Default Value
0
Remarks
This property is updated to reflect the total number of fields (properties) within the schema complex type of a property. This is populated when navigating an entity's properties via SchemaPropertyIndex or by explicitly setting the type via SetSchemaType.
This property is read-only and not available at design time.
Data Type
Integer
SchemaTypeFieldIndex Property (IPWorks_OData Class)
This property includes the index of the current field (property) in an OData schema complex type.
Object Oriented Interface
public function getSchemaTypeFieldIndex(); public function setSchemaTypeFieldIndex($value);
Procedural Interface
ipworks_odata_get($res, 134 ); ipworks_odata_set($res, 134, $value );
Default Value
0
Remarks
This property is used to specify a field (property) within a complex type. Once set, SchemaTypeField will be populated.
This property is not available at design time.
Data Type
Integer
ServiceRootURI Property (IPWorks_OData Class)
This property includes the root URI of an OData service.
Object Oriented Interface
public function getServiceRootURI(); public function setServiceRootURI($value);
Procedural Interface
ipworks_odata_get($res, 135 ); ipworks_odata_set($res, 135, $value );
Default Value
''
Remarks
This property contains the root URI of an OData service. This value is used in conjunction with ResourcePath (ServiceRootURI/ResourcePath) to query feeds and modify entries.
Example.
The ServiceRootURI of the OData sample service is "http://services.odata.org/OData/OData.svc/".
This property is not available at design time.
Data Type
String
SSLAcceptServerCertEffectiveDate Property (IPWorks_OData Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLAcceptServerCertEffectiveDate();
Procedural Interface
ipworks_odata_get($res, 136 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (IPWorks_OData Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLAcceptServerCertExpirationDate();
Procedural Interface
ipworks_odata_get($res, 137 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_OData Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLAcceptServerCertExtendedKeyUsage();
Procedural Interface
ipworks_odata_get($res, 138 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (IPWorks_OData Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprint();
Procedural Interface
ipworks_odata_get($res, 139 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_OData Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA1();
Procedural Interface
ipworks_odata_get($res, 140 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_OData Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertFingerprintSHA256();
Procedural Interface
ipworks_odata_get($res, 141 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (IPWorks_OData Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertIssuer();
Procedural Interface
ipworks_odata_get($res, 142 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (IPWorks_OData Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKey();
Procedural Interface
ipworks_odata_get($res, 143 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_OData Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyAvailable();
Procedural Interface
ipworks_odata_get($res, 144 );
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_OData Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLAcceptServerCertPrivateKeyContainer();
Procedural Interface
ipworks_odata_get($res, 145 );
Default Value
''
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (IPWorks_OData Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKey();
Procedural Interface
ipworks_odata_get($res, 146 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_OData Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyAlgorithm();
Procedural Interface
ipworks_odata_get($res, 147 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (IPWorks_OData Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLAcceptServerCertPublicKeyLength();
Procedural Interface
ipworks_odata_get($res, 148 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (IPWorks_OData Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLAcceptServerCertSerialNumber();
Procedural Interface
ipworks_odata_get($res, 149 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_OData Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLAcceptServerCertSignatureAlgorithm();
Procedural Interface
ipworks_odata_get($res, 150 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (IPWorks_OData Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStore(); public function setSSLAcceptServerCertStore($value);
Procedural Interface
ipworks_odata_get($res, 151 ); ipworks_odata_set($res, 151, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLAcceptServerCertStorePassword Property (IPWorks_OData Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLAcceptServerCertStorePassword(); public function setSSLAcceptServerCertStorePassword($value);
Procedural Interface
ipworks_odata_get($res, 152 ); ipworks_odata_set($res, 152, $value );
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.
Data Type
String
SSLAcceptServerCertStoreType Property (IPWorks_OData Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLAcceptServerCertStoreType(); public function setSSLAcceptServerCertStoreType($value);
Procedural Interface
ipworks_odata_get($res, 153 ); ipworks_odata_set($res, 153, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLAcceptServerCertSubjectAltNames Property (IPWorks_OData Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertSubjectAltNames();
Procedural Interface
ipworks_odata_get($res, 154 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (IPWorks_OData Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintMD5();
Procedural Interface
ipworks_odata_get($res, 155 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_OData Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA1();
Procedural Interface
ipworks_odata_get($res, 156 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_OData Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertThumbprintSHA256();
Procedural Interface
ipworks_odata_get($res, 157 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (IPWorks_OData Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLAcceptServerCertUsage();
Procedural Interface
ipworks_odata_get($res, 158 );
Default Value
''
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (IPWorks_OData Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLAcceptServerCertUsageFlags();
Procedural Interface
ipworks_odata_get($res, 159 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (IPWorks_OData Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLAcceptServerCertVersion();
Procedural Interface
ipworks_odata_get($res, 160 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (IPWorks_OData Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLAcceptServerCertSubject(); public function setSSLAcceptServerCertSubject($value);
Procedural Interface
ipworks_odata_get($res, 161 ); ipworks_odata_set($res, 161, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLAcceptServerCertEncoded Property (IPWorks_OData Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
ipworks_odata_get($res, 162 ); ipworks_odata_set($res, 162, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEffectiveDate Property (IPWorks_OData Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLCertEffectiveDate();
Procedural Interface
ipworks_odata_get($res, 163 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (IPWorks_OData Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLCertExpirationDate();
Procedural Interface
ipworks_odata_get($res, 164 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (IPWorks_OData Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLCertExtendedKeyUsage();
Procedural Interface
ipworks_odata_get($res, 165 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (IPWorks_OData Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprint();
Procedural Interface
ipworks_odata_get($res, 166 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (IPWorks_OData Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA1();
Procedural Interface
ipworks_odata_get($res, 167 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (IPWorks_OData Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLCertFingerprintSHA256();
Procedural Interface
ipworks_odata_get($res, 168 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (IPWorks_OData Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLCertIssuer();
Procedural Interface
ipworks_odata_get($res, 169 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (IPWorks_OData Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKey();
Procedural Interface
ipworks_odata_get($res, 170 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (IPWorks_OData Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLCertPrivateKeyAvailable();
Procedural Interface
ipworks_odata_get($res, 171 );
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (IPWorks_OData Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLCertPrivateKeyContainer();
Procedural Interface
ipworks_odata_get($res, 172 );
Default Value
''
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (IPWorks_OData Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLCertPublicKey();
Procedural Interface
ipworks_odata_get($res, 173 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (IPWorks_OData Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLCertPublicKeyAlgorithm();
Procedural Interface
ipworks_odata_get($res, 174 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (IPWorks_OData Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLCertPublicKeyLength();
Procedural Interface
ipworks_odata_get($res, 175 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (IPWorks_OData Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLCertSerialNumber();
Procedural Interface
ipworks_odata_get($res, 176 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (IPWorks_OData Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLCertSignatureAlgorithm();
Procedural Interface
ipworks_odata_get($res, 177 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (IPWorks_OData Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
ipworks_odata_get($res, 178 ); ipworks_odata_set($res, 178, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (IPWorks_OData Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
ipworks_odata_get($res, 179 ); ipworks_odata_set($res, 179, $value );
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.
Data Type
String
SSLCertStoreType Property (IPWorks_OData Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
ipworks_odata_get($res, 180 ); ipworks_odata_set($res, 180, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubjectAltNames Property (IPWorks_OData Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLCertSubjectAltNames();
Procedural Interface
ipworks_odata_get($res, 181 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (IPWorks_OData Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintMD5();
Procedural Interface
ipworks_odata_get($res, 182 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (IPWorks_OData Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA1();
Procedural Interface
ipworks_odata_get($res, 183 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (IPWorks_OData Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLCertThumbprintSHA256();
Procedural Interface
ipworks_odata_get($res, 184 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (IPWorks_OData Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLCertUsage();
Procedural Interface
ipworks_odata_get($res, 185 );
Default Value
''
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (IPWorks_OData Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLCertUsageFlags();
Procedural Interface
ipworks_odata_get($res, 186 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (IPWorks_OData Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLCertVersion();
Procedural Interface
ipworks_odata_get($res, 187 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (IPWorks_OData Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
ipworks_odata_get($res, 188 ); ipworks_odata_set($res, 188, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLCertEncoded Property (IPWorks_OData Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
ipworks_odata_get($res, 189 ); ipworks_odata_set($res, 189, $value );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (IPWorks_OData Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
ipworks_odata_get($res, 190 ); ipworks_odata_set($res, 190, $value );
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEffectiveDate Property (IPWorks_OData Class)
This is the date on which this certificate becomes valid.
Object Oriented Interface
public function getSSLServerCertEffectiveDate();
Procedural Interface
ipworks_odata_get($res, 191 );
Default Value
''
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (IPWorks_OData Class)
This is the date the certificate expires.
Object Oriented Interface
public function getSSLServerCertExpirationDate();
Procedural Interface
ipworks_odata_get($res, 192 );
Default Value
''
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (IPWorks_OData Class)
This is a comma-delimited list of extended key usage identifiers.
Object Oriented Interface
public function getSSLServerCertExtendedKeyUsage();
Procedural Interface
ipworks_odata_get($res, 193 );
Default Value
''
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (IPWorks_OData Class)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprint();
Procedural Interface
ipworks_odata_get($res, 194 );
Default Value
''
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (IPWorks_OData Class)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA1();
Procedural Interface
ipworks_odata_get($res, 195 );
Default Value
''
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (IPWorks_OData Class)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Object Oriented Interface
public function getSSLServerCertFingerprintSHA256();
Procedural Interface
ipworks_odata_get($res, 196 );
Default Value
''
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (IPWorks_OData Class)
This is the issuer of the certificate.
Object Oriented Interface
public function getSSLServerCertIssuer();
Procedural Interface
ipworks_odata_get($res, 197 );
Default Value
''
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (IPWorks_OData Class)
This is the private key of the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKey();
Procedural Interface
ipworks_odata_get($res, 198 );
Default Value
''
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (IPWorks_OData Class)
This property shows whether a PrivateKey is available for the selected certificate.
Object Oriented Interface
public function getSSLServerCertPrivateKeyAvailable();
Procedural Interface
ipworks_odata_get($res, 199 );
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (IPWorks_OData Class)
This is the name of the PrivateKey container for the certificate (if available).
Object Oriented Interface
public function getSSLServerCertPrivateKeyContainer();
Procedural Interface
ipworks_odata_get($res, 200 );
Default Value
''
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (IPWorks_OData Class)
This is the public key of the certificate.
Object Oriented Interface
public function getSSLServerCertPublicKey();
Procedural Interface
ipworks_odata_get($res, 201 );
Default Value
''
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (IPWorks_OData Class)
This property contains the textual description of the certificate's public key algorithm.
Object Oriented Interface
public function getSSLServerCertPublicKeyAlgorithm();
Procedural Interface
ipworks_odata_get($res, 202 );
Default Value
''
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (IPWorks_OData Class)
This is the length of the certificate's public key (in bits).
Object Oriented Interface
public function getSSLServerCertPublicKeyLength();
Procedural Interface
ipworks_odata_get($res, 203 );
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (IPWorks_OData Class)
This is the serial number of the certificate encoded as a string.
Object Oriented Interface
public function getSSLServerCertSerialNumber();
Procedural Interface
ipworks_odata_get($res, 204 );
Default Value
''
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (IPWorks_OData Class)
The property contains the text description of the certificate's signature algorithm.
Object Oriented Interface
public function getSSLServerCertSignatureAlgorithm();
Procedural Interface
ipworks_odata_get($res, 205 );
Default Value
''
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (IPWorks_OData Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLServerCertStore();
Procedural Interface
ipworks_odata_get($res, 206 );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
This property is read-only.
Data Type
Binary String
SSLServerCertStorePassword Property (IPWorks_OData Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLServerCertStorePassword();
Procedural Interface
ipworks_odata_get($res, 207 );
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.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (IPWorks_OData Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLServerCertStoreType();
Procedural Interface
ipworks_odata_get($res, 208 );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (IPWorks_OData Class)
This property contains comma-separated lists of alternative subject names for the certificate.
Object Oriented Interface
public function getSSLServerCertSubjectAltNames();
Procedural Interface
ipworks_odata_get($res, 209 );
Default Value
''
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (IPWorks_OData Class)
This property contains the MD5 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintMD5();
Procedural Interface
ipworks_odata_get($res, 210 );
Default Value
''
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (IPWorks_OData Class)
This property contains the SHA-1 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA1();
Procedural Interface
ipworks_odata_get($res, 211 );
Default Value
''
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (IPWorks_OData Class)
This property contains the SHA-256 hash of the certificate.
Object Oriented Interface
public function getSSLServerCertThumbprintSHA256();
Procedural Interface
ipworks_odata_get($res, 212 );
Default Value
''
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (IPWorks_OData Class)
This property contains the text description of UsageFlags .
Object Oriented Interface
public function getSSLServerCertUsage();
Procedural Interface
ipworks_odata_get($res, 213 );
Default Value
''
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (IPWorks_OData Class)
This property contains the flags that show intended use for the certificate.
Object Oriented Interface
public function getSSLServerCertUsageFlags();
Procedural Interface
ipworks_odata_get($res, 214 );
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (IPWorks_OData Class)
This property contains the certificate's version number.
Object Oriented Interface
public function getSSLServerCertVersion();
Procedural Interface
ipworks_odata_get($res, 215 );
Default Value
''
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (IPWorks_OData Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLServerCertSubject();
Procedural Interface
ipworks_odata_get($res, 216 );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (IPWorks_OData Class)
This is the certificate (PEM/Base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
ipworks_odata_get($res, 217 );
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
Timeout Property (IPWorks_OData Class)
This property includes the timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
ipworks_odata_get($res, 218 ); ipworks_odata_set($res, 218, $value );
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 DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
TransferredData Property (IPWorks_OData Class)
This property includes the contents of the last response from the server.
Object Oriented Interface
public function getTransferredData();
Procedural Interface
ipworks_odata_get($res, 219 );
Default Value
''
Remarks
This property is used to get the data of the last response from the server.
TransferredData will be populated after a successful QueryService or CustomRequest call, provided that LocalFile is not set. If LocalFile is set, the object data will be written to the file specified.
This property is read-only and not available at design time.
Data Type
Binary String
User Property (IPWorks_OData Class)
This property includes a user name if authentication is to be used.
Object Oriented Interface
public function getUser(); public function setUser($value);
Procedural Interface
ipworks_odata_get($res, 220 ); ipworks_odata_set($res, 220, $value );
Default Value
''
Remarks
This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.
If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.
Data Type
String
Config Method (IPWorks_OData Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
ipworks_odata_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateEntry Method (IPWorks_OData Class)
This method creates a new entry within the specified OData service resource.
Object Oriented Interface
public function doCreateEntry();
Procedural Interface
ipworks_odata_do_createentry($res);
Remarks
The component will use the items contained within EntryProperties to create a new entry within the feed service resource by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).
Upon a successful creation, all previous entries contained by the component, before the CreateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to 0 (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, and EntryProperties properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.
CustomRequest Method (IPWorks_OData Class)
This method sends a request to the specified URL using the HTTPMethod and PostData provided.
Object Oriented Interface
public function doCustomRequest($httpmethod, $url, $postdata);
Procedural Interface
ipworks_odata_do_customrequest($res, $httpmethod, $url, $postdata);
Remarks
This method sends a custom request to the specified URL. The type of request sent is determined by HTTPMethod (e.g., POST) and the data sent are determined by PostData. If a custom request does not require data to be sent, simply set the PostData parameter to an empty string.
Note: All values specified are taken as entered.
OtherHeaders can be used to specify any additional headers you would like to be sent in the custom request.
The search results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the TransferredHeaders property as well as through the Header event.
The 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 EntryCount will be populated with the total number of entries contained within the feed. EntryIndex also will be set to 1, thus populating EntryProperties.
DeleteEntry Method (IPWorks_OData Class)
This method deletes an entry within an OData service resource.
Object Oriented Interface
public function doDeleteEntry();
Procedural Interface
ipworks_odata_do_deleteentry($res);
Remarks
The component will delete the entry, of an OData service resource, specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath).
An "If-Match" header will be sent in the delete request with the value contained within EntryETag.
Upon a successful entry deletion, all previous entries contained by the component, before the DeleteEntry call, will be cleared. OtherHeaders also will be cleared and thus will need to be reset accordingly with each call made.
GetEntryProperty Method (IPWorks_OData Class)
This method gets an OData entry property.
Object Oriented Interface
public function doGetEntryProperty($xpath);
Procedural Interface
ipworks_odata_do_getentryproperty($res, $xpath);
Remarks
This method is intended to extend the functionality of the OData class and will retrieve the value of the entry property specified by XPath. XPath is the XPath of the element or attribute according to the following convention: entry[x]/element@attribute. The @attribute part is optional. When EntryIndex is set to an index greater than or equal to zero, a relative path also can be used: property or property@attribute. When a relative path is specified, the value of the specified XPath will be returned for the entry identified by EntryIndex.
entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.
property is any child of the property's element, and attribute can be any attribute of that field. If an attribute is not supplied, the GetEntryProperty method will return the text portion of property.
Example 1. Attribute Not Supplied:
ODataControl.GetEntryProperty("entry[5]/content/properties/ID")
ODataControl.GetEntryProperty("entry[5]/content/properties/ID@type")
Example 2. Relative Path: In the following example, a relative path is used to retrieve properties
of the first feed entry:
ODataControl.EntryIndex = 1
ODataControl.GetEntryProperty("ID")
ODataControl.GetEntryProperty("ID@type")
ODataControl.GetEntryProperty("Address/State")
GetSchema Method (IPWorks_OData Class)
This method retrieves the schema for a service.
Object Oriented Interface
public function doGetSchema();
Procedural Interface
ipworks_odata_do_getschema($res);
Remarks
This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.
Upon successful retrieval of the schema, set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.
Additional details about the schema can be retrieved via XPath.
HasXPath Method (IPWorks_OData Class)
This method determines whether a specific element exists in the document.
Object Oriented Interface
public function doHasXPath($xpath);
Procedural Interface
ipworks_odata_do_hasxpath($res, $xpath);
Remarks
This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.
This method returns True if the xpath exists, and False if not.
See XPath for details on the XPath syntax.
QueryService Method (IPWorks_OData Class)
This method queries an OData service using the specified parameters.
Object Oriented Interface
public function doQueryService();
Procedural Interface
ipworks_odata_do_queryservice($res);
Remarks
This method queries an OData feed specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath) using the query options specified in the Query*** properties and OtherQueryOptions. To retrieve an OData feed, without performing any filtering, you can leave Query*** and OtherQueryOptions empty and call QueryService.
The query results are delivered in the TransferredData property, as well as through the Transfer event. The response headers can be retrieved through the ParsedHeaders property as well as through the Header event.
The class will attempt to parse the query results. Upon successfully parsing the response, Channel will be set with their associated feed element values and EntryCount will be populated with the total number of entries contained within the feed. EntryIndex will also be set to 1, thus populating EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath.
Reset Method (IPWorks_OData Class)
This method resets all of properties of the class.
Object Oriented Interface
public function doReset();
Procedural Interface
ipworks_odata_do_reset($res);
Remarks
The Reset method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the OData feed.
SetEntryProperty Method (IPWorks_OData Class)
This method is used to set an OData entry property.
Object Oriented Interface
public function doSetEntryProperty($xpath, $value);
Procedural Interface
ipworks_odata_do_setentryproperty($res, $xpath, $value);
Remarks
This method is intended to extend functionality of the OData class and will set the value of the entry property (specified by XPath) to the specified Value. Therefore, the value of the corresponding property will be updated within EntryProperties.
XPath is the XPath of the element or attribute according to the following convention: entry[x]/element. When EntryIndex is set to an index greater than or equal to zero, a relative path can also be used: property. When a relative path is specified, the class will use the specified EntryIndex along with the property specified to update the EntryProperty value.
entry[x] is the feed's xth entry (or any other root-level child), where the indexer x starts at 1.
property is any child of the property's element.
Example 1. Set Properties: ODataControl.SetEntryProperty("entry[5]/content/properties/Name", "MyNewName")
Example 2. Retrieve Properties:
The following example uses a relative path to retrieve properties
of the first feed entry:
ODataControl.EntryIndex = 1
ODataControl.SetEntryProperty("Name", "MyNewName")
ODataControl.SetEntryProperty("Address/State", "NC")
SetSchemaEntity Method (IPWorks_OData Class)
This method sets the schema entity.
Object Oriented Interface
public function doSetSchemaEntity($name);
Procedural Interface
ipworks_odata_do_setschemaentity($res, $name);
Remarks
The class will set the schema entity to the Name specified. Once set, you can view the keys (via SchemaKeys), properties (via SchemaProperty), and navigation properties (via SchemaAssociation) contained within the specified entity.
SetSchemaProperty Method (IPWorks_OData Class)
This method sets the schema property.
Object Oriented Interface
public function doSetSchemaProperty($name);
Procedural Interface
ipworks_odata_do_setschemaproperty($res, $name);
Remarks
The class will set the schema property to the Name specified. Once set, you can view the details of the property (via SchemaProperty) along with the complex type details (via SchemaTypeField); provided that the property is derived from the complex type.
SetSchemaType Method (IPWorks_OData Class)
This method sets the schema type.
Object Oriented Interface
public function doSetSchemaType($name);
Procedural Interface
ipworks_odata_do_setschematype($res, $name);
Remarks
The class will set the schema type to the Name specified. Once set, you can view the details of the complex type (via SchemaTypeField).
UpdateEntry Method (IPWorks_OData Class)
This method updates an OData entry.
Object Oriented Interface
public function doUpdateEntry();
Procedural Interface
ipworks_odata_do_updateentry($res);
Remarks
The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It also will update the OData entry with the elements specified by EntryProperties.
Upon a successful update, all previous entries contained by the component, before the UpdateEntry call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath properties. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.
UpdateProperty Method (IPWorks_OData Class)
This method updates an OData entry property.
Object Oriented Interface
public function doUpdateProperty($xpath, $value);
Procedural Interface
ipworks_odata_do_updateproperty($res, $xpath, $value);
Remarks
The class will update the OData entry specified by ServiceRootURI and ResourcePath (ServiceRootURI/ResourcePath). It will update only the single entry property specified by XPath with the specified Value.
Upon a successful update, all previous entries contained by the component, before the UpdateProperty call, will be cleared and replaced with the response entry data. EntryIndex will then be set to zero (the first entry within the response), populating the EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties, and ResourcePath. OtherHeaders will also be cleared and thus will need to be reset accordingly with each call made.
Connected Event (IPWorks_OData Class)
This event is fired immediately after a connection completes (or fails).
Object Oriented Interface
public function fireConnected($param);
Procedural Interface
ipworks_odata_register_callback($res, 1, array($this, 'fireConnected'));
Parameter List
'statuscode'
'description'
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
Disconnected Event (IPWorks_OData Class)
This event is fired when a connection is closed.
Object Oriented Interface
public function fireDisconnected($param);
Procedural Interface
ipworks_odata_register_callback($res, 2, array($this, 'fireDisconnected'));
Parameter List
'statuscode'
'description'
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
EndTransfer Event (IPWorks_OData Class)
This event fires when a document finishes transferring.
Object Oriented Interface
public function fireEndTransfer($param);
Procedural Interface
ipworks_odata_register_callback($res, 3, array($this, 'fireEndTransfer'));
Parameter List
'direction'
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Entity Event (IPWorks_OData Class)
This event is fired once for each entity retrieved.
Object Oriented Interface
public function fireEntity($param);
Procedural Interface
ipworks_odata_register_callback($res, 4, array($this, 'fireEntity'));
Parameter List
'name'
Remarks
The Entity event is fired once for each entity found when retrieving a service's schema (metadata document) through GetSchema.
Entry Event (IPWorks_OData Class)
This event is fired once for each entry retrieved.
Object Oriented Interface
public function fireEntry($param);
Procedural Interface
ipworks_odata_register_callback($res, 5, array($this, 'fireEntry'));
Parameter List
'id'
'title'
'summary'
'etag'
Remarks
The Entry event is fired once for each entry found in the response.
The entry properties are provided through EntryProperties.
The entry links are provided through EntryLinks.
Error Event (IPWorks_OData Class)
Fired when information is available about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
ipworks_odata_register_callback($res, 6, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
Header Event (IPWorks_OData Class)
This event is fired every time a header line comes in.
Object Oriented Interface
public function fireHeader($param);
Procedural Interface
ipworks_odata_register_callback($res, 7, array($this, 'fireHeader'));
Parameter List
'field'
'value'
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (IPWorks_OData Class)
This event fires once for each log message.
Object Oriented Interface
public function fireLog($param);
Procedural Interface
ipworks_odata_register_callback($res, 8, array($this, 'fireLog'));
Parameter List
'loglevel'
'message'
'logtype'
Remarks
This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
Property Event (IPWorks_OData Class)
This event is fired once for each property found within an entity.
Object Oriented Interface
public function fireProperty($param);
Procedural Interface
ipworks_odata_register_callback($res, 9, array($this, 'fireProperty'));
Parameter List
'name'
'typename'
'nullable'
Remarks
The Property event is fired once for each property found within an entity after setting SchemaEntityIndex.
SetCookie Event (IPWorks_OData Class)
This event is fired for every cookie set by the server.
Object Oriented Interface
public function fireSetCookie($param);
Procedural Interface
ipworks_odata_register_callback($res, 10, array($this, 'fireSetCookie'));
Parameter List
'name'
'value'
'expires'
'domain'
'path'
'secure'
Remarks
The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.
The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.
The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.
The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.
The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.
The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.
SSLServerAuthentication Event (IPWorks_OData Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
ipworks_odata_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (IPWorks_OData Class)
Fired when secure connection progress messages are available.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
ipworks_odata_register_callback($res, 12, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (IPWorks_OData Class)
This event fires when a document starts transferring (after the headers).
Object Oriented Interface
public function fireStartTransfer($param);
Procedural Interface
ipworks_odata_register_callback($res, 13, array($this, 'fireStartTransfer'));
Parameter List
'direction'
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Status Event (IPWorks_OData Class)
This event is fired when the HTTP status line is received from the server.
Object Oriented Interface
public function fireStatus($param);
Procedural Interface
ipworks_odata_register_callback($res, 14, array($this, 'fireStatus'));
Parameter List
'httpversion'
'statuscode'
'description'
Remarks
HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").
StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").
Transfer Event (IPWorks_OData Class)
This event is fired while a document transfers (delivers document).
Object Oriented Interface
public function fireTransfer($param);
Procedural Interface
ipworks_odata_register_callback($res, 15, array($this, 'fireTransfer'));
Parameter List
'direction'
'bytestransferred'
'percentdone'
'text'
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config Settings (OData Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.OData Config Settings
0 (default) | SMTP Format: Name <e-mail address> |
1 | Name only. |
2 | E-mail address only. |
HTTP Config Settings
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.
The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".
The default value is False.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the class beyond what is provided.
.NET
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
C++
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.
Note: This setting is applicable only to Mac/iOS editions.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed 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 LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if SSLProvider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the 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 SSLProvider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
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 traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (OData Class)
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 URLScheme is invalid. |
155 | Range operation is not supported by server. |
156 | Invalid cookie index (out of range). |
301 | Interrupted. |
302 | Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |