Spring Web Services Framework

org.springframework.ws.client.core
Interface WebServiceMessageExtractor


public interface WebServiceMessageExtractor

Callback interface for extracting a result object from a WebServiceMessage instance.

Used for output object creation in WebServiceTemplate. Alternatively, output messages can also be returned to client code as-is. In case of a message as execution result, you will almost always want to implement a WebServiceMessageExtractor, to be able to read the message in a managed fashion, with the connection still open while reading the message.

Implementations of this interface perform the actual work of extracting results, but don't need to worry about exception handling, or resource handling.

Since:
1.0.0
Author:
Arjen Poutsma

Method Summary
 Object extractData(WebServiceMessage message)
          Process the data in the given WebServiceMessage, creating a corresponding result object.
 

Method Detail

extractData

Object extractData(WebServiceMessage message)
                   throws IOException,
                          TransformerException
Process the data in the given WebServiceMessage, creating a corresponding result object.

Parameters:
message - the message to extract data from (possibly a SoapMessage)
Returns:
an arbitrary result object, or null if none (the extractor will typically be stateful in the latter case)
Throws:
IOException - in case of I/O errors
TransformerException - in case of transformation errors

Spring Web Services Framework

Copyright © 2005-2010 The Spring Web Services Framework. All Rights Reserved.