Soaps (IP*Works! SSL)

Package

Class

Tree

Deprecated

Index

Help

IP*Works! SSL V6

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

ipworksssl
Class Soaps

java.lang.Object
  |
  +--ipworksssl.Soaps

public class Soaps
extends java.lang.Object

The SOAPS bean is used to communicate with SOAP servers.

The SOAPS bean is the SSL-enabled equivalent of the IP*Works! SOAP bean. The main difference is the introduction of a set of new configuration settings, properties and events that deal with SSL security. TheSSLProviderconfiguration setting chooses a security provider subsystem. TheSSLEnabledProtocolsandSSLCipherStrengthconfiguration settings determine which protocols are enabled and at what security level. The SSLCertStore , SSLCertSubject , and SSLCertEncoded properties are used to select a client certificate if the server is requesting client authentication. TheSSLSecurityFlagsconfiguration setting, together with the SSLServerAuthentication event allow you to check the server identity and other security attributes. Finally, the SSLStatus event provides information about the SSL handshake.

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

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

The results will be provided in properties such as ReturnValue , and ParamName , ParamValue for output parameters. Additionally, properties such as XPath , XElement , XText , etc.. allow for more granular traversal of the SOAP response.

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

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

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

Field Summary

static int authBasic


static int authDigest


static int frAlways


static int frNever


static int frSameScheme


static int fwNone


static int fwSOCKS4


static int fwSOCKS5


static int fwTunnel


static int sstMachine


static int sstPEMKey


static int sstPFXBlob


static int sstPFXFile


static int sstUser


static int vfFullXML


static int vfText


static int vfXML


Constructor Summary

Soaps()


Method Summary

void addCookie(java.lang.String cookieName, java.lang.String cookieValue)
          Sets a cookie and the corresponding value.

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

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

void addSoapsEventListener(SoapsEventListener l)


void buildPacket()
          Build the request packet.

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

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

void evalPacket()
          Evaluate the packet in SOAPPacket .

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

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

java.lang.String getAuthorization()
          The Authorization string to be sent to the server.

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

java.lang.String getContentType()
          Content type for SOAP request data.

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

java.lang.String getCookieName(int cookieIndex)
          Array of cookie names.

java.lang.String getCookieValue(int cookieIndex)
          Array of cookie values.

java.lang.String getFaultActor()
          Actor of any faults returned by the SOAP server.

java.lang.String getFaultCode()
          Code of any faults returned by the SOAP server.

java.lang.String getFaultString()
          Textual description of any faults returned by the SOAP server.

java.lang.String getFirewallHost()
          Name or IP address of firewall (optional).

java.lang.String getFirewallPassword()
          A password if authentication is to be used when connecting through the firewall.

int getFirewallPort()
          Port of the firewall to connect to.

int getFirewallType()
          Determines the type of firewall to connect through.

java.lang.String getFirewallUser()
          A user name if authentication is to be used connecting through a firewall.

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

java.lang.String getLocalHost()
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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

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

int getNamespaceCount()
          The number of default Namespaces defined.

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

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

java.lang.String getParamAttr(int paramIndex)
          Extra attributes of the Method parameters.

int getParamCount()
          The number of parameters sent to the remote host.

java.lang.String getParamName(int paramIndex)
          The names of the Method parameters.

java.lang.String getParamValue(int paramIndex)
          The values of the Method parameters.

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

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

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

java.lang.String getProxyAuthorization()
          Similar to the Authorization property, but for proxy authorization.

int getProxyPort()
          Port for the proxy server (default 80).

java.lang.String getProxyServer()
          Name or IP address of a proxy server (optional).

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

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

java.lang.String getSOAPEncoding()
          The type of SOAP Encoding used for SOAP requests.

java.lang.String getSOAPHeader()
          Contents of the optional SOAP header sent to the server.

java.lang.String getSOAPPacket()
          Full contents of the SOAP packet.

byte[] getSSLAcceptServerCert()
          Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

