Package com.storedobject.common

Class SOAP

java.lang.Object

com.storedobject.common.SOAP

public class SOAP
extends Object

SOAP client - A simple SOAP utility for sending/receiving/manipulating SOAP messages. The default SOAP version supported is "1.2".

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SOAP.Version	SOAP Version

Constructor Summary

Constructors

Constructor	Description
SOAP(String serviceURL)	Constructor.
SOAP(String serviceURL, String actionSOAP)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	check(Node node, String xpath)	Extract the boolean value of a path within the SOAP Body.
void	close()	Close the resources associated with this instance.
Node	getBody()	Get the SOAP Body node.
Node	getFault()	Get the SOAP Fault node (Available when response is received).
Node	getHeader()	Get the SOAP Header node.
HTTP	getHTTP()	Get the HTTP connection associated with this SOAP.
Node	getNode(String xpath)	Get a node from the SOAP Body.
Number	getNumber(String xpath)	Extract the numeric value of a path within the SOAP Body.
final String	getPrefixSOAP()	Get the current "SOAP-Env" prefix.
String	getText(String xpath)	Extract the text value of a path within the SOAP Body.
XML	getXML()	Get the XML associated with this SOAP request.
void	request()	Send the request.
void	requesting()	This method is invoked just before the request is sent to the server.
void	setConnectTimeout(int timeout)	Set the connection timeout for the HTTP request.
void	setPack(boolean pack)	Whether to pack the SOAP XML structure by removing all the unwanted text nodes or not.
final void	setPrefixSOAP(String prefixSOAP)	Set the prefix to be used as the "SOAP-Env" prefix.
void	setReadTimeout(int timeout)	Sets the read timeout for the HTTP connection.
void	setTemplate(String templateSOAP)	Set the SOAP template.
boolean	setText(String xpath, String value)	Set a text value to the given path in the body.
boolean	setText(Node node, String value)	Set a text value to the given node if it is a "text node".
final void	setVersionSOAP(SOAP.Version version)	Set the SOAP version.
String	toPrettyString()	Returns the XML associated with this SOAP request in a pretty string format.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SOAP

public SOAP(String serviceURL)
     throws MalformedURLException

Constructor.

Parameters:

serviceURL - Service URL.

Throws:

MalformedURLException

SOAP

public SOAP(String serviceURL,
 String actionSOAP)
     throws MalformedURLException

Constructor.

Parameters:

serviceURL - Service URL.

actionSOAP - SOAP action.

Throws:

MalformedURLException

Method Details

setVersionSOAP

public final void setVersionSOAP(SOAP.Version version)

Set the SOAP version.

Warning: This should be set before invoking any XML related methods!

Parameters:

version - Version.

getHTTP

public HTTP getHTTP()

Get the HTTP connection associated with this SOAP.

Returns:

HTTP connection instance.

setPack

public void setPack(boolean pack)

Whether to pack the SOAP XML structure by removing all the unwanted text nodes or not. The default value is true. Packing reduces human readability.

Parameters:

pack - True/false.

getPrefixSOAP

public final String getPrefixSOAP()

Get the current "SOAP-Env" prefix.

Returns:

"SOAP-Env" prefix.

setPrefixSOAP

public final void setPrefixSOAP(String prefixSOAP)

Set the prefix to be used as the "SOAP-Env" prefix.

Parameters:

prefixSOAP - Prefix to set.

getXML

public XML getXML()

Get the XML associated with this SOAP request.

Returns:

XML.

getNode

public Node getNode(String xpath)
             throws Exception

Get a node from the SOAP Body.

Parameters:

xpath - Path. Note: If Body elements don't have a prefix, use "b:" as the prefix.

Returns:

Node within the SOAP Body.

Throws:

Exception

setText

public boolean setText(String xpath,
 String value)
                throws Exception

Set a text value to the given path in the body.

Parameters:

xpath - Path. Note: If Body elements don't have a prefix, use "b:" as the prefix.

Returns:

True if the value was successfully set. Otherwise, false.

Throws:

Exception

setText

public boolean setText(Node node,
 String value)

Set a text value to the given node if it is a "text node". If the node is not a "text node", the value will be set to its first child if that is a "text node". Else, it will recursively go down until a "text node" is found. Please note that the recursive traversal happens only through the first children.

Parameters:

node - Node for which value to be set.

value - Value to set.

Returns:

True if the value was successfully set. Otherwise, false.

getText

public String getText(String xpath)
               throws Exception

Extract the text value of a path within the SOAP Body.

Parameters:

xpath - Path. Note: If Body elements don't have a prefix, use "b:" as the prefix.

Returns:

Value.

Throws:

Exception - If any error occurs.

getNumber

public Number getNumber(String xpath)
                 throws Exception

Extract the numeric value of a path within the SOAP Body.

Parameters:

xpath - Path. Note: If Body elements don't have a prefix, use "b:" as the prefix.

Returns:

Value.

Throws:

Exception - If any error occurs.

check

public boolean check(Node node,
 String xpath)
              throws Exception

Extract the boolean value of a path within the SOAP Body.

Parameters:

node - Node.

xpath - Path. Note: If Body elements don't have a prefix, use "b:" as the prefix.

Returns:

Value.

Throws:

Exception - If any error occurs.

getHeader

public Node getHeader()
               throws Exception

Get the SOAP Header node.

Returns:

Header node.

Throws:

Exception

getBody

public Node getBody()
             throws Exception

Get the SOAP Body node.

Returns:

Body node.

Throws:

Exception

getFault

public Node getFault()
              throws Exception

Get the SOAP Fault node (Available when response is received).

Returns:

Fault node. Null is returned if no Fault node exists.

Throws:

Exception

setTemplate

public void setTemplate(String templateSOAP)
                 throws Exception

Set the SOAP template. This method allows you to set a template XML for creating the SOAP request.

Note: If you don't have a template, you can just construct the XML by adding necessary sub-structures to the Header and/or Body nodes obtained via getHeader()/getBody().

Parameters:

templateSOAP - String representing the SOAP. If it is null or empty, a minimal SOAP template is automatically created.

Throws:

Exception - If the template is not a valid SOAP XML.

request

public void request()
             throws Exception

Send the request. After this call, the XML returned by getXML() will contain the SOAP response until it is reset via a call to setTemplate(String).

Throws:

Exception - Raised if any error occurs and in that case, the SOAP structure will be in an erroneous state.

requesting

public void requesting()

This method is invoked just before the request is sent to the server. You may apply additional controls to the HTTP request.

close

public void close()

Close the resources associated with this instance. This instance may not be used after calling this.

toString

public String toString()

Overrides:

toString in class Object

toPrettyString

public String toPrettyString()

Returns the XML associated with this SOAP request in a pretty string format.

Returns:

The XML in pretty string format.

setConnectTimeout

public void setConnectTimeout(int timeout)

Set the connection timeout for the HTTP request.

Parameters:

timeout - the connection timeout in milliseconds

setReadTimeout

public void setReadTimeout(int timeout)

Sets the read timeout for the HTTP connection.

Parameters:

timeout - The read timeout in milliseconds.