com.whitestein.lsps.ws.util

Class WsSoapMessageBuilder

java.lang.Object

com.whitestein.lsps.ws.util.WsSoapMessageBuilder

public class WsSoapMessageBuilder
extends java.lang.Object

This class is used for building web service xml messages based on object type and object instance. To build the message, it also utilize metadata from the types appearing in the input instance.

Author:

mbj

Constructor Summary

Constructors

Constructor and Description
WsSoapMessageBuilder(java.util.Map<java.lang.String,java.lang.String> metadata, Type type, java.lang.String metadataPrefix, boolean useDefaultMapping, BinaryDataService binaryDataService) Construct new instance for given input type

Method Summary

Modifier and Type	Method and Description
protected void	appendRequestSoapHeaders(java.util.List<java.lang.Object> headers, org.w3c.dom.Document doc, org.w3c.dom.Element envelope) Add request headers.
java.lang.String	buildMessage(java.lang.Object object, java.util.List<java.lang.Object> headers, boolean fault) Build the request xml for given input instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsSoapMessageBuilder

public WsSoapMessageBuilder(java.util.Map<java.lang.String,java.lang.String> metadata,
                            Type type,
                            java.lang.String metadataPrefix,
                            boolean useDefaultMapping,
                            BinaryDataService binaryDataService)

Construct new instance for given input type

Parameters:

metadata - metadata that should be used for request construction. Basically these are the metadata of task generated by modelling tool.

type - LSPS type of input object

metadataPrefix - prefix that should be used for metadata names

useDefaultMapping - determines if the default LSPS to xml mapping should be used, or the mapping should be based on types metadata information

binaryDataService - the binary data service

Method Detail

appendRequestSoapHeaders

protected void appendRequestSoapHeaders(java.util.List<java.lang.Object> headers,
                                        org.w3c.dom.Document doc,
                                        org.w3c.dom.Element envelope)
                                 throws WsCallException,
                                        XmlProcessingException

Add request headers. To be overriden by subclasses which need to add custom soap headers

Parameters:

headers -

doc -

envelope -

Throws:

WsCallException

XmlProcessingException

buildMessage

public java.lang.String buildMessage(java.lang.Object object,
                                     java.util.List<java.lang.Object> headers,
                                     boolean fault)
                              throws WsCallException,
                                     javax.xml.transform.TransformerException,
                                     XmlProcessingException

Build the request xml for given input instance.

Parameters:

object - input instance, can be null

headers - list of objects which will be serialized as content of soap:header element

fault - determines if the generated message should be soap fault or regular soap message. If true, given object is transformed to xml as element inside detail element

Returns:

the soap xml, which can be used as web service request.

Throws:

XmlProcessingException - if any xml building related problem occurs

WsCallException - occurs if any web service generation related problem occurs

javax.xml.transform.TransformerException - occurs only if there is problem with transformation of DOM tree to the string. Shouldn't occur in common cases