byte[] getSSLCertEncoded()
          The SSL certificate (PEM/base64 encoded).

byte[] getSSLCertStore()
          The name of the certificate store for the client certificate.

java.lang.String getSSLCertStorePassword()
          The password for the certificate store (if any).

int getSSLCertStoreType()
          The type of certificate store for the client certificate.

java.lang.String getSSLCertSubject()
          The subject of the certificate used for client authentication.

byte[] getSSLServerCert()
          The server certificate for the last established connection.

java.lang.String getSSLServerCertStatus()
          The verification status of the server certificate for the last established connection.

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

int getTimeout()
          A timeout for the bean.

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

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

int getValueFormat()
          Format of data returned or set.

int getXAttrCount()
          Size of attribute values array for the current element.

java.lang.String getXAttrName(int attrIndex)
          Array of attribute names for the current element.

java.lang.String getXAttrNamespace(int attrIndex)
          Array of attribute namespaces for the current element.

java.lang.String getXAttrPrefix(int attrIndex)
          Array of attribute prefixes for the current element.

java.lang.String getXAttrValue(int attrIndex)
          Array of attribute values for the current element.

int getXChildren()
          The number of children of the element pointed to by XPath .

java.lang.String getXElement()
          The name of the element pointed to by XPath .

java.lang.String getXNamespace()
          The namespace of the element pointed to by XPath .

java.lang.String getXParent()
          The parent of the element pointed to by XPath .

java.lang.String getXPath()
          A path into the SOAPPacket received by the server.

java.lang.String getXPrefix()
          The prefix of the element pointed to by XPath .

java.lang.String getXText()
          The text of the element pointed to by XPath .

void interrupt()
          Interrupt the current method.

boolean isConnected()
          Shows whether the bean is connected.

boolean isIdle()
          The current status of the component.

void removeSoapsEventListener(SoapsEventListener l)


void reset()
          Reset the bean.

void sendPacket()
          Send the packet.

void sendRequest()
          Send the request.

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

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

void setAuthorization(java.lang.String authorization)
          The Authorization string to be sent to the server.

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

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

void setContentType(java.lang.String contentType)
          Content type for SOAP request data.

void setCookieCount(int cookieCount)
          Number of cookies in the current request.

void setCookieName(int cookieIndex, java.lang.String cookieName)
          Array of cookie names.

void setCookieValue(int cookieIndex, java.lang.String cookieValue)
          Array of cookie values.

void setFirewallHost(java.lang.String firewallHost)
          Name or IP address of firewall (optional).

void setFirewallPassword(java.lang.String firewallPassword)
          A password if authentication is to be used when connecting through the firewall.

void setFirewallPort(int firewallPort)
          Port of the firewall to connect to.

void setFirewallType(int firewallType)
          Determines the type of firewall to connect through.

void setFirewallUser(java.lang.String firewallUser)
          A user name if authentication is to be used connecting through a firewall.

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

void setLocalHost(java.lang.String localHost)
          The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

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

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

void setNamespaceCount(int namespaceCount)
          The number of default Namespaces defined.

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

void setOtherHeaders(java.lang.String otherHeaders)
          Other headers as determined by the user (optional).

void setParamAttr(int paramIndex, java.lang.String paramAttr)
          Extra attributes of the Method parameters.

void setParamCount(int paramCount)
          The number of parameters sent to the remote host.

void setParamName(int paramIndex, java.lang.String paramName)
          The names of the Method parameters.

void setParamValue(int paramIndex, java.lang.String paramValue)
          The values of the Method parameters.

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

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

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

void setProxyAuthorization(java.lang.String proxyAuthorization)
          Similar to the Authorization property, but for proxy authorization.

void setProxyPort(int proxyPort)
          Port for the proxy server (default 80).

void setProxyServer(java.lang.String proxyServer)
          Name or IP address of a proxy server (optional).

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

void setSOAPEncoding(java.lang.String SOAPEncoding)
          The type of SOAP Encoding used for SOAP requests.

