IP*Works! V9

ipworks
Class Soap

java.lang.Object
  extended by 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 Params collection . Then set the target URL and call the SendRequest method.

The results will be provided through the ReturnValue property and the Params collection (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 authNegotiate
           
static int authNone
           
static int authNtlm
           
static int authOAuth
           
static int authProprietary
           
static int frAlways
           
static int frNever
           
static int frSameScheme
           
static int vfFullXML
           
static int vfText
           
static int vfXML
           
 
Constructor Summary
Soap()
          Creates an instance of Soap Bean.
Soap(java.lang.String runtimeLicense)
          Creates an instance of Soap Bean with specified run-time license.
 
Method Summary
 void addCookie(java.lang.String cookieName, java.lang.String cookieValue)
          Adds a cookie and the corresponding value to the outgoing request headers.
 void addNamespace(java.lang.String prefix, java.lang.String namespaceURI)
          Adds a namespace to the Namespaces collection .
 void addParam(java.lang.String paramName, java.lang.String paramValue)
          Adds a parameter-value pair.
 void addSoapEventListener(SoapEventListener l)
           
 java.lang.String attr(java.lang.String attrName)
          Returns the value of the specified attribute.
 void buildPacket()
          Build the request packet.
 java.lang.String config(java.lang.String configurationString)
          Sets or retrieves a configuration 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 authentication scheme to use when server authorization is required.
 java.lang.String getContentType()
          Content type for SOAP request data.
 HTTPCookieList getCookies()
          Collection of cookies.
 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.
 Firewall getFirewall()
          A set of properties related to firewall access.
 int getFollowRedirects()
          Determines what happens when the server issues a redirect.
 java.lang.String getIfModifiedSince()
          A date determining the maximum age of the desired document.
 java.lang.String getLocalFile()
          The path to a local file for downloading.
 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 .
 XMLNamespaceList getNamespaces()
          A collection of namespaces in the current stack.
 java.lang.String getOtherHeaders()
          Other headers as determined by the user (optional).
 SOAPParamList getParams()
          A collection of parameters for the SOAP Method .
 HeaderList getParsedHeaders()
          Collection of headers returned from the last request.
 java.lang.String getPassword()
          A password if authentication is to be used.
 java.lang.String getPragma()
          A browser/server specific header line (optional).
 Proxy getProxy()
          A set of properties related to proxy access.
 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.
 byte[] getTransferredData()
          The contents of the last response from the server.
 long getTransferredDataLimit()
          The maximum of data to be transferred.
 java.lang.String getTransferredHeaders()
          The full set of headers as received from the server.
 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.
 XMLAttributeList getXAttributes()
          A collection of attributes of 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 .
 boolean hasXPath(java.lang.String xpath)
          Determines whether a specific element exists in the document.
 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 authentication scheme to use when server authorization is required.
 void setConnected(boolean connected)
          Shows whether the bean is connected.
 void setContentType(java.lang.String contentType)
          Content type for SOAP request data.
 void setFirewall(Firewall firewall)
          A set of properties related to firewall access.
 void setFollowRedirects(int followRedirects)
          Determines what happens when the server issues a redirect.
 void setIfModifiedSince(java.lang.String ifModifiedSince)
          A date determining the maximum age of the desired document.
 void setLocalFile(java.lang.String localFile)
          The path to a local file for downloading.
 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 setOtherHeaders(java.lang.String otherHeaders)
          Other headers as determined by the user (optional).
 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 setProxy(Proxy proxy)
          A set of properties related to proxy access.
 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 setTransferredDataLimit(long transferredDataLimit)
          The maximum of data to be transferred.
 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

authProprietary

public static final int authProprietary
See Also:
Constant Field Values

authNone

public static final int authNone
See Also:
Constant Field Values

authNtlm

public static final int authNtlm
See Also:
Constant Field Values

authNegotiate

public static final int authNegotiate
See Also:
Constant Field Values

authOAuth

public static final int authOAuth
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()
Creates an instance of Soap Bean.


Soap

public Soap(java.lang.String runtimeLicense)
Creates an instance of Soap Bean with specified run-time license.

Method Detail

getAccept

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

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

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.


setAccept

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

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

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

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

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

A common use for this property is to specify OAuth authorization string.

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.

A common use for this property is to specify OAuth authorization string.

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

Throws:
IPWorksException

getAuthScheme

public int getAuthScheme()
The authentication scheme to use when server authorization is required.

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

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property 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), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the bean to clear the values of User , Password and Authorization .


setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksException
The authentication scheme to use when server authorization is required.

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

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property 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), authNtlm (4) or authNegotiate (5), digest, NTLM or Negotiate authentication will be attempted instead.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property.

If AuthScheme is set to authOAuth (6) then the authorization string must be supplied through Authorization property.

Note that, if you set the Authorization property and AuthScheme is not authProprietary or authOAuth, the AuthScheme will be set automatically to authProprietary (2) by the control.

For security purposes, changing the value of this property will cause the bean to clear the values of User , Password and Authorization .

Throws:
IPWorksException

isConnected

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

This property is used to determine whether or not the bean is connected to the remote host.


setConnected

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

This property is used to determine whether or not the bean is connected to the remote host.

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

Throws:
IPWorksException

getCookies

public HTTPCookieList getCookies()
Collection of cookies.

This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type httpcookie ) to this collection.

To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies are also added to Cookies .

MaxHTTPCookies can be used to control the maximum number of cookies saved.

This collection is indexed from 0 to size - 1.


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.


getFirewall

public Firewall getFirewall()
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.


setFirewall

public void setFirewall(Firewall firewall)
                 throws IPWorksException
A set of properties related to firewall access.

This is a Firewall type property which contains fields describing the firewall through which the bean will attempt to connect.

Throws:
IPWorksException

getFollowRedirects

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

This property 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 this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

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

Note that following the HTTP specification, unless this property 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 this property 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 the bean throws an exception instead.


setFollowRedirects

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

This property 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 this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

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

Note that following the HTTP specification, unless this property 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 this property 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 the bean throws an exception instead.

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


getIfModifiedSince

public java.lang.String getIfModifiedSince()
A date determining the maximum age of the desired document.

If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.


setIfModifiedSince

public void setIfModifiedSince(java.lang.String ifModifiedSince)
                        throws IPWorksException
A date determining the maximum age of the desired document.

If this property contains a non-empty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the bean throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

Throws:
IPWorksException

getLocalFile

public java.lang.String getLocalFile()
The path to a local file for downloading. If the file exists, it is overwritten.

This property is used when getting a document.

If this property is empty then the received data is provided through TransferredData and the Transfer event.


setLocalFile

public void setLocalFile(java.lang.String localFile)
                  throws IPWorksException
The path to a local file for downloading. If the file exists, it is overwritten.

This property is used when getting a document.

If this property is empty then the received data is provided through TransferredData and the Transfer event.

Throws:
IPWorksException

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

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

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

Throws:
IPWorksException

getNamespaces

public XMLNamespaceList getNamespaces()
A collection of namespaces in the current stack.

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

If the SOAP Envelope URI is not found in the namespaces collection, it will be added with the prefix 'SOAP-ENV' when generating a SOAP request. The SOAP Envelope URI is 'http://schemas.xmlsoap.org/soap/envelope/'.

This collection is indexed from 0 to size - 1.


getOtherHeaders

public java.lang.String getOtherHeaders()
Other headers as determined by the user (optional).

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

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

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType , From , etc.

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

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

This property is useful for extending the functionality of the bean beyond what is provided.

Throws:
IPWorksException

getParams

public SOAPParamList getParams()
A collection of parameters for the SOAP Method .

When using SendRequest , this property can be populated with the parameters to include in the request to the SOAP Method .

When receiving SOAP responses from the server, the component parses the response envelope parameters into the collection.

This collection is indexed from 0 to size - 1.


getParsedHeaders

public HeaderList getParsedHeaders()
Collection of headers returned from the last request.

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This collection is indexed from 0 to size - 1.


getPassword

public java.lang.String getPassword()
A password if authentication is to be used.

This property contains 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 config setting 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.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the bean will attempt to authenticate using the current user's credentials.


setPassword

public void setPassword(java.lang.String password)
                 throws IPWorksException
A password if authentication is to be used.

This property contains 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 config setting 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.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:
IPWorksException

getPragma

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

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

Throws:
IPWorksException

getProxy

public Proxy getProxy()
A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.


setProxy

public void setProxy(Proxy proxy)
              throws IPWorksException
A set of properties related to proxy access.

This property contains fields describing the proxy through which the bean will attempt to connect.

Throws:
IPWorksException

getReferer

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

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

Throws:
IPWorksException

getReturnValue

public java.lang.String getReturnValue()
Value returned by the SOAP Method .

