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 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	authNone
static int	authNtlm
static int	authProprietary
static int	frAlways
static int	frNever
static int	frSameScheme
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 collection.
void	addParam(java.lang.String paramName, java.lang.String paramValue) Adds a parameter-value pair.
void	addSoapEventListener(ipworks.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 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.
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.
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.
ipworks.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 retrieval.
java.lang.String	getPassword() A password if authentication is to be used.
java.lang.String	getPragma() A browser/server specific header line (optional).
ipworks.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 transfer.
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 .
void	interrupt() Interrupt the current method.
boolean	isConnected() Shows whether the bean is connected.
boolean	isIdle() The current status of the component.
void	removeSoapEventListener(ipworks.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	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	setCookies(HTTPCookieList cookies) Collection of cookies.
void	setFirewall(ipworks.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	setNamespaces(XMLNamespaceList namespaces) A collection of namespaces in the current stack.
void	setOtherHeaders(java.lang.String otherHeaders) Other headers as determined by the user (optional).
void	setParams(SOAPParamList params) A collection of parameters for the SOAP Method .
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(ipworks.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

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

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.

AuthScheme should be set to authNone (3) when no authentication is expected.

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.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

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.

AuthScheme should be set to authNone (3) when no authentication is expected.

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.

If AuthScheme is set to authProprietary (2) then the authorization token must be supplied through Authorization property. Note that, if you set the Authorization property, the AuthScheme will be set automatically to authProprietary (2) by the control.

If AuthScheme is set to authNtlm (4) NTLM authentication will be used. This option is only available in the SSL package.

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

getCookies

public HTTPCookieList getCookies()

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

setCookies

public void setCookies(HTTPCookieList cookies)
                throws IPWorksException

Collection of cookies.

All HTTPCOOKIE specified in the collection are added to the outgoing HTTP request.

The SetCookie event displays the cookies and their properties as set by the server, and those cookies are also maintained in the Cookies property.

MaxHTTPCookiescan be used to control the number of cookies saved.

This collection is indexed from 0 to Count - 1.

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.

getFirewall

public ipworks.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(ipworks.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.

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

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 the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the 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 IPWorksException raises an IPWorksException 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 the IfModifiedSince property contains a non-empty string, an If-Modified-Since HTTP request header is added to the request. The value of the 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 IPWorksException raises an IPWorksException 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.

IPWorksException

getLocalFile

public java.lang.String getLocalFile()

The path to a local file for downloading. If the file exists, it is overwritten. (optional)

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of 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. (optional)

The LocalFile property is used when getting a document.

If LocalFile is empty then the received data is provided through the parameters of the Transfer event.

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

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

setNamespaces

public void setNamespaces(XMLNamespaceList namespaces)
                   throws IPWorksException

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

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

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. The ReturnValue property then refers to the first parameter in the collection.

This collection is indexed from 0 to Count - 1.

setParams

public void setParams(SOAPParamList params)
               throws IPWorksException

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. The ReturnValue property then refers to the first parameter in the collection.

This collection is indexed from 0 to Count - 1.

IPWorksException

getParsedHeaders

public HeaderList getParsedHeaders()

Collection of headers returned from the last retrieval.

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.

MaxHeaderscan be used to control the number of headers saved.

This collection is indexed from 0 to Count - 1.

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

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

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

getProxy

public ipworks.Proxy getProxy()

A set of properties related to proxy access.

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

setProxy

public void setProxy(ipworks.Proxy proxy)
              throws IPWorksException

A set of properties related to proxy access.

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

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

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

getTransferredData

public byte[] getTransferredData()

The contents of the last transfer.

If the LocalFile is empty, the data is accumulated in TransferredData . Otherwise, TransferredData returns an empty string.

TheMaxTransferredDataconfiguration setting controls the amount of data accumulated in TransferredData .

getTransferredDataLimit

public long getTransferredDataLimit()

The maximum of data to be transferred.

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.

setTransferredDataLimit

public void setTransferredDataLimit(long transferredDataLimit)
                             throws IPWorksException

The maximum of data to be transferred.

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.

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.

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

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

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

Sets a cookie and the corresponding value.

Please refer to the Cookies property 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 collection.

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

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.

Please refer to the XAttributes collection for more information.

IPWorksException

buildPacket

public void buildPacket()
                 throws IPWorksException

Build the request packet.

The resulting packet is placed in SOAPPacket .

IPWorksException

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

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

IPWorksException

addSoapEventListener

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

java.util.TooManyListenersException

removeSoapEventListener

public void removeSoapEventListener(ipworks.SoapEventListener l)