IP*Works!

ipworks
Class Soap

java.lang.Object
  |
  +--ipworks.Soap

public class Soap
extends java.lang.Object

The SOAP control is used to communicate with SOAP servers.

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

The control 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 and optional parameters in the ParamName and ParamValue properties. Then set the target URL and call the SendRequest method, or set the Action property to soapSendRequest .

The results will be provided in properties such as ReturnValue , and ParamName , ParamValue 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 provide information about the error condition.

The control may also be used in offline mode. This is supported by methods such as BuildPacket and EvalPacket and the corresponding Action codes. The corresponding SOAP packet will be stored in the SOAPPacket property. Offline mode is important for 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 control also allows for possible extensions, and full control over SOAPPacket . The SendPacket method or the corresponding Action code may then be used to send the custom-created SOAPPacket to the destination URL .


Field Summary
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
static int soapBuildPacket
           
static int soapEvalPacket
           
static int soapIdle
           
static int soapReset
           
static int soapSendPacket
           
static int soapSendRequest
           
static int vfFullXML
           
static int vfText
           
static int vfXML
           
 
Constructor Summary
Soap()
           
 
Method Summary
 void addCookie(java.lang.String cookieName, java.lang.String cookieValue)
          Sets a cookie and the corresponding value.
 void addParam(java.lang.String paramName, java.lang.String paramValue)
          Adds a parameter-value pair.
 void addSoapEventListener(SoapEventListener l)
           
 void buildPacket()
          Build the request packet and place it in SOAPPacket .
 void evalPacket()
          Evaluate the packet in SOAPPacket .
 void fireConnected(int statusCode, java.lang.String description)
          Fired immediately after a connection completes (or fails).
 void fireDisconnected(int statusCode, java.lang.String description)
          Fired when a connection is closed.
 void fireEndTransfer()
          Fired when a document finishes transferring.
 void fireError(int errorCode, java.lang.String description)
          Information about errors during data delivery.
 void fireHeader(java.lang.String field, java.lang.String value)
          Fired every time a header line comes in.
 void fireSetCookie(java.lang.String name, java.lang.String value, java.lang.String expires, java.lang.String domain, java.lang.String path, boolean secure)
          Fired for every cookie set by the server.
 void fireStartTransfer()
          Fired when a document starts transferring (after the headers).
 void fireTransfer(int bytesTransferred)
          Fired while the response transfers.
 int getAction()
          An action code for the component.
 java.lang.String getActionURI()
          The value of the SOAP-Action header.
 java.lang.String getAuthorization()
          The Authorization string to be sent to the server.
 java.lang.String getContentType()
          Content type for SOAP request data.
 int getCookieCount()
          Number of cookies in the current request.
 java.lang.String getCookieName(int cookieIndex)
          Array of cookie names.
 java.lang.String getCookieValue(int cookieIndex)
          Array of cookie values.
 java.lang.String getFaultActor()
          Actor of any faults returned by the SOAP server.
 java.lang.String getFaultCode()
          Code of any faults returned by the SOAP server.
 java.lang.String getFaultString()
          Textual description of any faults returned by the SOAP server.
 byte[] getFirewallData()
          Used to send other data to firewall.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used connecting through the firewall.
 int getFirewallPort()
          Port of the firewall to connect to.
 int getFirewallType()
          Determines the type of firewall to connect through.
 java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.
 int getFlags()
          Flags controlling the behaviour of the parser.
 java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 java.lang.String getMethod()
          The remote Method .
 java.lang.String getMethodURI()
          The URI corresponding to the SOAP Method .
 int getNamespaceCount()
          The number of default Namespaces defined.
 java.lang.String getNamespaces(int namespaceIndex)
          The default Namespaces defined by the component.
 java.lang.String getOtherHeaders()
          Other headers as determined by the user (optional).
 java.lang.String getParamAttr(int paramIndex)
          Extra attributes of the Method parameters.
 int getParamCount()
          The number of parameters sent to the remote host.
 java.lang.String getParamName(int paramIndex)
          The names of the Method parameters.
 java.lang.String getParamValue(int paramIndex)
          The values of the Method parameters.
 java.lang.String getPassword()
          A password if Basic authentication is to be used.
 java.lang.String getPrefixes(int namespaceIndex)
          The prefixes corresponding to the default Namespaces defined by the component.
 java.lang.String getProxyAuthorization()
          Similar to the Authorization property, but for proxy authorization.
 int getProxyPort()
          Port for the proxy server (default 80).
 java.lang.String getProxyServer()
          Name or IP address of a proxy server (optional).
 java.lang.String getReturnValue()
          Value returned by the SOAP Method .
 java.lang.String getSOAPEncoding()
          The type of SOAP Encoding used for SOAP requests.
 java.lang.String getSOAPHeader()
          Contents of the optional SOAP header sent to the server.
 java.lang.String getSOAPPacket()
          Full contents of the SOAP packet.
 java.lang.String getStatusLine()
          The first line of the last server response.
 int getTimeout()
          A timeout for the component.
 java.lang.String getURL()
          The URL to fetch.
 java.lang.String getUser()
          A user name if Basic authentication is to be used.
 java.lang.String getUserAgent()
          Information about the user agent.
 int getValueFormat()
          Format of data returned or set.
 int getXAttrCount()
          Size of attribute values array for the current element.
 java.lang.String getXAttrName(int attrIndex)
          Array of attribute names for the current element.
 java.lang.String getXAttrNamespace(int attrIndex)
          Array of attribute namespaces for the current element.
 java.lang.String getXAttrPrefix(int attrIndex)
          Array of attribute prefixes for the current element.
 java.lang.String getXAttrValue(int attrIndex)
          Array of attribute values for the current element.
 int getXChildren()
          The number of children of the element pointed to by XPath .
 java.lang.String getXElement()
          The name of the element pointed to by XPath .
 java.lang.String getXNamespace()
          The namespace of the element pointed to by XPath .
 java.lang.String getXParent()
          The parent of the element pointed to by XPath .
 java.lang.String getXPath()
          A path into the SOAPPacket received by the server.
 java.lang.String getXPrefix()
          The prefix of the element pointed to by XPath .
 java.lang.String getXText()
          The text of the element pointed to by XPath .
 void interrupt()
          Interrupt the Action in progress (if any).
 boolean isConnected()
          Shows whether the component is connected.
 void removeSoapEventListener(SoapEventListener l)
           
 void reset()
          Reset.
 void sendPacket()
          Send the packet.
 void sendRequest()
          Send the request.
 void setAction(int action)
          An action code for the component.
 void setActionURI(java.lang.String actionURI)
          The value of the SOAP-Action header.
 void setAuthorization(java.lang.String authorization)
          The Authorization string to be sent to the server.
 void setContentType(java.lang.String contentType)
          Content type for SOAP request data.
 void setCookieCount(int cookieCount)
          Number of cookies in the current request.
 void setCookieName(int cookieIndex, java.lang.String cookieName)
          Array of cookie names.
 void setCookieValue(int cookieIndex, java.lang.String cookieValue)
          Array of cookie values.
 void setFirewallData(byte[] firewallData)
          Used to send other data to firewall.
 void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).
 void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used connecting through the firewall.
 void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.
 void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.
 void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.
 void setFlags(int flags)
          Flags controlling the behaviour of the parser.
 void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
 void setMethod(java.lang.String method)
          The remote Method .
 void setMethodURI(java.lang.String methodURI)
          The URI corresponding to the SOAP Method .
 void setNamespaces(int namespaceIndex, java.lang.String namespaces)
          The default Namespaces defined by the component.
 void setOtherHeaders(java.lang.String otherHeaders)
          Other headers as determined by the user (optional).
 void setParamAttr(int paramIndex, java.lang.String paramAttr)
          Extra attributes of the Method parameters.
 void setParamCount(int paramCount)
          The number of parameters sent to the remote host.
 void setParamName(int paramIndex, java.lang.String paramName)
          The names of the Method parameters.
 void setParamValue(int paramIndex, java.lang.String paramValue)
          The values of the Method parameters.
 void setPassword(java.lang.String password)
          A password if Basic authentication is to be used.
 void setPrefixes(int namespaceIndex, java.lang.String prefixes)
          The prefixes corresponding to the default Namespaces defined by the component.
 void setProxyAuthorization(java.lang.String proxyAuthorization)
          Similar to the Authorization property, but for proxy authorization.
 void setProxyPort(int proxyPort)
          Port for the proxy server (default 80).
 void setProxyServer(java.lang.String proxyServer)
          Name or IP address of a proxy server (optional).
 void setSOAPEncoding(java.lang.String SOAPEncoding)
          The type of SOAP Encoding used for SOAP requests.
 void setSOAPHeader(java.lang.String SOAPHeader)
          Contents of the optional SOAP header sent to the server.
 void setSOAPPacket(java.lang.String SOAPPacket)
          Full contents of the SOAP packet.
 void setTimeout(int timeout)
          A timeout for the component.
 void setURL(java.lang.String URL)
          The URL to fetch.
 void setUser(java.lang.String user)
          A user name if Basic authentication is to be used.
 void setUserAgent(java.lang.String userAgent)
          Information about the user agent.
 void setValueFormat(int valueFormat)
          Format of data returned or set.
 void setXPath(java.lang.String XPath)
          A path into the SOAPPacket received by the server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

