IP*Works! V6

ipworks
Class Soap

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

public class Soap
extends java.lang.Object

The SOAP bean is used to communicate with SOAP servers.

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

The bean 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 ParamName and ParamValue properties. Then set the target URL and call the SendRequest method.

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 will provide information about the error condition.

The bean 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 bean 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 .


Field Summary
static int authBasic
           
static int authDigest
           
static int frAlways
           
static int frNever
           
static int frSameScheme
           
static int fwNone
           
static int fwSOCKS4
           
static int fwSOCKS5
           
static int fwTunnel
           
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 addNamespace(java.lang.String prefix, java.lang.String namespaceURI)
          Adds a namespace to the Namespaces array.
 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.
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a beanconfiguration setting.
 void doEvents()
          Processes events from the internal message queue.
 void evalPacket()
          Evaluate the packet in SOAPPacket .
 java.lang.String getAccept()
          A list of acceptable MIME types for the request.
 java.lang.String getActionURI()
          The value of the SOAP-Action header.
 java.lang.String getAuthorization()
          The Authorization string to be sent to the server.
 int getAuthScheme()
          The authorization scheme to be used when server authorization is to be performed.
 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.
 java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).
 java.lang.String getFirewallPassword()
          A password if authentication is to be used when 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 getFollowRedirects()
          Determines what happens when the server issues a redirect.
 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 bean.
 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 authentication is to be used.
 java.lang.String getPragma()
          A browser/server specific header line (optional).
 java.lang.String getPrefixes(int namespaceIndex)
          The prefixes corresponding to the default Namespaces defined by the bean.
 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 getReferer()
          Referer URL/document (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 bean.
 java.lang.String getURL()
          The URL to fetch.
 java.lang.String getUser()
          A user name if authentication is to be used.
 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 current method.
 boolean isConnected()
          Shows whether the bean is connected.
 boolean isIdle()
          The current status of the component.
 void removeSoapEventListener(SoapEventListener l)
           
 void reset()
          Reset the bean.
 void sendPacket()
          Send the packet.
 void sendRequest()
          Send the request.
 void setAccept(java.lang.String accept)
          A list of acceptable MIME types for the request.
 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 setAuthScheme(int authScheme)
          The authorization scheme to be used when server authorization is to be performed.
 void setConnected(boolean connected)
          Shows whether the bean is connected.
 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 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 when 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 setFollowRedirects(int followRedirects)
          Determines what happens when the server issues a redirect.
 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 setNamespaceCount(int namespaceCount)
          The number of default Namespaces defined.
 void setNamespaces(int namespaceIndex, java.lang.String namespaces)
          The default Namespaces defined by the bean.
 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 authentication is to be used.
 void setPragma(java.lang.String pragma)
          A browser/server specific header line (optional).
 void setPrefixes(int namespaceIndex, java.lang.String prefixes)
          The prefixes corresponding to the default Namespaces defined by the bean.
 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 setReferer(java.lang.String referer)
          Referer URL/document (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 bean.
 void setURL(java.lang.String URL)
          The URL to fetch.
 void setUser(java.lang.String user)
          A user name if authentication is to be used.
 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.
 java.lang.String value(java.lang.String paramName)
          Returns the value of a parameter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

authBasic

public static final int authBasic
See Also:
Constant Field Values

authDigest

public static final int authDigest
See Also:
Constant Field Values

fwNone

public static final int fwNone
See Also:
Constant Field Values

fwTunnel

public static final int fwTunnel
See Also:
Constant Field Values

fwSOCKS4

public static final int fwSOCKS4
See Also:
Constant Field Values

fwSOCKS5

public static final int fwSOCKS5
See Also:
Constant Field Values

frNever

public static final int frNever
See Also:
Constant Field Values

frAlways

public static final int frAlways
See Also:
Constant Field Values

frSameScheme

public static final int frSameScheme
See Also:
Constant Field Values

vfText

public static final int vfText
See Also:
Constant Field Values

vfXML

public static final int vfXML
See Also:
Constant Field Values

vfFullXML

public static final int vfFullXML
See Also:
Constant Field Values
Constructor Detail

Soap

public Soap()
Method Detail

getAccept

public java.lang.String getAccept()
A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.


setAccept

public void setAccept(java.lang.String accept)
               throws IPWorksException
A list of acceptable MIME types for the request.

If the Accept property contains a non-empty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It consists of a comma-separated list of acceptable MIME types.

IPWorksException

getActionURI

public java.lang.String getActionURI()
The value of the SOAP-Action header.

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .


setActionURI

public void setActionURI(java.lang.String actionURI)
                  throws IPWorksException
The value of the SOAP-Action header.

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .

IPWorksException

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 bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

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]".


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 bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

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]".

IPWorksException

getAuthScheme

public int getAuthScheme()
The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

For security reasons, setting this property will clear the values of User and Password .


setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException
The authorization scheme to be used when server authorization is to be performed.

Use the AuthScheme property to tell the bean which type of authorization to perform when the User and Password properties are set.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the bean will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

For security reasons, setting this property will clear the values of User and Password .

IPWorksException

isConnected

public boolean isConnected()
Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.


setConnected

public void setConnected(boolean connected)
                  throws IPWorksException
Shows whether the bean is connected.

Use this property to determine whether the bean is connected to the remote host or not.

IPWorksException

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".

IPWorksException

getCookieCount

public int getCookieCount()
Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be 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 CookieName and CookieValue store the cookies that are to be sent to the server.

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

IPWorksException

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 CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

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 CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

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 CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

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 CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksException

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.


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. 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. 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.

IPWorksException

getFirewallPassword

public java.lang.String getFirewallPassword()
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, a trappable error is fired.


setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksException
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, a trappable error is fired.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

getFollowRedirects

public int getFollowRedirects()
Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), 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 frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.


setFollowRedirects

public void setFollowRedirects(int followRedirects)
                        throws IPWorksException
Determines what happens when the server issues a redirect.

Normally, the bean returns an error if the server responds with an "Object Moved" message. If FollowRedirects is set to frAlways (1) the new URL for the object is retrieved automatically every time.

If FollowRedirects is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same, otherwise the bean throws an IPWorksException raises an IPWorksException exception .

Note that following the HTTP specification, unless FollowRedirects is set to frAlways (1), automatic redirects will be performed only for 'GET' or 'HEAD' requests. Other methods could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than the existing one, User and Password are also reset to empty, unless FollowRedirects is set to frAlways (1), 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 frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

IPWorksException

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 specifications. 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 bean 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 specifications. 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 bean beyond what is provided.

IPWorksException

isIdle

public boolean isIdle()
The current status of the component.

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.


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() 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 value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean 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() 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 value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

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

IPWorksException

getMethod

public java.lang.String getMethod()
The remote Method .

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .


setMethod

public void setMethod(java.lang.String method)
               throws IPWorksException
The remote Method .

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .

IPWorksException

getMethodURI

public java.lang.String getMethodURI()
The URI corresponding to the SOAP Method .

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .


setMethodURI

public void setMethodURI(java.lang.String methodURI)
                  throws IPWorksException
The URI corresponding to the SOAP Method .

When the MethodURI or Method properties are set, the ActionURI property is automatically updated to MethodURI # Method .

IPWorksException

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 bean is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.


setNamespaceCount

public void setNamespaceCount(int namespaceCount)
                       throws IPWorksException
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 bean is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.

IPWorksException

getNamespaces

public java.lang.String getNamespaces(int namespaceIndex)
                               throws IPWorksException
The default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksException

setNamespaces

public void setNamespaces(int namespaceIndex,
                          java.lang.String namespaces)
                   throws IPWorksException
The default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

getPassword

public java.lang.String getPassword()
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 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.

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 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.

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.

IPWorksException

getPragma

public java.lang.String getPragma()
A browser/server specific header line (optional).

If the Pragma property contains a non-empty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation and can be used to send/receive proprietary information to/from the server.


setPragma

public void setPragma(java.lang.String pragma)
               throws IPWorksException
A browser/server specific header line (optional).

If the Pragma property contains a non-empty string, a Pragma HTTP request header is added to the request. The meaning of the header depends on the implementation and can be used to send/receive proprietary information to/from the server.

IPWorksException

getPrefixes

public java.lang.String getPrefixes(int namespaceIndex)
                             throws IPWorksException
The prefixes corresponding to the default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksException

setPrefixes

public void setPrefixes(int namespaceIndex,
                        java.lang.String prefixes)
                 throws IPWorksException
The prefixes corresponding to the default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksException

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 Proxy-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 Proxy-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]".

IPWorksException

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.

IPWorksException

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.

IPWorksException

getReferer

public java.lang.String getReferer()
Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.


setReferer

public void setReferer(java.lang.String referer)
                throws IPWorksException
Referer URL/document (optional).

If the Referer property contains a non-empty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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 component before submitting a request, and the full, unmodified contents of the SOAP response as received from the server after the request.


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 component before submitting a request, and the full, unmodified contents of the SOAP response as received from the server after the request.

IPWorksException

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 calling a method of the bean, 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 bean.

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 bean will wait for the operation to complete before returning control.

The bean 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 bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).


setTimeout

public void setTimeout(int timeout)
                throws IPWorksException
A timeout for the bean.

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 bean will wait for the operation to complete before returning control.

The bean 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 bean throws an IPWorksException raises an IPWorksException exception .

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the bean may be changed to absolute timeouts , i.e. the bean will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by theAbsoluteTimeoutconfiguration setting.

The default value for the Timeout property is 60 (seconds).

IPWorksException

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.

IPWorksException

getUser

public java.lang.String getUser()
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.

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 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.

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.

IPWorksException

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 '&lt;', '&gt;', and '&amp;'.
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 '&lt;', '&gt;', and '&amp;'.
vfXML (1)
XML data. No escaping is performed.
vfFullXML (2)
Same as vfXML, but including the enclosing element.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

IPWorksException

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.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'
A particular element name.
[i]
The i-th subelement of the current element.
..
the parent of the current element.
When XPath is set to a valid path, XElement points to the name of the element, with XParent , XNamespace , XPrefix , XChildren , and XText providing other properties of the element. The attribute arrays ( AttrName , AttrValue , AttrNamespace , etc..) provide the attributes of the current element.

Example (Setting XPath)

 
 
Document root
SOAPControl.XPath = "/"
Specific Element
SOAPControl.XPath = "/Envelope/Body/MyMethod"
i-th Child
SOAPControl.XPath = "/Envelope/Body/[i]"


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.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

'name'
A particular element name.
[i]
The i-th subelement of the current element.
..
the parent of the current element.
When XPath is set to a valid path, XElement points to the name of the element, with XParent , XNamespace , XPrefix , XChildren , and XText providing other properties of the element. The attribute arrays ( AttrName , AttrValue , AttrNamespace , etc..) provide the attributes of the current element.

Example (Setting XPath)

 
 
Document root
SOAPControl.XPath = "/"
Specific Element
SOAPControl.XPath = "/Envelope/Body/MyMethod"
i-th Child
SOAPControl.XPath = "/Envelope/Body/[i]"

IPWorksException

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.


config

public java.lang.String config(java.lang.String configurationString)
                        throws IPWorksException
Sets or retrieves a beanconfiguration setting.

Config is a generic method available in every bean. It is used to set and retrieveconfiguration settingsfor the bean.

Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the bean, 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.

IPWorksException

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.

IPWorksException

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.String namespaceURI)
                  throws IPWorksException
Adds a namespace to the Namespaces array.

Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

IPWorksException

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.

Example (Send SOAP Request)

 SOAPControl.Reset()
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.MethodURI = "methoduri"
 SOAPControl.Method = "methodname"
 SOAPControl.URL = "endpointURL"
 SOAPControl.SendRequest() 

IPWorksException

buildPacket

public void buildPacket()
                 throws IPWorksException
Build the request packet.

The resulting packet is placed in SOAPPacket .

IPWorksException

doEvents

public void doEvents()
              throws IPWorksException
Processes events from the internal message queue.

When DoEvents is called, the bean processes any available events. If no events are available, it waits for a preset period of time, and then returns.

IPWorksException

evalPacket

public void evalPacket()
                throws IPWorksException
Evaluate the packet in SOAPPacket .

Use this method to evaluate SOAP packets received through other means (i.e. not directly through the bean).

IPWorksException

interrupt

public void interrupt()
               throws IPWorksException
Interrupt the current method.

If there is no method in progress, Interrupt simply returns doing nothing.

IPWorksException

reset

public void reset()
           throws IPWorksException
Reset the bean.

Calling this method also resets all HTTP headers to their default values.

IPWorksException

sendPacket

public void sendPacket()
                throws IPWorksException
Send the packet.

This method may also be used to send a packet placed in SOAPPacket .

Example (Send SOAP Request)

 SOAPControl.Reset()
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.MethodURI = "methoduri"
 SOAPControl.Method = "methodname"
 SOAPControl.URL = "endpointURL"
 SOAPControl.BuildPacket()
 SOAPControl.SendPacket()
 SOAPControl.EvalPacket() 

IPWorksException

sendRequest

public void sendRequest()
                 throws IPWorksException
Send the request.

Calling this method is equivalent to calling BuildPacket , SendPacket , and EvalPacket in succession.

Example (Send SOAP Request)

 SOAPControl.Reset()
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.AddParam("paramname", "paramvalue")
 SOAPControl.MethodURI = "methoduri"
 SOAPControl.Method = "methodname"
 SOAPControl.URL = "endpointURL"
 SOAPControl.SendRequest() 

IPWorksException

value

public java.lang.String value(java.lang.String paramName)
                       throws IPWorksException
Returns the value of a parameter.

The bean will search through the parameter array for the parameter identified by ParamName and will return the value associated with it. Calling Value is equivalent to searching through the ParamName array to get the matching parameter index, then looking up the value at the index in ParamValue .

IPWorksException

addSoapEventListener

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

removeSoapEventListener

public void removeSoapEventListener(SoapEventListener l)

IP*Works! V6

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