IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.wsrf
Interface BaseFaultBinderHelper


public interface BaseFaultBinderHelper

The BaseFaultBinderHelper interface provides support for serializing and deserializing the data that is specific to a root BaseFault class, which all specialized BaseFault classes must extend. For an application-level, specialized BaseFault, a custom binder must be provided to define how the Web Services runtime serializes the Java class into an appropriate XML message, and conversely how to deserialize an XML message into an instance of the Java class. If a custom binder uses the BaseFaultBinderHelper support, the custom binder then needs to provide only the additional logic for serializing and deserializing the extended data. An instance of BaseFaultBinderHelper can be retrieved through the BaseFaultBinderHelperFactory.


Method Summary
 javax.xml.soap.SOAPElement[] deserialize(BaseFault baseFault, javax.xml.soap.SOAPElement soapElement)
          Deserializes a SOAPElement into the supplied specialized BaseFault.
 javax.xml.soap.SOAPElement serialize(javax.xml.soap.SOAPElement root, BaseFault baseFault)
          Serializes the supplied specialized BaseFault into a SOAPElement.
 

Method Detail

serialize

javax.xml.soap.SOAPElement serialize(javax.xml.soap.SOAPElement root,
                                     BaseFault baseFault)
                                     throws javax.xml.soap.SOAPException
Serializes the supplied specialized BaseFault into a SOAPElement. This method is intended for use by a specialized BaseFault's custom binder and allows for re-use of the serialize logic for a root BaseFault.

Parameters:
rootNode - into which the object should be placed
baseFault - the specialized BaseFault to be serialized
Returns:
SOAPElement representing the serialised form of the specialized BaseFault passed as a parameter
Throws:
javax.xml.soap.SOAPException - if a problem occurs during serialization

deserialize

javax.xml.soap.SOAPElement[] deserialize(BaseFault baseFault,
                                         javax.xml.soap.SOAPElement soapElement)
                                         throws javax.xml.soap.SOAPException
Deserializes a SOAPElement into the supplied specialized BaseFault. This method is provided to allow re-use of the deserialize logic for a root BaseFault. Any additional elements which form part of the specialized BaseFault will be returned within a SOAPElement[] to allow for extension-specific handling of these within the specialized BaseFault's custom binder.

Parameters:
baseFault - the specialized BaseFault into which the SOAPElement is deserialized
rootNode - the SOAPElement to be deserialized
Returns:
SOAPElement[] array of unprocessed SOAPElements, which form part of the specialized BaseFault.
Throws:
javax.xml.soap.SOAPException - if a problem occurs during deserialization

IBM WebSphere Application ServerTM
Release 8