void setSOAPHeader(java.lang.String SOAPHeader)
          Contents of the optional SOAP header sent to the server.

void setSOAPPacket(java.lang.String SOAPPacket)
          Full contents of the SOAP packet.

void setSSLAcceptServerCert(byte[] SSLAcceptServerCert)
          Instructs the bean to unconditionally accept the server certificate that matches the supplied certificate.

void setSSLCertEncoded(byte[] SSLCertEncoded)
          The SSL certificate (PEM/base64 encoded).

void setSSLCertStore(byte[] SSLCertStore)
          The name of the certificate store for the client certificate.

void setSSLCertStorePassword(java.lang.String SSLCertStorePassword)
          The password for the certificate store (if any).

void setSSLCertStoreType(int SSLCertStoreType)
          The type of certificate store for the client certificate.

void setSSLCertSubject(java.lang.String SSLCertSubject)
          The subject of the certificate used for client authentication.

void setTimeout(int timeout)
          A timeout for the bean.

void setURL(java.lang.String URL)
          The URL to fetch.

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

void setValueFormat(int valueFormat)
          Format of data returned or set.

void setXPath(java.lang.String XPath)
          A path into the SOAPPacket received by the server.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authBasic

public static final int authBasic

See Also:: Constant Field Values

authDigest

public static final int authDigest

See Also:: Constant Field Values

fwNone

public static final int fwNone

See Also:: Constant Field Values

fwTunnel

public static final int fwTunnel

See Also:: Constant Field Values

fwSOCKS4

public static final int fwSOCKS4

See Also:: Constant Field Values

fwSOCKS5

public static final int fwSOCKS5

See Also:: Constant Field Values

frNever

public static final int frNever

See Also:: Constant Field Values

frAlways

public static final int frAlways

See Also:: Constant Field Values

frSameScheme

public static final int frSameScheme

See Also:: Constant Field Values

sstUser

public static final int sstUser

See Also:: Constant Field Values

sstMachine

public static final int sstMachine

See Also:: Constant Field Values

sstPFXFile

public static final int sstPFXFile

See Also:: Constant Field Values

sstPFXBlob

public static final int sstPFXBlob

See Also:: Constant Field Values

sstPEMKey

public static final int sstPEMKey

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

Soaps

public Soaps()

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 IPWorksSSLException

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.

IPWorksSSLException

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 IPWorksSSLException

The value of the SOAP-Action header.

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

IPWorksSSLException

getAuthorization

public java.lang.String getAuthorization()

The Authorization string to be sent to the server.

If the Authorization property contains a non-empty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

setAuthorization

public void setAuthorization(java.lang.String authorization)
                      throws IPWorksSSLException

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.

IPWorksSSLException

getAuthScheme

public int getAuthScheme()

The authorization scheme to be used when server authorization is to be performed.

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

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

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

setAuthScheme

public void setAuthScheme(int authScheme)
                   throws IPWorksSSLException

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.

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

IPWorksSSLException

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 IPWorksSSLException

Shows whether the bean is connected.

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

IPWorksSSLException

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 IPWorksSSLException

Content type for SOAP request data.

The default value for ContentType is "text/xml".

IPWorksSSLException

getCookieCount

public int getCookieCount()

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

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

setCookieCount

public void setCookieCount(int cookieCount)
                    throws IPWorksSSLException

Number of cookies in the current request.

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server.

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

IPWorksSSLException

getCookieName

public java.lang.String getCookieName(int cookieIndex)
                               throws IPWorksSSLException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

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

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksSSLException

setCookieName

public void setCookieName(int cookieIndex,
                          java.lang.String cookieName)
                   throws IPWorksSSLException

Array of cookie names.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

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

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksSSLException

getCookieValue

public java.lang.String getCookieValue(int cookieIndex)
                                throws IPWorksSSLException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

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

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksSSLException

setCookieValue