soapIdle

public static final int soapIdle

soapSendRequest

public static final int soapSendRequest

soapReset

public static final int soapReset

soapBuildPacket

public static final int soapBuildPacket

soapSendPacket

public static final int soapSendPacket

soapEvalPacket

public static final int soapEvalPacket

fwNone

public static final int fwNone

fwTunnel

public static final int fwTunnel

fwSOCKS4

public static final int fwSOCKS4

fwSOCKS5

public static final int fwSOCKS5

vfText

public static final int vfText

vfXML

public static final int vfXML

vfFullXML

public static final int vfFullXML
Constructor Detail

Soap

public Soap()
Method Detail

getAction

public int getAction()
An action code for the component. Setting the Action property to a valid action code makes the control perform the associated action. If the action completes successfully, execution continues normally, and Action is reset to 0 (Idle). If an error happens, then an IPWorksException exception is raised.

The following are the possible values for the Action property and the corresponding descriptions:

soapIdle (0)
Default action. It can also be used to interrupt the current operation.
soapSendRequest (1)
Build a SOAP request based on the input provided by the control properties and send it to the remote host specified in URL . When a response is received, it is evaluated and output properties such as ReturnValue are updated accordingly.
soapReset (2)
Reset all parameters (recommended prior to sending a new request).
soapBuildPacket (3)
Build a SOAP request based on the input provided by the control properties and place it in the SOAPPacket property. This Action is useful for SOAP transactions that are ran over transports other than the included HTTP support.
soapSendPacket (4)
Send a SOAP request using the packet provided in SOAPPacket (the other input properties are disregarded). The response is evaluated as normal.
soapEvalPacket (5)
Evaluate the SOAP response provided in SOAPPacket . Properties such as ReturnValue are updated accordingly. This Action is useful for SOAP transactions that are ran over transports other than the included HTTP support.


setAction

public void setAction(int action)
               throws IPWorksException
An action code for the component. Setting the Action property to a valid action code makes the control perform the associated action. If the action completes successfully, execution continues normally, and Action is reset to 0 (Idle). If an error happens, then an IPWorksException exception is raised.

The following are the possible values for the Action property and the corresponding descriptions:

soapIdle (0)
Default action. It can also be used to interrupt the current operation.
soapSendRequest (1)
Build a SOAP request based on the input provided by the control properties and send it to the remote host specified in URL . When a response is received, it is evaluated and output properties such as ReturnValue are updated accordingly.
soapReset (2)
Reset all parameters (recommended prior to sending a new request).
soapBuildPacket (3)
Build a SOAP request based on the input provided by the control properties and place it in the SOAPPacket property. This Action is useful for SOAP transactions that are ran over transports other than the included HTTP support.
soapSendPacket (4)
Send a SOAP request using the packet provided in SOAPPacket (the other input properties are disregarded). The response is evaluated as normal.
soapEvalPacket (5)
Evaluate the SOAP response provided in SOAPPacket . Properties such as ReturnValue are updated accordingly. This Action is useful for SOAP transactions that are ran over transports other than the included HTTP support.


getActionURI

public java.lang.String getActionURI()
The value of the SOAP-Action header. When MethodURI and/or Method is set, ActionURI is automatically updated to MethodURI # Method .


setActionURI

public void setActionURI(java.lang.String actionURI)
                  throws IPWorksException
The value of the SOAP-Action header. When MethodURI and/or Method is set, ActionURI is automatically updated to MethodURI # Method .


getAuthorization

public java.lang.String getAuthorization()
The Authorization string to be sent to the server. If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.

If User and Password are specified, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".


setAuthorization

public void setAuthorization(java.lang.String authorization)
                      throws IPWorksException
The Authorization string to be sent to the server. If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.

If User and Password are specified, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".


isConnected

public boolean isConnected()
Shows whether the component is connected. Use this property to determine whether the control is connected to the remote host or not.


getContentType

public java.lang.String getContentType()
Content type for SOAP request data. The default value for ContentType is "text/xml".


setContentType

public void setContentType(java.lang.String contentType)
                    throws IPWorksException
Content type for SOAP request data. The default value for ContentType is "text/xml".


getCookieCount

public int getCookieCount()
Number of cookies in the current request. The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server.

The SetCookie event displays the cookies set by the server and their properties.


setCookieCount

public void setCookieCount(int cookieCount)
                    throws IPWorksException
Number of cookies in the current request. The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server.

The SetCookie event displays the cookies set by the server and their properties.


getCookieName

public java.lang.String getCookieName(int cookieIndex)
                               throws IPWorksException
Array of cookie names. The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


setCookieName

public void setCookieName(int cookieIndex,
                          java.lang.String cookieName)
                   throws IPWorksException
Array of cookie names. The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


getCookieValue

public java.lang.String getCookieValue(int cookieIndex)
                                throws IPWorksException
Array of cookie values. The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


setCookieValue

public void setCookieValue(int cookieIndex,
                           java.lang.String cookieValue)
                    throws IPWorksException
Array of cookie values. The size of the array is determined by the CookieCount property. Element indexes start at 1.

All cookies specified in the array are sent to URLServer when the URL is submitted.

The cookie arrays such as CookieName and CookieValue maintain the cookies sent to the server. The SetCookie event displays the cookies set by the server and their properties.


getFaultActor

public java.lang.String getFaultActor()
Actor of any faults returned by the SOAP server. FaultCode and FaultString provide the corresponding fault code and description.


getFaultCode

public java.lang.String getFaultCode()
Code of any faults returned by the SOAP server. FaultString and FaultActor provide the corresponding fault description and actor.


getFaultString

public java.lang.String getFaultString()
Textual description of any faults returned by the SOAP server. FaultCode and FaultActor provide the corresponding fault code and actor.


getFirewallData

public byte[] getFirewallData()
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


setFirewallData

public void setFirewallData(byte[] firewallData)
                     throws IPWorksException
Used to send other data to firewall. When the firewall is a tunneling proxy, use this property to to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).


getFirewallHost

public java.lang.String getFirewallHost()
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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


setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksException
Name or IP address of firewall (optional). If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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


getFirewallPassword

public java.lang.String getFirewallPassword()
A password if authentication is to be used 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, a trappable error is fired.


setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException
A password if authentication is to be used 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, a trappable error is fired.


getFirewallPort

public int getFirewallPort()
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksException
Port of the firewall to connect to. The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.


getFirewallType

public int getFirewallType()
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. 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.


setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksException
Determines the type of firewall to connect through. The applicable values are the following:
fwNone (0)
No firewall (default setting).
fwTunnel (1)
Connect through a tunneling proxy. 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.


getFirewallUser

public java.lang.String getFirewallUser()
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksException
A user name if authentication is to be used connecting through a firewall. if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.


getFlags

public int getFlags()
Flags controlling the behaviour of the parser. The following flags are currently defined:
0x0001
Ignore bad (unknown) attribute prefixes. Normally a trappable error is generated when an unknown attribute prefix is encountered. Setting this flag suppresses the error.
0x0002
Ignore bad (unknown) element prefixes. Normally a trappable error is generated when an unknown element prefix is encountered. Setting this flag suppresses the error.
More than one flag may be specified by OR-ing the values together.


setFlags

public void setFlags(int flags)
              throws IPWorksException
Flags controlling the behaviour of the parser. The following flags are currently defined:
0x0001
Ignore bad (unknown) attribute prefixes. Normally a trappable error is generated when an unknown attribute prefix is encountered. Setting this flag suppresses the error.
0x0002
Ignore bad (unknown) element prefixes. Normally a trappable error is generated when an unknown element prefix is encountered. Setting this flag suppresses the error.
More than one flag may be specified by OR-ing the values together.


getOtherHeaders

public java.lang.String getOtherHeaders()
Other headers as determined by the user (optional). The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

The OtherHeaders property is useful for extending the functionality of the control beyond what is provided.


setOtherHeaders

public void setOtherHeaders(java.lang.String otherHeaders)
                     throws IPWorksException
Other headers as determined by the user (optional). The OtherHeaders property contains a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

The OtherHeaders property is useful for extending the functionality of the control beyond what is provided.


getLocalHost

public java.lang.String getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock 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 value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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.


setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksException
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The LocalHost property contains the name of the local host as obtained by the gethostname() Winsock 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 value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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.


getMethod

public java.lang.String getMethod()
The remote Method . When MethodURI and/or Method is set, ActionURI property is automatically updated to MethodURI # Method .


setMethod

public void setMethod(java.lang.String method)
               throws IPWorksException
The remote Method . When MethodURI and/or Method is set, ActionURI property is automatically updated to MethodURI # Method .


getMethodURI

public java.lang.String getMethodURI()
The URI corresponding to the SOAP Method . When MethodURI and/or Method is set, ActionURI is automatically updated to MethodURI # Method .


setMethodURI

public void setMethodURI(java.lang.String methodURI)
                  throws IPWorksException
The URI corresponding to the SOAP Method . When MethodURI and/or Method is set, ActionURI is automatically updated to MethodURI # Method .


getNamespaceCount

public int getNamespaceCount()
The number of default Namespaces defined. This is the upper bound for the namespace arrays: Namespaces and Prefixes . Array indexes start at 1.

The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


getNamespaces

public java.lang.String getNamespaces(int namespaceIndex)
                               throws IPWorksException
The default Namespaces defined by the component. Array indexes start at 1 and end at NamespaceCount .

The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


setNamespaces

public void setNamespaces(int namespaceIndex,
                          java.lang.String namespaces)
                   throws IPWorksException
The default Namespaces defined by the component. Array indexes start at 1 and end at NamespaceCount .

The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


getParamAttr

public java.lang.String getParamAttr(int paramIndex)
                              throws IPWorksException
Extra attributes of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


setParamAttr

public void setParamAttr(int paramIndex,
                         java.lang.String paramAttr)
                  throws IPWorksException
Extra attributes of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


getParamCount

public int getParamCount()
The number of parameters sent to the remote host. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


setParamCount

public void setParamCount(int paramCount)
                   throws IPWorksException
The number of parameters sent to the remote host. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


getParamName

public java.lang.String getParamName(int paramIndex)
                              throws IPWorksException
The names of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


setParamName

public void setParamName(int paramIndex,
                         java.lang.String paramName)
                  throws IPWorksException
The names of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


getParamValue

public java.lang.String getParamValue(int paramIndex)
                               throws IPWorksException
The values of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


setParamValue

public void setParamValue(int paramIndex,
                          java.lang.String paramValue)
                   throws IPWorksException
The values of the Method parameters. ParamCount contains the upper bound of the 'Param' arrays: ParamName , ParamValue , and ParamAttr .

The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.


getPassword

public java.lang.String getPassword()
A password if Basic authentication is to be used. The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.


setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksException
A password if Basic authentication is to be used. The User and Password are Base64 encoded and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.


getPrefixes

public java.lang.String getPrefixes(int namespaceIndex)
                             throws IPWorksException
The prefixes corresponding to the default Namespaces defined by the component. Array indexes start at 1 and end at NamespaceCount .

The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


setPrefixes

public void setPrefixes(int namespaceIndex,
                        java.lang.String prefixes)
                 throws IPWorksException
The prefixes corresponding to the default Namespaces defined by the component. Array indexes start at 1 and end at NamespaceCount .

The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


getProxyAuthorization

public java.lang.String getProxyAuthorization()
Similar to the Authorization property, but for proxy authorization. If the Authorization property contains a non-empty string, a Prxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server.

If ProxyUser and ProxyPassword are specified, they are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".


setProxyAuthorization

public void setProxyAuthorization(java.lang.String proxyAuthorization)
                           throws IPWorksException
Similar to the Authorization property, but for proxy authorization. If the Authorization property contains a non-empty string, a Prxy-Authorization HTTP request header is added to the request. This header conveys proxy authorization information to the server.

If ProxyUser and ProxyPassword are specified, they are Base64 encoded, and the result is put in the ProxyAuthorization property in the form "Basic [encoded-proxyuser-proxypassword]".


getProxyPort

public int getProxyPort()
Port for the proxy server (default 80). The TCP port for the ProxyServer . See the description of the ProxyServer property for details.


setProxyPort

public void setProxyPort(int proxyPort)
                  throws IPWorksException
Port for the proxy server (default 80). The TCP port for the ProxyServer . See the description of the ProxyServer property for details.


getProxyServer

public java.lang.String getProxyServer()
Name or IP address of a proxy server (optional). If a ProxyServer is given, then the HTTP request is sent to the proxy instead of the server specified in the URL .

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and 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.


setProxyServer

public void setProxyServer(java.lang.String proxyServer)
                    throws IPWorksException
Name or IP address of a proxy server (optional). If a ProxyServer is given, then the HTTP request is sent to the proxy instead of the server specified in the URL .

If the ProxyServer property is set to a Domain Name, a DNS request is initiated and 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.


getReturnValue

public java.lang.String getReturnValue()
Value returned by the SOAP Method . ReturnValue corresponds to the first element of the ParamValue array (located at index 0).


getSOAPEncoding

public java.lang.String getSOAPEncoding()
The type of SOAP Encoding used for SOAP requests. This is the value of the 'encodingStyle' attribute of the SOAP envelope.


setSOAPEncoding

public void setSOAPEncoding(java.lang.String SOAPEncoding)
                     throws IPWorksException
The type of SOAP Encoding used for SOAP requests. This is the value of the 'encodingStyle' attribute of the SOAP envelope.


getSOAPHeader

public java.lang.String getSOAPHeader()
Contents of the optional SOAP header sent to the server. This property is used only while building SOAP requests.


setSOAPHeader

public void setSOAPHeader(java.lang.String SOAPHeader)
                   throws IPWorksException
Contents of the optional SOAP header sent to the server. This property is used only while building SOAP requests.


getSOAPPacket

public java.lang.String getSOAPPacket()
Full contents of the SOAP packet. The SOAPPacket property contains the contents of the SOAP packet created by the client before submitting a request, and the full, unmodified contents of the SOAP response as received by the server.


setSOAPPacket

public void setSOAPPacket(java.lang.String SOAPPacket)
                   throws IPWorksException
Full contents of the SOAP packet. The SOAPPacket property contains the contents of the SOAP packet created by the client before submitting a request, and the full, unmodified contents of the SOAP response as received by the server.


getStatusLine

public java.lang.String getStatusLine()
The first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when setting the Action property, the error string is the same as the StatusLine property.

The HTTP protocol specifies the structure of the StatusLine as: [HTTP version] [Result Code] [Description].


getTimeout

public int getTimeout()
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the component. If the Timeout property is set to 0 (default value) all actions will run uninterrupted until succesful completion, or an error condition is encountered.

If Timeout is set to a positive value, and any action does not complete within Timeout seconds, the action is aborted, and a 'Timeout' error is fired..

The control 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 always remains responsive.


getURL

public java.lang.String getURL()
The URL to fetch. The URL of the document. This value is parsed, and the results are put in the URLScheme , URLServer , URLPort , and URLPath properties.


setURL

public void setURL(java.lang.String URL)
            throws IPWorksException
The URL to fetch. The URL of the document. This value is parsed, and the results are put in the URLScheme , URLServer , URLPort , and URLPath properties.


getUser

public java.lang.String getUser()
A user name if Basic authentication is to be used. The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.


setUser

public void setUser(java.lang.String user)
             throws IPWorksException
A user name if Basic authentication is to be used. The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

The User and Password properties must be set only after the URL property is set. When the URL property is set, for security reasons, the User and Password properties are immediately cleared.


getUserAgent

public java.lang.String getUserAgent()
Information about the user agent. Override the default with the name and version of your software.


setUserAgent

public void setUserAgent(java.lang.String userAgent)
                  throws IPWorksException
Information about the user agent. Override the default with the name and version of your software.


getValueFormat

public int getValueFormat()
Format of data returned or set. The ValueFormat property specifies the format of the data set or received into/from value properties such as ParamValue , XText , and ReturnValue .

The following are the possible values:

vfText (0)
Textual data. Any '<', '>', and '&' characters are escaped to '<', '>', and '&'.
vfXML (1)
XML data. No escaping is performed.
vfFullXML (2)
Same as vfXML, but including the enclosing element.


setValueFormat

public void setValueFormat(int valueFormat)
                    throws IPWorksException
Format of data returned or set. The ValueFormat property specifies the format of the data set or received into/from value properties such as ParamValue , XText , and ReturnValue .

The following are the possible values:

vfText (0)
Textual data. Any '<', '>', and '&' characters are escaped to '<', '>', and '&'.
vfXML (1)
XML data. No escaping is performed.
vfFullXML (2)
Same as vfXML, but including the enclosing element.


getXAttrCount

public int getXAttrCount()
Size of attribute values array for the current element. The XAttrCount property provides the number of attributes for the current element.

The corresponding attribute names, prefixes, namespaces, and values are provided respectively via the XAttrName , XAttrPrefix , XAttrNamespace , and XAttrValue properties.


getXAttrName

public java.lang.String getXAttrName(int attrIndex)
                              throws IPWorksException
Array of attribute names for the current element. The XAttrName property provides the local names (without prefixes) of the attributes for the current element.

The attribute values are indexed in the array in the same order that they were found in the document. The indexes start at 1 and end at the number of attributes (provided by the XAttrCount property).

The corresponding attribute values, attribute prefixes, and namespaces are provided respectively via the XAttrValue , XAttrPrefix , and XAttrNamespace properties.


getXAttrNamespace

public java.lang.String getXAttrNamespace(int attrIndex)
                                   throws IPWorksException
Array of attribute namespaces for the current element. The XAttrNamespace property provides the namespaces of the attributes for the current element.

The attribute namespaces are indexed in the array in the same order that the attributes were found in the document. The indexes start at 1 and end at the number of attributes (provided by the XAttrCount property).

The corresponding attribute names, attribute prefixes, and values are provided respectively via the XAttrName , XAttrPrefix , and XAttrValue properties.


getXAttrPrefix

public java.lang.String getXAttrPrefix(int attrIndex)
                                throws IPWorksException
Array of attribute prefixes for the current element. The XAttrName property provides the prefixes of the attributes for the current element.

The attribute prefixes are indexed in the array in the same order that they were found in the document. The indexes start at 1 and end at the number of attributes (provided by the XAttrCount property). If an attribute does not have a prefix, this property is empty.

The corresponding attribute values, attribute names, and namespaces are provided respectively via the XAttrValue , XAttrName , and XAttrNamespace properties.


getXAttrValue

public java.lang.String getXAttrValue(int attrIndex)
                               throws IPWorksException
Array of attribute values for the current element. The XAttrValue property provides the values of the attributes for the current element.

The attribute values are indexed in the array in the same order that they were found in the document. The indexes start at 1 and end at the number of attributes (provided by the XAttrCount property).

The corresponding attribute names are provided via the XAttrName property.


getXChildren

public int getXChildren()
The number of children of the element pointed to by XPath . If the element is empty, XChildren is -1.


getXElement

public java.lang.String getXElement()
The name of the element pointed to by XPath . The corresponding prefix is provided by XPrefix .


