REST Component
Properties Methods Events Configuration Settings Errors
The REST Component can be used to retrieve XML documents from the World Wide Web.
Syntax
nsoftware.IPWorks.Rest
Remarks
The REST Component supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.
The REST Component implements a standard REST client with the added option of SSL security.
The component contains a number of properties that map directly to HTTP request headers. All XML and JSON data received is parsed by the component and provided to the user through properties such as XPath, XElement, XText, etc. which allow traversal of the document structure. The Header event will provide the HTTP headers as returned by the server.
To receive a document, call the Get method with the URL to retrieve specified in the URL parameter. The component will automatically parse the XML or JSON data, depending on the content type that is returned. Call the Delete method to delete a resource specified by the URL parameter.
The Post and Put methods are used to create and update resources. Post is commonly used to both create and update resources, however each service may have its own requirements. To send data to the server set PostData and call the Post or Put method.
To add authorization credentials to an outgoing request, you should specify the User and Password properties. The REST Component supports Basic, Digest, and NTLM authentication through the AuthScheme property.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Accept | A list of acceptable MIME types for the request. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authentication scheme to use when server authorization is required. |
BuildDOM | When True, an internal object model of the XML document is created. |
Connected | Shows whether the component is connected. |
ContentType | Content type for posts and puts. |
Cookies | Collection of cookies. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
From | The email address of the HTTP agent (optional). |
HTTPMethod | The HTTP method used for the request. |
Idle | The current status of the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
LocalFile | The path to a local file for downloading. If the file exists, it is overwritten. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Namespaces | A collection of namespaces in the current stack. |
OtherHeaders | Other headers as determined by the user (optional). |
ParsedHeaders | Collection of headers returned from the last request. |
Password | A password if authentication is to be used. |
PostData | The data to post with the URL if the POST method is used. |
Proxy | A set of properties related to proxy access. |
Referer | Referer URL/document (optional). |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
StatusLine | The first line of the last server response. |
Timeout | A timeout for the component. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum of bytes of data to be transferred. |
TransferredHeaders | The full set of headers as received from the server. |
URL | The URL to which information is posted. |
User | A user name if authentication is to be used. |
Validate | When True, the parser checks that the document consists of well-formed XML. |
XAttributes | A collection of attributes of the current element. |
XChildren | Collection of child elements of the current element. |
XElement | The name of the current element. |
XErrorPath | An XPath to check the server response for errors. |
XNamespace | The namespace of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the response. |
XPrefix | The prefix of the current element. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddCookie | Adds a cookie and the corresponding value to the outgoing request headers. |
Attr | Returns the value of the specified attribute. |
Config | Sets or retrieves a configuration setting. |
Delete | Deletes an object on the server. |
DoEvents | Processes events from the internal message queue. |
Get | Fetches the document using the HTTP GET method. |
HasXPath | Determines whether a specific element exists in the document. |
Interrupt | Interrupt the current method. |
Post | Posts data to the HTTP server using the HTTP POST method. |
Put | Sends data to the HTTP server using the HTTP PUT method. |
Reset | Resets the component. |
TryXPath | Navigates to the specified XPath if it exists. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Characters | Fired for plain text segments of the input stream. |
Comment | Fired when a comment section is encountered. |
Connected | Fired immediately after a connection completes (or fails). |
ConnectionStatus | Fired to indicate changes in connection state. |
Disconnected | Fired when a connection is closed. |
EndElement | Fired when an end-element tag is encountered. |
EndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
EvalEntity | Fired every time an entity needs to be evaluated. |
Header | Fired every time a header line comes in. |
IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
Log | Fires once for each log message. |
Meta | Fired when a meta section is encountered. |
PI | Fired when a processing instruction section is encountered. |
Redirect | Fired when a redirection is received from the server. |
SetCookie | Fired for every cookie set by the server. |
SpecialSection | Fired when a special section is encountered. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartElement | Fired when a begin-element tag is encountered in the document. |
StartPrefixMapping | Fired when entering the scope of a namespace declaration. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Status | Fired when the HTTP status line is received from the server. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
CacheContent | If true, the original XML is saved in a buffer. |
From | Allows the specification of the email address of the HTTP agent. |
StringProcessingOptions | Defines options to use when processing string values. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |