raccoon.api.eai.badhnati
Interface IXmlToMessage

All Superinterfaces:

IBadhnAti

All Known Implementing Classes:

XmlParser

public interface IXmlToMessage
extends IBadhnAti

Provides conversion methods between IMessage and XML Strings.

This extension of IBadhnAti provides means of:

• Marshal
  XML String to IMessage: converts any XML source into an IMessage instance.
• Unmarshal
IBusMessage to XML: converts the contents of the IMessage into a valid XML String.

Since:

Raccoon v1.0

Version:

$Id: IXmlToMessage.java,v 1.1 2004/08/08 20:25:55 crouvrais Exp $

Author:

Cedric ROUVRAIS

Method Summary

IMessage	marshal(org.xml.sax.InputSource pXmlSource) Converts a given XML compliant string into a message instance.
IMessage	marshal(java.io.Reader pXmlReader) Converts a given XML compliant string into a message instance.
IMessage	marshal(java.lang.String pXmlMsg) Converts a given XML compliant string into a IMessage instance.
java.lang.String	unmarshal(IMessage pMessage) Converts the provided IMessage instance into an XML String representation.

Method Detail

marshal

IMessage marshal(java.lang.String pXmlMsg)
                 throws RaccoonException

Converts a given XML compliant string into a IMessage instance.

Parameters:

pXmlMsg - the XML string

Returns:

the IMessage instance.

Throws:

RaccoonException - if the XML string is invalid.

marshal

IMessage marshal(java.io.Reader pXmlReader)
                 throws RaccoonException

Converts a given XML compliant string into a message instance.

Parameters:

pXmlReader - the XML reader

Returns:

the IMessage instance.

Throws:

RaccoonException - if the XML string is invalid.

marshal

IMessage marshal(org.xml.sax.InputSource pXmlSource)
                 throws RaccoonException

Converts a given XML compliant string into a message instance.

Parameters:

pXmlSource - the XML input source to use.

Returns:

the IMessage instance.

Throws:

RaccoonException - if the XML string is invalid.

unmarshal

java.lang.String unmarshal(IMessage pMessage)
                           throws RaccoonException

Converts the provided IMessage instance into an XML String representation.

Parameters:

pMessage - the message to be converted

Returns:

the result of the conversion

Throws:

RaccoonException - if the conversion fails.