getXNamespace

public java.lang.String getXNamespace()
The namespace of the element pointed to by XPath . The corresponding namespace prefix is provided by XPrefix .


getXParent

public java.lang.String getXParent()
The parent of the element pointed to by XPath . If XPath points to the top element, XParent is an empty string.


getXPath

public java.lang.String getXPath()
A path into the SOAPPacket received by the server. The syntax is a subset of the XPath language.

Use this property to look at details of the SOAPPacket received by the server.


setXPath

public void setXPath(java.lang.String XPath)
              throws IPWorksException
A path into the SOAPPacket received by the server. The syntax is a subset of the XPath language.

Use this property to look at details of the SOAPPacket received by the server.


getXPrefix

public java.lang.String getXPrefix()
The prefix of the element pointed to by XPath . The corresponding element name is provided by XElement .


getXText

public java.lang.String getXText()
The text of the element pointed to by XPath . The ValueFormat property controls the format in which the value is returned.


fireConnected

public void fireConnected(int statusCode,
                          java.lang.String description)
Fired immediately after a connection completes (or fails). (Called internally to dispatch the event.)
See Also:
SoapConnectedEvent

fireDisconnected

public void fireDisconnected(int statusCode,
                             java.lang.String description)
Fired when a connection is closed. (Called internally to dispatch the event.)
See Also:
SoapDisconnectedEvent

fireEndTransfer

public void fireEndTransfer()
Fired when a document finishes transferring. (Called internally to dispatch the event.)
See Also:
SoapEndTransferEvent

fireError

public void fireError(int errorCode,
                      java.lang.String description)
Information about errors during data delivery. (Called internally to dispatch the event.)
See Also:
SoapErrorEvent

fireHeader

public void fireHeader(java.lang.String field,
                       java.lang.String value)
Fired every time a header line comes in. (Called internally to dispatch the event.)
See Also:
SoapHeaderEvent

fireSetCookie

public void fireSetCookie(java.lang.String name,
                          java.lang.String value,
                          java.lang.String expires,
                          java.lang.String domain,
                          java.lang.String path,
                          boolean secure)
Fired for every cookie set by the server. (Called internally to dispatch the event.)
See Also:
SoapSetCookieEvent

fireStartTransfer

public void fireStartTransfer()
Fired when a document starts transferring (after the headers). (Called internally to dispatch the event.)
See Also:
SoapStartTransferEvent

fireTransfer

public void fireTransfer(int bytesTransferred)
Fired while the response transfers. (Called internally to dispatch the event.)
See Also:
SoapTransferEvent

addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksException
Sets a cookie and the corresponding value. Please refer to the CookieName and CookieValue properties for more information on cookies and how they are managed.


addParam

public void addParam(java.lang.String paramName,
                     java.lang.String paramValue)
              throws IPWorksException
Adds a parameter-value pair. Please refer to the ParamName and ParamValue properties for more information on SOAP parameters and how they are managed.


buildPacket

public void buildPacket()
                 throws IPWorksException
Build the request packet and place it in SOAPPacket . Calling this method is equivalent to setting the Action property to soapBuildPacket .


evalPacket

public void evalPacket()
                throws IPWorksException
Evaluate the packet in SOAPPacket . Calling this method is equivalent to setting the Action property to soapEvalPacket .


interrupt

public void interrupt()
               throws IPWorksException
Interrupt the Action in progress (if any). Calling this method is equivalent to setting the Action property to Idle (0) .


reset

public void reset()
           throws IPWorksException
Reset. Calling this method is equivalent to setting the Action property to soapReset .


sendPacket

public void sendPacket()
                throws IPWorksException
Send the packet. Calling this method is equivalent to setting the Action property to soapSendPacket .


sendRequest

public void sendRequest()
                 throws IPWorksException
Send the request. Calling this method is equivalent to setting the Action property to soapSendRequest .


addSoapEventListener

public void addSoapEventListener(SoapEventListener l)
                          throws java.util.TooManyListenersException

removeSoapEventListener

public void removeSoapEventListener(SoapEventListener l)

IP*Works!

Copyright (c) 2001 /n software inc. - All rights reserved.