IP*Works! soap Component : soap OCX, soap .NET Component, soap Class, soap Bean, soap Object

Available in: IP*WORKS! | SSH | SSL

Soap Class

SOAP Component [IP*Works! V8]

Properties Methods Events Configuration Settings

The SOAP component is used to communicate with SOAP servers.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SOAP component implements a standard SOAP client as specified in the SOAP 1.1 specification.

The component uses HTTP to communicate with SOAP servers, and an internal XML parser to process the results. The SOAP requests are specified by first setting the SOAP Method and MethodURI, as well as optional parameters in the Params properties . Then set the target URL and call the SendRequest method.

The results will be provided through the ReturnValue property and the Params properties (for output parameters). Additionally, properties such as XPath, XElement, XText, etc.. allow for more granular traversal of the SOAP response.

If the server returns an error, the FaultCode, FaultString, and FaultActor properties will provide information about the error condition.

The component may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important in cases where the underlying SOAP transport is not HTTP, but another mechanism (e.g. SMTP and POP for email).

By providing direct access to the SOAP packet in offline mode, the component allows for possible extension and full control over the SOAPPacket. The SendPacket method may then be used to send the custom-created SOAPPacket to the destination URL.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Accept	A list of acceptable MIME types for the request.
ActionURI	The value of the SOAP-Action header.
AuthScheme	The authorization scheme to be used when server authorization is to be performed.
Connected	Shows whether the component is connected.
ContentType	Content type for SOAP request data.
Cookies	Collection of cookies.
FaultActor	Actor of any faults returned by the SOAP server.
FaultCode	Code of any faults returned by the SOAP server.
FaultString	Textual description of any faults returned by the SOAP server.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
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.
Method	The remote Method.
MethodURI	The URI corresponding to the SOAP Method.
Namespaces	A collection of namespaces in the current stack.
OtherHeaders	Other headers as determined by the user (optional).
Params	A collection of parameters for the SOAP Method.
ParsedHeaders	Collection of headers returned from the last request.
Password	A password if authentication is to be used.
Pragma	A browser/server specific header line (optional).
Proxy	A set of properties related to proxy access.
Referer	Referer URL/document (optional).
ReturnValue	Value returned by the SOAP Method.
SOAPEncoding	The type of SOAP Encoding used for SOAP requests.
SOAPHeader	Contents of the optional SOAP header sent to the server.
SOAPPacket	Full contents of the SOAP packet.
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 data to be transferred.
TransferredHeaders	The full set of headers as received from the server.
URL	The URL to fetch.
User	A user name if authentication is to be used.
ValueFormat	Format of data returned or set.
XAttributes	A collection of attributes of the current element.
XChildren	The number of children of the element pointed to by XPath.
XElement	The name of the element pointed to by XPath.
XNamespace	The namespace of the element pointed to by XPath.
XParent	The parent of the element pointed to by XPath.
XPath	A path into the SOAPPacket received by the server.
XPrefix	The prefix of the element pointed to by XPath.
XText	The text of the element pointed to by XPath.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AddCookie	Adds a cookie and the corresponding value to the outgoing request headers.
AddNamespace	Adds a namespace to the Namespaces properties .
AddParam	Adds a parameter-value pair.
Attr	Returns the value of the specified attribute.
BuildPacket	Build the request packet.
Config	Sets or retrieves a component configuration setting.
DoEvents	Processes events from the internal message queue.
EvalPacket	Evaluate the packet in SOAPPacket.
Interrupt	Interrupt the current method.
Reset	Reset the component.
SendPacket	Send the packet.
SendRequest	Send the request.
Value	Returns the value of a parameter.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
Redirect	Fired when a redirection is received from the server.
SetCookie	Fired for every cookie set by the server.
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 the response transfers.

Configuration Settings

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


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
CacheContent	If true, the original XML is saved in a buffer
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EncodeURL	If set to true the URL will be encoded by the component.
EncodingStyleNamespacePrefix	The prefix to be used for the Encoding namespace.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
IgnoreBadAttributePrefixes	If true, bad (unknown) attribute prefixes are ignored
IgnoreBadElementPrefixes	If true, bad (unknown) element prefixes are ignored
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MethodNamespacePrefix	The prefix to be used for the Method namespace.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyAuthorization	The authorization string to be sent to the proxy server.
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.
TcpNoDelay	Whether or not to delay when sending packets
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UserAgent	Information about the user agent (browser).
XSubTree	A snapshot of the current element in the document.