ReturnValue corresponds to the first item in the Params collection .


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.

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

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

Throws:
IPWorksException

getStatusLine

public java.lang.String getStatusLine()
The first line of the last server response.

This property contains 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 exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of 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 the AbsoluteTimeout configuration 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 exception.

Please note that by default, all timeouts are inactivity timeouts , i.e. the timeout period is extended by Timeout seconds when any amount of 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 the AbsoluteTimeout configuration setting.

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

Throws:
IPWorksException

getTransferredData

public byte[] getTransferredData()
The contents of the last response from the server.

This property contains the contents of the last response from the server. If the LocalFile is empty, the data is accumulated in TransferredData , and can also be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).


getTransferredDataLimit

public long getTransferredDataLimit()
The maximum of data to be transferred.

This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.


setTransferredDataLimit

public void setTransferredDataLimit(long transferredDataLimit)
                             throws IPWorksException
The maximum of data to be transferred.

This property contains the maximum of data to be transferred. The default value is 0, which will not impose any limits on the amount of data accumulated in the TransferredData property.

Throws:
IPWorksException

getTransferredHeaders

public java.lang.String getTransferredHeaders()
The full set of headers as received from the server.

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the bean.


getURL

public java.lang.String getURL()
The URL to fetch.

This property contains 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.

This property contains the URL of the document. This value is parsed, and the results are put in the URLScheme , URLServer , URLPort , and URLPath properties.

Throws:
IPWorksException

getUser

public java.lang.String getUser()
A user name if authentication is to be used.

This property contains 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.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the bean will attempt to authenticate using the current user's credentials.


setUser

public void setUser(java.lang.String user)
             throws IPWorksException
A user name if authentication is to be used.

This property contains 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.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the bean will attempt to authenticate using the current user's credentials.

Throws:
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 XText , ReturnValue , and the Params collection .

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 XText , ReturnValue , and the Params collection .

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.

Throws:
IPWorksException

getXAttributes

public XMLAttributeList getXAttributes()
A collection of attributes of the current element.

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of xmlattribute types.

This collection is indexed from 0 to size - 1.


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.

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


addCookie

public void addCookie(java.lang.String cookieName,
                      java.lang.String cookieValue)
               throws IPWorksException
Adds a cookie and the corresponding value to the outgoing request headers.

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

Throws:
IPWorksException

addNamespace

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

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

Throws:
IPWorksException

addParam

public void addParam(java.lang.String paramName,
                     java.lang.String paramValue)
              throws IPWorksException
Adds a parameter-value pair.

Please refer to the parameter name and value provided in the Params collection 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() 
Example (Send SOAP Request using Params collection)
 SOAPControl.Reset()
 SOAPControl.Params.Add(New SOAPParam("paramname", "paramvalue"))
 SOAPControl.Params.Add(New SOAPParam("paramname", "paramvalue"))
 SOAPControl.MethodURI = "methoduri"
 SOAPControl.Method = "methodname"
 SOAPControl.URL = "endpointURL"
 SOAPControl.SendRequest() 

Throws:
IPWorksException

attr

public java.lang.String attr(java.lang.String attrName)
                      throws IPWorksException
Returns the value of the specified attribute.

If the attribute does not exist, an empty string is returned if ErrorOnEmptyAttr is set to false, otherwise an exception is thrown.

Please refer to the XAttributes collection for more information.

Throws:
IPWorksException

buildPacket

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

The resulting packet is placed in SOAPPacket .

Throws:
IPWorksException

config

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

Config is a generic method available in every bean. It is used to set and retrieve configuration settings for 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.

The bean accepts one or more of the following configuration settings . 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.

SOAP Configuration Settings

EncodingStyleNamespacePrefix
The prefix to be used for the Encoding namespace
It should not matter what this prefix is set to, but some servers seem to be picky; so feel free to use a value that is acceptable.
MethodNamespacePrefix
The prefix to be used for the Method namespace
By default, the component assumes you're consuming an RPC service and sets its method namespace prefix to "m". If you need to change this, you can set the MethodNamespacePrefix configuration setting. If your service is a SoapDocument service and you need to use no prefix at all, you can set the MethodNamespacePrefix configuration setting to empty string.
MethodAttributes
The attributes to include in the method element
When forming the SOAP packet the bean will include the value specified here as an attribute of the method element. This is empty string by default and no attributes will be included. When specifying an attribute to be included the attribute should be surrounded by quotes. For instance:
 SOAP1.Config("MethodAttributes=\\"<your value>\\""); 
RequestPacket
The SOAP packet that was sent to the server during the last request
Accessing the RequestPacket configuration allows a user to view the raw SOAP packet that was sent to the server during the last request.
XSubTree
A snapshot of the current element in the document
The current element is specified via the XPath property. You may then query this setting.

HTTP Configuration Settings

AcceptEncoding
Used to tell the server which types of content encodings the client supports
When AllowHTTPCompression is true, the bean adds an "Accept-Encoding: " header to the request being sent to the server. By default, this header's value is "gzip, deflate". This config allows you to change the value of the "Accept-Encoding" header. NOTE: The bean only supports gzip and deflate decompression algorithms.
AllowHTTPCompression
This property enables HTTP compression for receiving data
This is the same as the AllowHTTPCompression property. This setting is exposed here for use by beans that inherit from HTTP.
Authorization
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]".

BytesTransferred
Contains the number of bytes transferred in the response data
Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred .
EncodeURL
If set to true the URL will be encoded by the bean
The default value is false. If set to true the URL passed to the bean will be URL encoded.
GetOn302Redirect
If set to true the bean will perform a GET on the new location
The default value is false. If set to true the bean will perform a GET on the new location. Otherwise it will use the same HTTP method again.
HTTPVersion
The version of HTTP used by the bean
Possible values include "1.0", and "1.1". The default is "1.1".
IfModifiedSince
A date determining the maximum age of the desired document
This is the same as the IfModifiedSince property. This setting is exposed here for use by beans that inherit from HTTP.
KeepAlive
Determines whether the HTTP connection is closed after completion of the request
If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. If false, the connection will be closed immediately after the server response is received.The default value for KeepAlive is false.

MaxHeaders
Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired
This config should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxHTTPCookies
Instructs bean to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
This config should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection .To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

NOTE: This functionality is only available in Java and .NET.

MaxRedirectAttempts
Limits the number of redirects that are followed in a request
When FollowRedirects is set to any value besides frNever the bean will follow redirects until this maximum number of redirect attempts are made. The default value is 20. \011
ProxyAuthorization
The authorization string to be sent to the proxy server
Similar to the Authorization config, but for proxy authorization. If this config 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 User and Password are specified, this value is calculated using the algorithm specified by AuthScheme .
ProxyAuthScheme
The authorization scheme to be used for the proxy
This is the same as AuthScheme . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyPassword
A password if authentication is to be used for the proxy
This is the same as Password . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyPort
Port for the proxy server (default 80)
This is the same as Port . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyServer
Name or IP address of a proxy server (optional)
This is the same as Server . This setting is provided for use by beans that do not directly expose Proxy properties.
ProxyUser
A user name if authentication is to be used for the proxy
This is the same as User . This setting is provided for use by beans that do not directly expose Proxy properties.
TransferredDataLimit
The maximum number of incoming bytes to be stored by the bean
The default value is 65,536, allowing the bean to accumulate the first 64K of data into the TransferredData buffer.If TransferredDataLimit is set to 0, no limits are imposed.

UseChunkedEncoding
Enables or Disables HTTP chunked encoding for transfers
If UseChunkedEncoding is set to true, the bean will use HTTP chunked encoding when posting if possible. HTTP chunked encoding allows large files to be sent in chunks instead of all at once. If set to false, the bean will not use HTTP chunked encoding. The default value is false. Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

ChunkSize
Specifies the chunk size in bytes when using chunked encoding
This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.
UsePlatformHTTPClient
Whether or not to use the platform HTTP client
If True, the component will use the default HTTP client for the platform ( URLConnection in Java or WebRequest in .NET) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).
UserAgent
Information about the user agent (browser)
This is the value supplied in the HTTP User-Agent header. The default setting is "/n software IPWorks HTTP/S Component - www.nsoftware.com".Override the default with the name and version of your software.

KerberosSPN
The Service Principal Name for the Kerberos Domain Controller
If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

IPPort Configuration Settings

FirewallAutoDetect
Tells the bean whether or not to automatically detect and use firewall system settings, if available
This is the same as AutoDetect . This setting is provided for use by beans that do not directly expose Firewall properties.
FirewallHost
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 setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This is the same as Host . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallListener
If true, the component binds to a SOCKS firewall as a server (IPPort only)
This entry is for IPPort only and does not work for other components that descend from IPPort.If this entry is set, the bean acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost , and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword
Password to be used if authentication is to be used when connecting through the firewall
If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as Password . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallPort
The TCP port for the FirewallHost;
Note that the FirewallPort is set automatically when FirewallType is set to a valid value.NOTE: This is the same as Port . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallType
Determines the type of firewall to connect through
The appropriate values are as follows:
0
No firewall (default setting).
1
Connect through a tunneling proxy. FirewallPort is set to 80.
2
Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3
Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
NOTE: This is the same as FirewallType . This setting is provided for use by beans that do not directly expose Firewall properties.

FirewallUser
A user name if authentication is to be used connecting through a firewall
If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the bean throws an exception.NOTE: This is the same as User . This setting is provided for use by beans that do not directly expose Firewall properties.

KeepAliveTime
The inactivity time in milliseconds before a TCP keep-alive packet is sent
When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.Note: This value is not applicable in Java.

KeepAliveInterval
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received
When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime . If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.Note: This value is not applicable in Java or MAC.

Linger
When set to True, connections are terminated gracefully
This property controls how a connection is closed. The default is True.In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the bean returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime
Time in seconds to have the connection linger
LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.
LocalHost
The name of the local host through which connections are initiated or accepted
The LocalHost setting 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 multi-homed 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 setting 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 multi-homed hosts (machines with more than one IP interface).

LocalPort
The TCP port in the local host where the bean binds
This must be set before a connection is attempted. It instructs the bean to bind to a specific port (or communication endpoint) in the local machine.Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength
The maximum amount of data to accumulate when no EOL is found
MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes.

MaxTransferRate
The transfer rate limit in bytes per second
This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.
TCPKeepAlive
Determines whether or not the keep alive socket option is enabled
If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.Note: This value is not applicable in Java.

UseIPv6
Whether or not to use IPv6
By default, the component expects an IPv4 address for local and remote host properties, and will create an IPv4 socket. To use IPv6 instead, set this to True.
CloseStreamAfterTransfer
If true, the component will close the upload or download stream after the transfer
This entry is for bean and all the components that descend from it.This property is true by default. Therefore, by default, all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, you must set this config to false.

TcpNoDelay
Whether or not to delay when sending packets
When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.By default, this config is set to false.

Socket Configuration Settings

AbsoluteTimeout
Determines whether timeouts are inactivity timeouts or absolute timeouts
If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
FirewallData
Used to send extra data to the firewall
When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).
InBufferSize
The size in bytes of the incoming queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize
The size in bytes of the outgoing queue of the socket
This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the bean is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

XMLp Configuration Settings

IgnoreBadAttributePrefixes
If true, bad (unknown) attribute prefixes are ignored
Normally a trappable error is generated when an unknown attribute prefix is encountered. This setting suppresses the error. The default value is True.
IgnoreBadElementPrefixes
If true, bad (unknown) element prefixes are ignored
Normally a trappable error is generated when an unknown element prefix is encountered. This setting suppresses the error. The default value is True.
CacheContent
If true, the original XML is saved in a buffer
This config controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is true.
ErrorOnEmptyAttr
If true, passing an invalid attribute to the Attr method will throw an exception
If an invalid attribute name is passed into the Attr method, the method will return with an empty string if this is set to false, otherwise an exception is thrown.
PreserveWhitespace
If true, leading and trailing whitespace in element text is preserved
Normally the leading and trailing whitespace from an element's text is trimmed. When this property is set to true, this leading and trailing whitespace is preserved. The default value is false.

Base Configuration Settings

GUIAvailable
Tells the bean whether or not a message loop is available for processing events
In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The bean will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the bean does not attempt to process external events.

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

Throws:
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).

Throws:
IPWorksException

hasXPath

public boolean hasXPath(java.lang.String xpath)
                 throws IPWorksException
Determines whether a specific element exists in the document.

You can use the HasXPath method to determine if a particular XPath exists before setting it with XPath .

The XPath property implements a subset of the XML XPath specification, allowing you to point to specific elements in the document.

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.

Setting the XPath property to an XPath that does not exist will cause an error.

Throws:
IPWorksException

interrupt

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

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

Throws:
IPWorksException

reset

public void reset()
           throws IPWorksException
Reset the bean.

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

Throws:
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() 

Throws:
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() 

Throws:
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 Params collection for the parameter identified by ParamName and will return the value associated with it provided in the collection .

Throws:
IPWorksException

addSoapEventListener

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

removeSoapEventListener

public void removeSoapEventListener(SoapEventListener l)

IP*Works! V9

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