com.whitestein.lsps.ws.util

Class WsSoapMessageParser

java.lang.Object

com.whitestein.lsps.ws.util.WsSoapMessageParser

public class WsSoapMessageParser
extends Object

This class is used for parsing web service xml responses based on output type and and soap fault types. To parse the request, it also utilize the metadata from the types appearing in the output type.

Author:

mbj

Constructor Summary

Constructors

Constructor and Description
WsSoapMessageParser(ExecutionContext context, Type outputType, List<RecordType> soapFaultTypes, Map<String,String> metadata, String metadataPrefix, boolean useDefaultMapping, BinaryDataService binaryDataService, CoreTypeFactory coreTypeFactory) Constructs new instance initialized with given output type and soap fault types.

Method Summary

Modifier and Type	Method and Description
Object	parseMessage(Document document, ReferenceHolder errorReference, ListHolder headersReferenceList) Parse the response from the given xml document and store the result to the passed reference.
void	parseMessage(Document document, ReferenceHolder objectReference, ReferenceHolder errorReference, ListHolder headersReferenceList) Parse the response from the given xml document and store the result to the passed reference.
Object	parseMessage(String document, ReferenceHolder errorReference, ListHolder headersReferenceList) Parse the response from the given xml string and store the result to the passed reference
void	parseMessage(String document, ReferenceHolder objectReference, ReferenceHolder errorReference, ListHolder headersReferenceList) Parse the response from the given xml string and store the result to the passed reference

Methods inherited from class java.lang.Object

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

Constructor Detail

WsSoapMessageParser

public WsSoapMessageParser(ExecutionContext context,
                           Type outputType,
                           List<RecordType> soapFaultTypes,
                           Map<String,String> metadata,
                           String metadataPrefix,
                           boolean useDefaultMapping,
                           BinaryDataService binaryDataService,
                           CoreTypeFactory coreTypeFactory)

Constructs new instance initialized with given output type and soap fault types. The parameter factory serves for instantiation of process variables.

Parameters:

context - the execution context

outputType - output type to which the response should be parsed

soapFaultTypes - possible types of soap faults. There should be always at least one generic soap fault to which any soap fault can be parsed

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

metadataPrefix - prefix prefix of 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

coreTypeFactory - the core type factory

Method Detail

parseMessage

public Object parseMessage(String document,
                           ReferenceHolder errorReference,
                           ListHolder headersReferenceList)
                    throws XmlProcessingException,
                           WsCallException,
                           SoapFaultException,
                           SAXException,
                           IOException,
                           ErrorException

Parse the response from the given xml string and store the result to the passed reference

Parameters:

document - xml document containing web service soap xml response

errorReference - reference where soap fault should be stored

headersReferenceList - references where soap headers should be stored

Returns:

call result

Throws:

XmlProcessingException - if any xml parsing related problem occurs

WsCallException - occurs if any web service parsing related problem occurs

SoapFaultException - occurs if there was a soap fault in the response

SAXException - occurs if the response can not be parsed, thus it is not the valid XML

IOException - shouldn't occur in normal cases. Occur only if there is some io problem while reading the document

ErrorException

parseMessage

public void parseMessage(String document,
                         ReferenceHolder objectReference,
                         ReferenceHolder errorReference,
                         ListHolder headersReferenceList)
                  throws XmlProcessingException,
                         WsCallException,
                         SoapFaultException,
                         SAXException,
                         IOException,
                         ErrorException

Parse the response from the given xml string and store the result to the passed reference

Parameters:

document - xml document containing web service soap xml response

objectReference - reference where the parsed object should be stored

errorReference - reference where soap fault should be stored

headersReferenceList - references where soap headers should be stored

Throws:

XmlProcessingException - if any xml parsing related problem occurs

WsCallException - occurs if any web service parsing related problem occurs

SoapFaultException - occurs if there was a soap fault in the response

SAXException - occurs if the response can not be parsed, thus it is not the valid XML

IOException - shouldn't occur in normal cases. Occur only if there is some io problem while reading the document

ErrorException

parseMessage

public Object parseMessage(Document document,
                           ReferenceHolder errorReference,
                           ListHolder headersReferenceList)
                    throws XmlProcessingException,
                           WsCallException,
                           SoapFaultException,
                           SAXException,
                           IOException,
                           ErrorException

Parse the response from the given xml document and store the result to the passed reference.

Parameters:

document - xml document containing web service soap xml response

errorReference - reference where soap fault should be stored

headersReferenceList - references where soap headers should be stored

Returns:

call result

Throws:

XmlProcessingException - if any xml parsing related problem occurs

WsCallException - occurs if any web service parsing related problem occurs

SoapFaultException - occurs if there was a soap fault in the response

SAXException - occurs if the response can not be parsed, thus it is not the valid XML

IOException - shouldn't occur in normal cases. Occur only if there is some io problem while reading the document

ErrorException

parseMessage

public void parseMessage(Document document,
                         ReferenceHolder objectReference,
                         ReferenceHolder errorReference,
                         ListHolder headersReferenceList)
                  throws XmlProcessingException,
                         WsCallException,
                         SoapFaultException,
                         SAXException,
                         IOException,
                         ErrorException

Parse the response from the given xml document and store the result to the passed reference.

Parameters:

document - xml document containing web service soap xml response

objectReference - reference where the parsed object should be stored

errorReference - reference where soap fault should be stored

headersReferenceList - references where soap headers should be stored

Throws:

XmlProcessingException - if any xml parsing related problem occurs

WsCallException - occurs if any web service parsing related problem occurs

SoapFaultException - occurs if there was a soap fault in the response

SAXException - occurs if the response can not be parsed, thus it is not the valid XML

IOException - shouldn't occur in normal cases. Occur only if there is some io problem while reading the document

ErrorException