weblogic.jms.common

Class XMLHelper

java.lang.Object

weblogic.jms.common.XMLHelper

public class XMLHelper
extends java.lang.Object

This helper class provides methods for transforming JMS Messages to/from XML representations as defined by the WebLogic JMS message schema. see weblogic/jms/extensions/weblogic900-wls-message.xsd

Excluded in public API Reference.

Constructor Summary

Constructors

Constructor and Description
XMLHelper()

Method Summary

Modifier and Type	Method and Description
private static void	createBytesBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, BytesMessageImpl bytesMessage)
private static void	createHeader(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage wlJMSMessage, MessageImpl wlmsg, java.util.List headers, java.util.List properties)
private static void	createHeaderProperties(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header, MessageImpl wlmsg, java.util.List properties)
private static void	createMapBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, MapMessageImpl mapMessage)
static WLMessage	createMessage(org.w3c.dom.Document doc) Creates a WLMessage given a DOM representation of a WebLogic JMS Message.
static WLMessage	createMessage(java.lang.String xmlText) Creates a WLMessage given an XML string representation of a WebLogic JMS Message.
private static WLMessage	createMessage(com.bea.wls.jms.message.WLJMSMessageDocument doc)
private static void	createObjectBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, ObjectMessageImpl objectMessage)
private static void	createStreamBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, StreamMessageImpl streamMessage)
private static void	createTextBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, TextMessageImpl textMessage)
private static void	createXMLBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, XMLMessageImpl xmlMessage)
private static org.w3c.dom.Element	getBodyTypeElement(org.w3c.dom.Node bodyNode)
static org.w3c.dom.Document	getDocument(WLMessage wlMessage) Returns a DOM Document object given a WebLogic JMS Message.
(package private) static org.w3c.dom.Document	getDocument(WLMessage wlMessage, java.util.List headers, java.util.List properties, boolean withBody) Given a WLMessage, returns a DOM Document representation of the message content.
private static JMSMessageId	getMessageId(java.lang.String id)
private static com.bea.wls.jms.message.WLJMSMessageDocument	getWLJMSMessageDocument(WLMessage wlMessage, java.util.List headers, java.util.List properties, boolean withBody)
static java.lang.String	getXMLText(WLMessage wlMessage) Given a JMS Message, returns the content of the message in XML text representation.
static java.lang.String	getXMLText(WLMessage wlMessage, boolean withBody) Given a JMS Message, return the content of the message in XML text representation.
static org.w3c.dom.Document	parse(java.lang.String xml) Parses an XML document in text representation and returns a DOM Document.
private static void	processBytesBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, BytesMessageImpl bytesMessage)
private static void	processHeader(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header, WLMessage wlMessage)
private static void	processHeaderProperties(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header, WLMessage wlMessage)
private static void	processMapBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, MapMessageImpl mapMessage)
private static void	processObjectBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, ObjectMessageImpl objectMessage)
private static void	processStreamBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, StreamMessageImpl streamMessage)
private static void	processTextBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, TextMessageImpl textMessage)
private static void	processXMLBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body, XMLMessageImpl xmlMessage)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLHelper

public XMLHelper()

Method Detail

getDocument

public static org.w3c.dom.Document getDocument(WLMessage wlMessage)
                                        throws javax.jms.JMSException

Returns a DOM Document object given a WebLogic JMS Message.

Parameters:

wlMessage - The message to represent in XML

Returns:

A DOM Document representation of the message

Throws:

JMSException - Thrown when an error occurs during processing

javax.jms.JMSException

getXMLText

public static java.lang.String getXMLText(WLMessage wlMessage,
                                          boolean withBody)
                                   throws javax.jms.JMSException

Given a JMS Message, return the content of the message in XML text representation.

Parameters:

wlMessage - A WLMessage instance.

withBody - Indicates whether to include the message body in the XML.

Returns:

An XML text representation of the message.

Throws:

JMSException

javax.jms.JMSException

getXMLText

public static java.lang.String getXMLText(WLMessage wlMessage)
                                   throws javax.jms.JMSException

Given a JMS Message, returns the content of the message in XML text representation.

Parameters:

wlMessage - A WLMessage instance.

Returns:

An XML text representation of the message.

Throws:

JMSException - Thrown when an error occurs during processing

javax.jms.JMSException

getDocument

static org.w3c.dom.Document getDocument(WLMessage wlMessage,
                                        java.util.List headers,
                                        java.util.List properties,
                                        boolean withBody)
                                 throws javax.jms.JMSException

Given a WLMessage, returns a DOM Document representation of the message content. This method is used internally by the message logging facility.

Parameters:

wlMessage - The message to convert

headers - The set of JMS message headers to include in the XML.

properties - The set of JMS message properties to include in the XML.

withBody - Indicates whether the message body should be included.

Returns:

@throws JMSException Thrown when an error occurs during conversion.

Throws:

javax.jms.JMSException

See Also:

JMSMessageLogHelper.getMessageDocument(MessageImpl, List, List)

createMessage

public static WLMessage createMessage(org.w3c.dom.Document doc)
                               throws javax.jms.JMSException,
                                      java.io.IOException,
                                      java.lang.ClassNotFoundException

Creates a WLMessage given a DOM representation of a WebLogic JMS Message.

Parameters:

doc - A DOM representation of a message.

Returns:

Returns a new message instance based on the values found in the DOM representation.

Throws:

org.w3c.dom.DOMException - Thrown when an error occurs while processing the DOM tree.

JMSException - Thrown when an error occurs while creating the JMS Message

java.io.IOException - Thrown while processing binary information in the DOM representation

java.lang.ClassNotFoundException - Thrown when the class definition for an ObjectMessage payload could not be resolved.

javax.jms.JMSException

createMessage

public static WLMessage createMessage(java.lang.String xmlText)
                               throws javax.jms.JMSException,
                                      java.io.IOException,
                                      java.lang.ClassNotFoundException

Creates a WLMessage given an XML string representation of a WebLogic JMS Message.

Parameters:

doc - A XML text representation of a message.

Returns:

Returns a new message instance based on the values found in the DOM representation.

Throws:

org.w3c.dom.DOMException - Thrown when an error occurs while processing the DOM tree.

JMSException - Thrown when an error occurs while creating the JMS Message

java.io.IOException - Thrown while processing binary information in the DOM representation

java.lang.ClassNotFoundException - Thrown when the class definition for an ObjectMessage payload could not be resolved.

javax.jms.JMSException

createMessage

private static WLMessage createMessage(com.bea.wls.jms.message.WLJMSMessageDocument doc)
                                throws javax.jms.JMSException,
                                       java.io.IOException,
                                       java.lang.ClassNotFoundException

Throws:

javax.jms.JMSException

java.io.IOException

java.lang.ClassNotFoundException

parse

public static org.w3c.dom.Document parse(java.lang.String xml)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         org.xml.sax.SAXException,
                                         java.io.IOException

Parses an XML document in text representation and returns a DOM Document.

Parameters:

xml - String representation of an XML document.

Returns:

The DOM representation of the document.

Throws:

javax.xml.parsers.ParserConfigurationException - Encountered a JAXP parser configuration error.

org.xml.sax.SAXException - An error occurred while parsing the document.

java.io.IOException - An IO error occurred while parsing the document.

getWLJMSMessageDocument

private static com.bea.wls.jms.message.WLJMSMessageDocument getWLJMSMessageDocument(WLMessage wlMessage,
                                                                                    java.util.List headers,
                                                                                    java.util.List properties,
                                                                                    boolean withBody)
                                                                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getMessageId

private static JMSMessageId getMessageId(java.lang.String id)

processHeader

private static void processHeader(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header,
                                  WLMessage wlMessage)
                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getBodyTypeElement

private static org.w3c.dom.Element getBodyTypeElement(org.w3c.dom.Node bodyNode)

processXMLBody

private static void processXMLBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                   XMLMessageImpl xmlMessage)
                            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

processMapBody

private static void processMapBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                   MapMessageImpl mapMessage)
                            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

processStreamBody

private static void processStreamBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                      StreamMessageImpl streamMessage)
                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

processBytesBody

private static void processBytesBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                     BytesMessageImpl bytesMessage)
                              throws javax.jms.JMSException

Throws:

javax.jms.JMSException

processObjectBody

private static void processObjectBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                      ObjectMessageImpl objectMessage)
                               throws javax.jms.JMSException,
                                      java.io.IOException,
                                      java.lang.ClassNotFoundException

Throws:

javax.jms.JMSException

java.io.IOException

java.lang.ClassNotFoundException

processTextBody

private static void processTextBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                    TextMessageImpl textMessage)
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

processHeaderProperties

private static void processHeaderProperties(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header,
                                            WLMessage wlMessage)
                                     throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createHeader

private static void createHeader(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage wlJMSMessage,
                                 MessageImpl wlmsg,
                                 java.util.List headers,
                                 java.util.List properties)
                          throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createHeaderProperties

private static void createHeaderProperties(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Header header,
                                           MessageImpl wlmsg,
                                           java.util.List properties)
                                    throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createTextBody

private static void createTextBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                   TextMessageImpl textMessage)
                            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createStreamBody

private static void createStreamBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                     StreamMessageImpl streamMessage)
                              throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createBytesBody

private static void createBytesBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                    BytesMessageImpl bytesMessage)
                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createMapBody

private static void createMapBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                  MapMessageImpl mapMessage)
                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createObjectBody

private static void createObjectBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                     ObjectMessageImpl objectMessage)
                              throws javax.jms.JMSException

Throws:

javax.jms.JMSException

createXMLBody

private static void createXMLBody(com.bea.wls.jms.message.WLJMSMessageDocument.WLJMSMessage.Body body,
                                  XMLMessageImpl xmlMessage)
                           throws com.bea.xml.XmlException,
                                  javax.jms.JMSException

Throws:

com.bea.xml.XmlException

javax.jms.JMSException