|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ipworks.Soap
The SOAP control is used to communicate with SOAP servers.
The SOAP control implements a standard SOAP client as specified in the SOAP 1.1 specification.
The control uses HTTP to communicate with SOAP servers, and an
internal XML parser to process the results. The SOAP requests are
specified by first setting the SOAP Method
and MethodURI
and optional parameters in the ParamName
and ParamValue
properties. Then set the target URL
and call the SendRequest
method, or set the Action
property to soapSendRequest .
The results will be provided in properties such as ReturnValue
,
and ParamName
, ParamValue
for output parameters. Additionally,
properties such as XPath
, XElement
, XText
, etc.. allow
for more granular traversal of the SOAP response.
If the server returns an error, the FaultCode
, FaultString
and FaultActor
properties provide information about the error
condition.
The control may also be used in offline mode. This is supported
by methods such as BuildPacket
and EvalPacket
and the
corresponding Action
codes. The corresponding SOAP packet will
be stored in the SOAPPacket
property. Offline mode is important
for cases where the underlying SOAP transport is not HTTP, but another
mechanism (e.g. SMTP and POP for email).
By providing direct access to the SOAP packet in offline mode, the
control also allows for possible extensions, and full control
over SOAPPacket
. The SendPacket
method or the corresponding Action
code may then be used to send the custom-created SOAPPacket
to the destination URL
.
Field Summary | |
static int |
fwNone
|
static int |
fwSOCKS4
|
static int |
fwSOCKS5
|
static int |
fwTunnel
|
static int |
soapBuildPacket
|
static int |
soapEvalPacket
|
static int |
soapIdle
|
static int |
soapReset
|
static int |
soapSendPacket
|
static int |
soapSendRequest
|
static int |
vfFullXML
|
static int |
vfText
|
static int |
vfXML
|
Constructor Summary | |
Soap()
|
Method Summary | |
void |
addCookie(java.lang.String cookieName,
java.lang.String cookieValue)
Sets a cookie and the corresponding value. |
void |
addParam(java.lang.String paramName,
java.lang.String paramValue)
Adds a parameter-value pair. |
void |
addSoapEventListener(SoapEventListener l)
|
void |
buildPacket()
Build the request packet and place it in SOAPPacket . |
void |
evalPacket()
Evaluate the packet in SOAPPacket . |
void |
fireConnected(int statusCode,
java.lang.String description)
Fired immediately after a connection completes (or fails). |
void |
fireDisconnected(int statusCode,
java.lang.String description)
Fired when a connection is closed. |
void |
fireEndTransfer()
Fired when a document finishes transferring. |
void |
fireError(int errorCode,
java.lang.String description)
Information about errors during data delivery. |
void |
fireHeader(java.lang.String field,
java.lang.String value)
Fired every time a header line comes in. |
void |
fireSetCookie(java.lang.String name,
java.lang.String value,
java.lang.String expires,
java.lang.String domain,
java.lang.String path,
boolean secure)
Fired for every cookie set by the server. |
void |
fireStartTransfer()
Fired when a document starts transferring (after the headers). |
void |
fireTransfer(int bytesTransferred)
Fired while the response transfers. |
int |
getAction()
An action code for the component. |
java.lang.String |
getActionURI()
The value of the SOAP-Action header. |
java.lang.String |
getAuthorization()
The Authorization string to be sent to the server. |
java.lang.String |
getContentType()
Content type for SOAP request data. |
int |
getCookieCount()
Number of cookies in the current request. |
java.lang.String |
getCookieName(int cookieIndex)
Array of cookie names. |
java.lang.String |
getCookieValue(int cookieIndex)
Array of cookie values. |
java.lang.String |
getFaultActor()
Actor of any faults returned by the SOAP server. |
java.lang.String |
getFaultCode()
Code of any faults returned by the SOAP server. |
java.lang.String |
getFaultString()
Textual description of any faults returned by the SOAP server. |
byte[] |
getFirewallData()
Used to send other data to firewall. |
java.lang.String |
getFirewallHost()
Name or IP address of firewall (optional). |
java.lang.String |
getFirewallPassword()
A password if authentication is to be used connecting through the firewall. |
int |
getFirewallPort()
Port of the firewall to connect to. |
int |
getFirewallType()
Determines the type of firewall to connect through. |
java.lang.String |
getFirewallUser()
A user name if authentication is to be used connecting through a firewall. |
int |
getFlags()
Flags controlling the behaviour of the parser. |
java.lang.String |
getLocalHost()
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
java.lang.String |
getMethod()
The remote Method . |
java.lang.String |
getMethodURI()
The URI corresponding to the SOAP Method . |
int |
getNamespaceCount()
The number of default Namespaces defined. |
java.lang.String |
getNamespaces(int namespaceIndex)
The default Namespaces defined by the component. |
java.lang.String |
getOtherHeaders()
Other headers as determined by the user (optional). |
java.lang.String |
getParamAttr(int paramIndex)
Extra attributes of the Method parameters. |
int |
getParamCount()
The number of parameters sent to the remote host. |
java.lang.String |
getParamName(int paramIndex)
The names of the Method parameters. |
java.lang.String |
getParamValue(int paramIndex)
The values of the Method parameters. |
java.lang.String |
getPassword()
A password if Basic authentication is to be used. |
java.lang.String |
getPrefixes(int namespaceIndex)
The prefixes corresponding to the default Namespaces defined by the component. |
java.lang.String |
getProxyAuthorization()
Similar to the Authorization property, but for proxy authorization. |
int |
getProxyPort()
Port for the proxy server (default 80). |
java.lang.String |
getProxyServer()
Name or IP address of a proxy server (optional). |
java.lang.String |
getReturnValue()
Value returned by the SOAP Method . |
java.lang.String |
getSOAPEncoding()
The type of SOAP Encoding used for SOAP requests. |
java.lang.String |
getSOAPHeader()
Contents of the optional SOAP header sent to the server. |
java.lang.String |
getSOAPPacket()
Full contents of the SOAP packet. |
java.lang.String |
getStatusLine()
The first line of the last server response. |
int |
getTimeout()
A timeout for the component. |
java.lang.String |
getURL()
The URL to fetch. |
java.lang.String |
getUser()
A user name if Basic authentication is to be used. |
java.lang.String |
getUserAgent()
Information about the user agent. |
int |
getValueFormat()
Format of data returned or set. |
int |
getXAttrCount()
Size of attribute values array for the current element. |
java.lang.String |
getXAttrName(int attrIndex)
Array of attribute names for the current element. |
java.lang.String |
getXAttrNamespace(int attrIndex)
Array of attribute namespaces for the current element. |
java.lang.String |
getXAttrPrefix(int attrIndex)
Array of attribute prefixes for the current element. |
java.lang.String |
getXAttrValue(int attrIndex)
Array of attribute values for the current element. |
int |
getXChildren()
The number of children of the element pointed to by XPath . |
java.lang.String |
getXElement()
The name of the element pointed to by XPath . |
java.lang.String |
getXNamespace()
The namespace of the element pointed to by XPath . |
java.lang.String |
getXParent()
The parent of the element pointed to by XPath . |
java.lang.String |
getXPath()
A path into the SOAPPacket received by the server. |
java.lang.String |
getXPrefix()
The prefix of the element pointed to by XPath . |
java.lang.String |
getXText()
The text of the element pointed to by XPath . |
void |
interrupt()
Interrupt the Action in progress (if any). |
boolean |
isConnected()
Shows whether the component is connected. |
void |
removeSoapEventListener(SoapEventListener l)
|
void |
reset()
Reset. |
void |
sendPacket()
Send the packet. |
void |
sendRequest()
Send the request. |
void |
setAction(int action)
An action code for the component. |
void |
setActionURI(java.lang.String actionURI)
The value of the SOAP-Action header. |
void |
setAuthorization(java.lang.String authorization)
The Authorization string to be sent to the server. |
void |
setContentType(java.lang.String contentType)
Content type for SOAP request data. |
void |
setCookieCount(int cookieCount)
Number of cookies in the current request. |
void |
setCookieName(int cookieIndex,
java.lang.String cookieName)
Array of cookie names. |
void |
setCookieValue(int cookieIndex,
java.lang.String cookieValue)
Array of cookie values. |
void |
setFirewallData(byte[] firewallData)
Used to send other data to firewall. |
void |
setFirewallHost(java.lang.String firewallHost)
Name or IP address of firewall (optional). |
void |
setFirewallPassword(java.lang.String firewallPassword)
A password if authentication is to be used connecting through the firewall. |
void |
setFirewallPort(int firewallPort)
Port of the firewall to connect to. |
void |
setFirewallType(int firewallType)
Determines the type of firewall to connect through. |
void |
setFirewallUser(java.lang.String firewallUser)
A user name if authentication is to be used connecting through a firewall. |
void |
setFlags(int flags)
Flags controlling the behaviour of the parser. |
void |
setLocalHost(java.lang.String localHost)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
void |
setMethod(java.lang.String method)
The remote Method . |
void |
setMethodURI(java.lang.String methodURI)
The URI corresponding to the SOAP Method . |
void |
setNamespaces(int namespaceIndex,
java.lang.String namespaces)
The default Namespaces defined by the component. |
void |
setOtherHeaders(java.lang.String otherHeaders)
Other headers as determined by the user (optional). |
void |
setParamAttr(int paramIndex,
java.lang.String paramAttr)
Extra attributes of the Method parameters. |
void |
setParamCount(int paramCount)
The number of parameters sent to the remote host. |
void |
setParamName(int paramIndex,
java.lang.String paramName)
The names of the Method parameters. |
void |
setParamValue(int paramIndex,
java.lang.String paramValue)
The values of the Method parameters. |
void |
setPassword(java.lang.String password)
A password if Basic authentication is to be used. |
void |
setPrefixes(int namespaceIndex,
java.lang.String prefixes)
The prefixes corresponding to the default Namespaces defined by the component. |
void |
setProxyAuthorization(java.lang.String proxyAuthorization)
Similar to the Authorization property, but for proxy authorization. |
void |
setProxyPort(int proxyPort)
Port for the proxy server (default 80). |
void |
setProxyServer(java.lang.String proxyServer)
Name or IP address of a proxy server (optional). |
void |
setSOAPEncoding(java.lang.String SOAPEncoding)
The type of SOAP Encoding used for SOAP requests. |
void |
setSOAPHeader(java.lang.String SOAPHeader)
Contents of the optional SOAP header sent to the server. |
void |
setSOAPPacket(java.lang.String SOAPPacket)
Full contents of the SOAP packet. |
void |
setTimeout(int timeout)
A timeout for the component. |
void |
setURL(java.lang.String URL)
The URL to fetch. |
void |
setUser(java.lang.String user)
A user name if Basic authentication is to be used. |
void |
setUserAgent(java.lang.String userAgent)
Information about the user agent. |
void |
setValueFormat(int valueFormat)
Format of data returned or set. |
void |
setXPath(java.lang.String XPath)
A path into the SOAPPacket received by the server. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int soapIdle
public static final int soapSendRequest
public static final int soapReset
public static final int soapBuildPacket
public static final int soapSendPacket
public static final int soapEvalPacket
public static final int fwNone
public static final int fwTunnel
public static final int fwSOCKS4
public static final int fwSOCKS5
public static final int vfText
public static final int vfXML
public static final int vfFullXML
Constructor Detail |
public Soap()
Method Detail |
public int getAction()
Action
property to a valid action code makes
the control perform the associated action. If the action completes
successfully, execution continues normally, and Action
is
reset to 0 (Idle). If an error happens, then
an IPWorksException exception is raised.
The following are the possible values for the Action
property
and the corresponding descriptions:
URL
. When a response is received,
it is evaluated and output properties such as ReturnValue
are updated
accordingly.
SOAPPacket
property. This Action
is useful for SOAP
transactions that are ran over transports other than the included HTTP support.
SOAPPacket
(the other
input properties are disregarded). The response is evaluated as normal.
SOAPPacket
. Properties such as ReturnValue
are updated accordingly. This Action
is useful for SOAP
transactions that are ran over transports other than the included HTTP support.
public void setAction(int action) throws IPWorksException
Action
property to a valid action code makes
the control perform the associated action. If the action completes
successfully, execution continues normally, and Action
is
reset to 0 (Idle). If an error happens, then
an IPWorksException exception is raised.
The following are the possible values for the Action
property
and the corresponding descriptions:
URL
. When a response is received,
it is evaluated and output properties such as ReturnValue
are updated
accordingly.
SOAPPacket
property. This Action
is useful for SOAP
transactions that are ran over transports other than the included HTTP support.
SOAPPacket
(the other
input properties are disregarded). The response is evaluated as normal.
SOAPPacket
. Properties such as ReturnValue
are updated accordingly. This Action
is useful for SOAP
transactions that are ran over transports other than the included HTTP support.
public java.lang.String getActionURI()
MethodURI
and/or Method
is set, ActionURI
is
automatically updated to MethodURI
# Method
.
public void setActionURI(java.lang.String actionURI) throws IPWorksException
MethodURI
and/or Method
is set, ActionURI
is
automatically updated to MethodURI
# Method
.
public java.lang.String getAuthorization()
Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.
If User
and Password
are specified, they are Base64 encoded,
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
public void setAuthorization(java.lang.String authorization) throws IPWorksException
Authorization
property contains a non-empty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP control can be extended with other security schemes except the common Basic authorization scheme defined by the HTTP protocol.
If User
and Password
are specified, they are Base64 encoded,
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
public boolean isConnected()
public java.lang.String getContentType()
ContentType
is "text/xml".
public void setContentType(java.lang.String contentType) throws IPWorksException
ContentType
is "text/xml".
public int getCookieCount()
CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public void setCookieCount(int cookieCount) throws IPWorksException
CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public java.lang.String getCookieName(int cookieIndex) throws IPWorksException
CookieCount
property. Element
indexes start at 1.
All cookies specified in the array are sent to URLServer
when the URL
is submitted.
The cookie arrays such as CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public void setCookieName(int cookieIndex, java.lang.String cookieName) throws IPWorksException
CookieCount
property. Element
indexes start at 1.
All cookies specified in the array are sent to URLServer
when the URL
is submitted.
The cookie arrays such as CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public java.lang.String getCookieValue(int cookieIndex) throws IPWorksException
CookieCount
property. Element
indexes start at 1.
All cookies specified in the array are sent to URLServer
when the URL
is submitted.
The cookie arrays such as CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public void setCookieValue(int cookieIndex, java.lang.String cookieValue) throws IPWorksException
CookieCount
property. Element
indexes start at 1.
All cookies specified in the array are sent to URLServer
when the URL
is submitted.
The cookie arrays such as CookieName
and CookieValue
maintain the cookies
sent to the server.
The SetCookie
event displays the cookies set by the server and their properties.
public java.lang.String getFaultActor()
FaultCode
and FaultString
provide the corresponding
fault code and description.
public java.lang.String getFaultCode()
FaultString
and FaultActor
provide the corresponding
fault description and actor.
public java.lang.String getFaultString()
FaultCode
and FaultActor
provide the corresponding fault
code and actor.
public byte[] getFirewallData()
public void setFirewallData(byte[] firewallData) throws IPWorksException
public java.lang.String getFirewallHost()
FirewallHost
is given, requested connections will be
authenticated through the specified firewall when connecting.
If the FirewallHost
property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the FirewallHost
property is set to the corresponding address. If the
search is not successful, an error is returned.
public void setFirewallHost(java.lang.String firewallHost) throws IPWorksException
FirewallHost
is given, requested connections will be
authenticated through the specified firewall when connecting.
If the FirewallHost
property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the FirewallHost
property is set to the corresponding address. If the
search is not successful, an error is returned.
public java.lang.String getFirewallPassword()
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.
public void setFirewallPassword(java.lang.String firewallPassword) throws IPWorksException
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.
public int getFirewallPort()
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.
public void setFirewallPort(int firewallPort) throws IPWorksException
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.
public int getFirewallType()
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
public void setFirewallType(int firewallType) throws IPWorksException
FirewallPort
is set to 80.
FirewallPort
is set to 1080.
FirewallPort
is set to 1080.
public java.lang.String getFirewallUser()
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.
public void setFirewallUser(java.lang.String firewallUser) throws IPWorksException
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.
public int getFlags()
public void setFlags(int flags) throws IPWorksException
public java.lang.String getOtherHeaders()
OtherHeaders
property contains a string of headers
to be appended to the HTTP request headers created from other
properties like ContentType
, From
, etc.
The headers must of the format "header: value" as specified in the HTTP specs. Header lines should be separated by CRLF ("\\r\\n").
Use this property with caution. If OtherHeaders
contains
invalid headers, HTTP requests may fail.
The OtherHeaders
property is useful for extending the
functionality of the control beyond what is provided.
public void setOtherHeaders(java.lang.String otherHeaders) throws IPWorksException
OtherHeaders
property contains a string of headers
to be appended to the HTTP request headers created from other
properties like ContentType
, From
, etc.
The headers must of the format "header: value" as specified in the HTTP specs. Header lines should be separated by CRLF ("\\r\\n").
Use this property with caution. If OtherHeaders
contains
invalid headers, HTTP requests may fail.
The OtherHeaders
property is useful for extending the
functionality of the control beyond what is provided.
public java.lang.String getLocalHost()
LocalHost
property contains the name of the local host
as obtained by the gethostname() Winsock call, or if the
user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multihomed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public void setLocalHost(java.lang.String localHost) throws IPWorksException
LocalHost
property contains the name of the local host
as obtained by the gethostname() Winsock call, or if the
user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.
If the control is connected, the LocalHost
property shows
the IP address of the interface through which the connection
is made in internet dotted format (aaa.bbb.ccc.ddd). In most
cases, this is the address of the local host, except for multihomed
hosts (machines with more than one IP interface).
NOTE: LocalHost
is not persistent. You must always set it in
code, and never in the property window.
public java.lang.String getMethod()
MethodURI
and/or Method
is set, ActionURI
property
is automatically updated to MethodURI
# Method
.
public void setMethod(java.lang.String method) throws IPWorksException
MethodURI
and/or Method
is set, ActionURI
property
is automatically updated to MethodURI
# Method
.
public java.lang.String getMethodURI()
MethodURI
and/or Method
is set, ActionURI
is
automatically updated to MethodURI
# Method
.
public void setMethodURI(java.lang.String methodURI) throws IPWorksException
MethodURI
and/or Method
is set, ActionURI
is
automatically updated to MethodURI
# Method
.
public int getNamespaceCount()
Namespaces
and Prefixes
. Array indexes start at 1.
The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.
public java.lang.String getNamespaces(int namespaceIndex) throws IPWorksException
NamespaceCount
.
The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.
public void setNamespaces(int namespaceIndex, java.lang.String namespaces) throws IPWorksException
NamespaceCount
.
The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.
public java.lang.String getParamAttr(int paramIndex) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public void setParamAttr(int paramIndex, java.lang.String paramAttr) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public int getParamCount()
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public void setParamCount(int paramCount) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public java.lang.String getParamName(int paramIndex) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public void setParamName(int paramIndex, java.lang.String paramName) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public java.lang.String getParamValue(int paramIndex) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public void setParamValue(int paramIndex, java.lang.String paramValue) throws IPWorksException
ParamCount
contains the upper bound of the 'Param' arrays: ParamName
, ParamValue
, and ParamAttr
.
The array indexes normally start at 1, with the exception of return parameters, where the indexes start at 0, with the return value located at index 0.
public java.lang.String getPassword()
User
and Password
are Base64 encoded
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
The User
and Password
properties must be set only after the URL
property is set. When the URL
property is set, for security reasons, the User
and Password
properties are immediately cleared.
public void setPassword(java.lang.String password) throws IPWorksException
User
and Password
are Base64 encoded
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
The User
and Password
properties must be set only after the URL
property is set. When the URL
property is set, for security reasons, the User
and Password
properties are immediately cleared.
public java.lang.String getPrefixes(int namespaceIndex) throws IPWorksException
NamespaceCount
.
The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.
public void setPrefixes(int namespaceIndex, java.lang.String prefixes) throws IPWorksException
NamespaceCount
.
The default namespace defined by the control is 'http://schemas.xmlsoap.org/soap/envelope/', with the corresponding prefix being 'SOAP-ENV'.
public java.lang.String getProxyAuthorization()
Authorization
property contains a non-empty string,
a Prxy-Authorization HTTP request header is added to the
request. This header conveys proxy authorization information to the
server.
If ProxyUser
and ProxyPassword
are specified, they are Base64 encoded,
and the result is put in the ProxyAuthorization
property
in the form "Basic [encoded-proxyuser-proxypassword]".
public void setProxyAuthorization(java.lang.String proxyAuthorization) throws IPWorksException
Authorization
property contains a non-empty string,
a Prxy-Authorization HTTP request header is added to the
request. This header conveys proxy authorization information to the
server.
If ProxyUser
and ProxyPassword
are specified, they are Base64 encoded,
and the result is put in the ProxyAuthorization
property
in the form "Basic [encoded-proxyuser-proxypassword]".
public int getProxyPort()
ProxyServer
. See the
description of the ProxyServer
property for
details.
public void setProxyPort(int proxyPort) throws IPWorksException
ProxyServer
. See the
description of the ProxyServer
property for
details.
public java.lang.String getProxyServer()
ProxyServer
is given, then the HTTP request is
sent to the proxy instead of the server specified in the URL
.
If the ProxyServer
property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the ProxyServer
property is set to the corresponding address. If the
search is not successful, an error is returned.
public void setProxyServer(java.lang.String proxyServer) throws IPWorksException
ProxyServer
is given, then the HTTP request is
sent to the proxy instead of the server specified in the URL
.
If the ProxyServer
property is set to a Domain Name, a DNS request
is initiated and upon successful termination of the request, the ProxyServer
property is set to the corresponding address. If the
search is not successful, an error is returned.
public java.lang.String getReturnValue()
ReturnValue
corresponds to the first element of the ParamValue
array (located at index 0).
public java.lang.String getSOAPEncoding()
public void setSOAPEncoding(java.lang.String SOAPEncoding) throws IPWorksException
public java.lang.String getSOAPHeader()
public void setSOAPHeader(java.lang.String SOAPHeader) throws IPWorksException
public java.lang.String getSOAPPacket()
SOAPPacket
property contains the contents of the
SOAP packet created by the client before submitting a request,
and the full, unmodified contents of the SOAP response as
received by the server.
public void setSOAPPacket(java.lang.String SOAPPacket) throws IPWorksException
SOAPPacket
property contains the contents of the
SOAP packet created by the client before submitting a request,
and the full, unmodified contents of the SOAP response as
received by the server.
public java.lang.String getStatusLine()
Action
property, the
error string is the same as the StatusLine
property.
The HTTP protocol specifies the structure of the StatusLine
as: [HTTP version] [Result Code] [Description].
public int getTimeout()
Timeout
property is set to 0 (default value) all actions
will run uninterrupted until succesful completion, or an error condition
is encountered.
If Timeout
is set to a positive value, and any action does not
complete within Timeout
seconds, the action is aborted, and a 'Timeout' error is fired..
The control will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and always remains responsive.
public void setTimeout(int timeout) throws IPWorksException
Timeout
property is set to 0 (default value) all actions
will run uninterrupted until succesful completion, or an error condition
is encountered.
If Timeout
is set to a positive value, and any action does not
complete within Timeout
seconds, the action is aborted, and a 'Timeout' error is fired..
The control will use DoEvents
to enter an efficient wait loop
during any potential waiting period, making sure that all system events
are processed immediately as they arrive. This ensures that the host
application does not "freeze" and always remains responsive.
public java.lang.String getURL()
URLScheme
, URLServer
, URLPort
, and URLPath
properties.
public void setURL(java.lang.String URL) throws IPWorksException
URLScheme
, URLServer
, URLPort
, and URLPath
properties.
public java.lang.String getUser()
User
and Password
are Base64 encoded,
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
The User
and Password
properties must be set only after the URL
property is set. When the URL
property is set, for security reasons, the User
and Password
properties are immediately cleared.
public void setUser(java.lang.String user) throws IPWorksException
User
and Password
are Base64 encoded,
and the result is put in the Authorization
property
in the form "Basic [encoded-user-password]".
The User
and Password
properties must be set only after the URL
property is set. When the URL
property is set, for security reasons, the User
and Password
properties are immediately cleared.
public java.lang.String getUserAgent()
public void setUserAgent(java.lang.String userAgent) throws IPWorksException
public int getValueFormat()
ValueFormat
property specifies the format of the
data set or received into/from value properties such as ParamValue
, XText
, and ReturnValue
.
The following are the possible values:
public void setValueFormat(int valueFormat) throws IPWorksException
ValueFormat
property specifies the format of the
data set or received into/from value properties such as ParamValue
, XText
, and ReturnValue
.
The following are the possible values:
public int getXAttrCount()
XAttrCount
property provides the number of attributes
for the current element.
The corresponding attribute names, prefixes, namespaces, and values
are provided respectively via the XAttrName
, XAttrPrefix
, XAttrNamespace
,
and XAttrValue
properties.
public java.lang.String getXAttrName(int attrIndex) throws IPWorksException
XAttrName
property provides the local names (without
prefixes) of the attributes for the current element.
The attribute values are indexed in the array in the same order
that they were found in the document. The indexes start at 1 and
end at the number of attributes (provided by the XAttrCount
property).
The corresponding attribute values, attribute prefixes, and namespaces
are provided respectively via the XAttrValue
, XAttrPrefix
, and XAttrNamespace
properties.
public java.lang.String getXAttrNamespace(int attrIndex) throws IPWorksException
XAttrNamespace
property provides the namespaces of the
attributes for the current element.
The attribute namespaces are indexed in the array in the same order
that the attributes were found in the document. The indexes start at 1 and
end at the number of attributes (provided by the XAttrCount
property).
The corresponding attribute names, attribute prefixes, and values
are provided respectively via the XAttrName
, XAttrPrefix
, and XAttrValue
properties.
public java.lang.String getXAttrPrefix(int attrIndex) throws IPWorksException
XAttrName
property provides the prefixes of the
attributes for the current element.
The attribute prefixes are indexed in the array in the same order
that they were found in the document. The indexes start at 1 and
end at the number of attributes (provided by the XAttrCount
property). If an attribute does not have a prefix, this
property is empty.
The corresponding attribute values, attribute names, and namespaces
are provided respectively via the XAttrValue
, XAttrName
, and XAttrNamespace
properties.
public java.lang.String getXAttrValue(int attrIndex) throws IPWorksException
XAttrValue
property provides the values of the
attributes for the current element.
The attribute values are indexed in the array in the same order
that they were found in the document. The indexes start at 1 and
end at the number of attributes (provided by the XAttrCount
property).
The corresponding attribute names are provided via the XAttrName
property.
public int getXChildren()
XChildren
is -1.
public java.lang.String getXElement()
XPrefix
.
public java.lang.String getXNamespace()
XPrefix
.
public java.lang.String getXParent()
XPath
points to the top element, XParent
is an empty string.
public java.lang.String getXPath()
Use this property to look at details of the SOAPPacket
received
by the server.
public void setXPath(java.lang.String XPath) throws IPWorksException
Use this property to look at details of the SOAPPacket
received
by the server.
public java.lang.String getXPrefix()
XElement
.
public java.lang.String getXText()
ValueFormat
property controls the format in which
the value is returned.
public void fireConnected(int statusCode, java.lang.String description)
SoapConnectedEvent
public void fireDisconnected(int statusCode, java.lang.String description)
SoapDisconnectedEvent
public void fireEndTransfer()
SoapEndTransferEvent
public void fireError(int errorCode, java.lang.String description)
SoapErrorEvent
public void fireHeader(java.lang.String field, java.lang.String value)
SoapHeaderEvent
public void fireSetCookie(java.lang.String name, java.lang.String value, java.lang.String expires, java.lang.String domain, java.lang.String path, boolean secure)
SoapSetCookieEvent
public void fireStartTransfer()
SoapStartTransferEvent
public void fireTransfer(int bytesTransferred)
SoapTransferEvent
public void addCookie(java.lang.String cookieName, java.lang.String cookieValue) throws IPWorksException
CookieName
and CookieValue
properties
for more information on cookies and how they are managed.
public void addParam(java.lang.String paramName, java.lang.String paramValue) throws IPWorksException
ParamName
and ParamValue
properties
for more information on SOAP parameters and how they are managed.
public void buildPacket() throws IPWorksException
Action
property
to soapBuildPacket .
public void evalPacket() throws IPWorksException
Action
property
to soapEvalPacket .
public void interrupt() throws IPWorksException
Action
property
to Idle (0) .
public void reset() throws IPWorksException
Action
property
to soapReset .
public void sendPacket() throws IPWorksException
Action
property
to soapSendPacket .
public void sendRequest() throws IPWorksException
Action
property
to soapSendRequest .
public void addSoapEventListener(SoapEventListener l) throws java.util.TooManyListenersException
public void removeSoapEventListener(SoapEventListener l)
|
![]() |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |