IP*Works! SSL V9 - Online Help
IP*Works! SSL V9
Questions / Feedback?

RESTS Component

Properties   Methods   Events   Configuration Settings   Errors  

The RESTS Component can be used to retrieve XML documents from the World Wide Web.

Syntax

nsoftware.IPWorksSSL.Rests

Remarks

The RESTS Component is the SSL-enabled equivalent of the IP*Works! REST Component. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. The SSLEnabledProtocols and SSLCipherStrength configuration settings determine which protocols are enabled and at what security level. The SSLCert property is used to select a client certificate if the server is requesting client authentication. The SSLSecurityFlags configuration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

The RESTS 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 other two REST operations are for creating and updating resources. Some people wish to use the Post method for creating resources and the Put method for updating resources. Others choose to use the methods vice versa, or just one for both operations. So, you can POST XML or JSON data to the HTTP server by assigning it to the PostData property and then calling the Post method. Alternatively, you may use the PUT method instead.

To add authorization credentials to an outgoing request, you should specify the User and Password properties. The RESTS 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.

AcceptA list of acceptable MIME types for the request.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authentication scheme to use when server authorization is required.
BuildDOMWhen True, an internal object model of the XML document is created.
ConnectedShows whether the component is connected.
ContentTypeContent type for posts and puts.
CookiesCollection of cookies.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
FromThe email address of the HTTP agent (optional).
HTTPMethodThe HTTP method used for the request.
IdleThe current status of the component.
IfModifiedSinceA date determining the maximum age of the desired document.
LocalFileThe path to a local file for downloading. If the file exists, it is overwritten.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
NamespacesA collection of namespaces in the current stack.
OtherHeadersOther headers as determined by the user (optional).
ParsedHeadersCollection of headers returned from the last request.
PasswordA password if authentication is to be used.
PostDataThe data to post with the URL if the POST method is used.
ProxyA set of properties related to proxy access.
RefererReferer URL/document (optional).
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum of bytes of data to be transferred.
TransferredHeadersThe full set of headers as received from the server.
URLThe URL to which information is posted.
UserA user name if authentication is to be used.
ValidateWhen True, the parser checks that the document consists of well-formed XML.
XAttributesA collection of attributes of the current element.
XChildrenCollection of child elements of the current element.
XElementThe name of the current element.
XErrorPathAn XPath to check the server response for errors.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the response.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe 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.

AddCookieAdds a cookie and the corresponding value to the outgoing request headers.
AttrReturns the value of the specified attribute.
ConfigSets or retrieves a configuration setting .
DeleteDeletes an object on the server.
DoEventsProcesses events from the internal message queue.
GetFetches the document using the HTTP GET method.
HasXPathDetermines whether a specific element exists in the document.
InterruptInterrupt the current method.
PostPosts data to the HTTP server using the HTTP POST method.
PutSends data to the HTTP server using the HTTP PUT method.
ResetResets the component.

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.

CharactersFired for plain text segments of the input stream.
CommentFired when a comment section is encountered.
ConnectedFired immediately after a connection completes (or fails).
ConnectionStatusFired to indicate changes in connection state.
DisconnectedFired when a connection is closed.
EndElementFired when an end-element tag is encountered.
EndPrefixMappingFired when leaving the scope of a namespace declaration.
ErrorInformation about errors during data delivery.
EvalEntityFired every time an entity needs to be evaluated.
HeaderFired every time a header line comes in.
IgnorableWhitespaceFired when a section of ignorable whitespace is encountered.
MetaFired when a meta section is encountered.
PIFired when a processing instruction section is encountered.
RedirectFired when a redirection is received from the server.
SetCookieFired for every cookie set by the server.
SpecialSectionFired when a special section is encountered.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartElementFired when a begin-element tag is encountered in the document.
StartPrefixMappingFired when entering the scope of a namespace declaration.
StatusFired when the HTTP status line is received from the server.

Configuration Settings


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

FromAllows the specification of the email address of the HTTP agent.
CacheContentIf true, the original XML is saved in a buffer.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0