public void setCookieValue(int cookieIndex,
                           java.lang.String cookieValue)
                    throws IPWorksSSLException

Array of cookie values.

The size of the array is determined by the CookieCount property. Element indexes start at 1.

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

The cookie arrays CookieName and CookieValue store the cookies that are to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

IPWorksSSLException

getFaultActor

public java.lang.String getFaultActor()

Actor of any faults returned by the SOAP server.

FaultCode and FaultString provide the corresponding fault code and description.

getFaultCode

public java.lang.String getFaultCode()

Code of any faults returned by the SOAP server.

FaultString and FaultActor provide the corresponding fault description and actor.

getFaultString

public java.lang.String getFaultString()

Textual description of any faults returned by the SOAP server.

FaultCode and FaultActor provide the corresponding fault code and actor.

getFirewallHost

public java.lang.String getFirewallHost()

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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

setFirewallHost

public void setFirewallHost(java.lang.String firewallHost)
                     throws IPWorksSSLException

Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

IPWorksSSLException

getFirewallPassword

public java.lang.String getFirewallPassword()

A password if authentication is to be used when connecting through the firewall.

if FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

setFirewallPassword

public void setFirewallPassword(java.lang.String firewallPassword)
                         throws IPWorksSSLException

A password if authentication is to be used when connecting through the firewall.

IPWorksSSLException

getFirewallPort

public int getFirewallPort()

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

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

setFirewallPort

public void setFirewallPort(int firewallPort)
                     throws IPWorksSSLException

Port of the firewall to connect to.

The TCP port for the FirewallHost . See the description of the FirewallHost property for details.

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

IPWorksSSLException

getFirewallType

public int getFirewallType()

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0): No firewall (default setting).
fwTunnel (1): Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2): Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3): Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

setFirewallType

public void setFirewallType(int firewallType)
                     throws IPWorksSSLException

Determines the type of firewall to connect through.

The applicable values are the following:

fwNone (0): No firewall (default setting).
fwTunnel (1): Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2): Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3): Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.

IPWorksSSLException

getFirewallUser

public java.lang.String getFirewallUser()

A user name if authentication is to be used connecting through a firewall.

setFirewallUser

public void setFirewallUser(java.lang.String firewallUser)
                     throws IPWorksSSLException

A user name if authentication is to be used connecting through a firewall.

IPWorksSSLException

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 IPWorksSSLException

Determines what happens when the server issues a redirect.

The default value is frNever (0). In this case, redirects are never followed, and a runtime error is generated instead.

IPWorksSSLException

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 IPWorksSSLException

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.

IPWorksSSLException

isIdle

public boolean isIdle()

The current status of the component.

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

getLocalHost

public java.lang.String getLocalHost()

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the bean initiate connections (or accept in the case of server beans) only through that interface.

If the bean is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

setLocalHost

public void setLocalHost(java.lang.String localHost)
                  throws IPWorksSSLException

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.

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

IPWorksSSLException

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 IPWorksSSLException

The remote Method .

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

IPWorksSSLException

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 IPWorksSSLException

The URI corresponding to the SOAP Method .

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

IPWorksSSLException

getNamespaceCount

public int getNamespaceCount()

The number of default Namespaces defined.

This is the upper bound for the namespace arrays: Namespaces and Prefixes . Array indexes start at 1.

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

setNamespaceCount

public void setNamespaceCount(int namespaceCount)
                       throws IPWorksSSLException

The number of default Namespaces defined.

This is the upper bound for the namespace arrays: Namespaces and Prefixes . Array indexes start at 1.

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

IPWorksSSLException

getNamespaces

public java.lang.String getNamespaces(int namespaceIndex)
                               throws IPWorksSSLException

The default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksSSLException

setNamespaces

public void setNamespaces(int namespaceIndex,
                          java.lang.String namespaces)
                   throws IPWorksSSLException

The default Namespaces defined by the bean.

Array indexes start at 1 and end at NamespaceCount .

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

IPWorksSSLException