org.osesb.utilities.jms
Class CreateJMSMessageHelper

java.lang.Object
  org.osesb.utilities.jms.CreateJMSMessageHelper

public class CreateJMSMessageHelper
extends java.lang.Object

A helper class to create JMS Messages using a JMS Session.

Since:

Version: 1.1

Field Summary

protected javax.jms.Session	session The JMS Session used by this helper.
protected java.lang.String	thisClassName The full name of this class.

Constructor Summary

CreateJMSMessageHelper(javax.jms.Session session)
Creates a new instance of CreateJMSMessageHelper.

Method Summary

void	checkSession() Checks for a valid JMS Session.
void	copyMessageStringProperties(javax.jms.Message inputMessage, javax.jms.Message outputMessage) Method to copy JMS header String properties from an input Message to an output Message.
javax.jms.BytesMessage	createBytesMessage() Method to create a BytesMessage
javax.jms.BytesMessage	createBytesMessage(javax.jms.BytesMessage inputMessage) Method to create an new BytesMessage based on another BytesMessage.
javax.jms.MapMessage	createMapMessage() Method to create an MapMessage
javax.jms.MapMessage	createMapMessage(javax.jms.MapMessage inputMessage) Method to create an new MapMessage based on another MapMessage.
javax.jms.Message	createMessage(javax.jms.Message inputMessage) Method to create a JMS message based on another JMS Message.
javax.jms.ObjectMessage	createObjectMessage() Method to create an ObjectMessage
javax.jms.ObjectMessage	createObjectMessage(javax.jms.ObjectMessage inputMessage) Method to create an new ObjectMessage based on another ObjectMessage.
javax.jms.StreamMessage	createStreamMessage() Method to create an StreamMessage
javax.jms.StreamMessage	createStreamMessage(javax.jms.StreamMessage inputMessage) Method to create an new StreamMessage based on another StreamMessage.
javax.jms.TextMessage	createTextMessage() Method to create an TextMessage
javax.jms.TextMessage	createTextMessage(javax.jms.TextMessage inputMessage) Method to create an new TextMessage based on another TextMessage.

Methods inherited from class java.lang.Object

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

Field Detail

thisClassName

protected java.lang.String thisClassName

The full name of this class.

session

protected javax.jms.Session session

The JMS Session used by this helper.

Constructor Detail

CreateJMSMessageHelper

public CreateJMSMessageHelper(javax.jms.Session session)
                       throws java.lang.Exception

Creates a new instance of CreateJMSMessageHelper.

Parameters:

session - The JMS session that this helper uses to create JMS messages.

Throws:

java.lang.Exception - if constructed with a null session.

Method Detail

createMessage

public javax.jms.Message createMessage(javax.jms.Message inputMessage)
                                throws java.lang.Exception

Method to create a JMS message based on another JMS Message.

Returns:

a new Message

Throws:

java.lang.Exception

createObjectMessage

public javax.jms.ObjectMessage createObjectMessage()
                                            throws java.lang.Exception

Method to create an ObjectMessage

Returns:

a new ObjectMessage

Throws:

java.lang.Exception

createObjectMessage

public javax.jms.ObjectMessage createObjectMessage(javax.jms.ObjectMessage inputMessage)
                                            throws java.lang.Exception

Method to create an new ObjectMessage based on another ObjectMessage.

Parameters:

inputMessage - The JMS message to copy.

Returns:

a new ObjectMessage

Throws:

java.lang.Exception

createTextMessage

public javax.jms.TextMessage createTextMessage()
                                        throws java.lang.Exception

Method to create an TextMessage

Returns:

a new TextMessage

Throws:

java.lang.Exception

createTextMessage

public javax.jms.TextMessage createTextMessage(javax.jms.TextMessage inputMessage)
                                        throws java.lang.Exception

Method to create an new TextMessage based on another TextMessage.

Parameters:

inputMessage - The JMS message to copy.

Returns:

a new TextMessage

Throws:

java.lang.Exception

createMapMessage

public javax.jms.MapMessage createMapMessage()
                                      throws java.lang.Exception

Method to create an MapMessage

Returns:

a new MapMessage

Throws:

java.lang.Exception

createMapMessage

public javax.jms.MapMessage createMapMessage(javax.jms.MapMessage inputMessage)
                                      throws java.lang.Exception

Method to create an new MapMessage based on another MapMessage.

Parameters:

inputMessage - The JMS message to copy.

Returns:

a new MapMessage

Throws:

java.lang.Exception

createBytesMessage

public javax.jms.BytesMessage createBytesMessage()
                                          throws java.lang.Exception

Method to create a BytesMessage

Returns:

a new BytesMessage

Throws:

java.lang.Exception

createBytesMessage

public javax.jms.BytesMessage createBytesMessage(javax.jms.BytesMessage inputMessage)
                                          throws java.lang.Exception

Method to create an new BytesMessage based on another BytesMessage.

Parameters:

inputMessage - The JMS message to copy.

Returns:

a new BytesMessage

Throws:

java.lang.Exception

createStreamMessage

public javax.jms.StreamMessage createStreamMessage()
                                            throws java.lang.Exception

Method to create an StreamMessage

Returns:

a new StreamMessage.

Throws:

java.lang.Exception - if constructed if there is a problem creating the message.

createStreamMessage

public javax.jms.StreamMessage createStreamMessage(javax.jms.StreamMessage inputMessage)
                                            throws java.lang.Exception

Method to create an new StreamMessage based on another StreamMessage.

Parameters:

inputMessage - The JMS message to copy.

Returns:

a new StreamMessage.

Throws:

java.lang.Exception - if constructed with a null inputMessage, or if there is a problem creating the message.

copyMessageStringProperties

public void copyMessageStringProperties(javax.jms.Message inputMessage,
                                        javax.jms.Message outputMessage)
                                 throws java.lang.Exception

Method to copy JMS header String properties from an input Message to an output Message.

Parameters:

inputMessage - The JMS message to copy header properties from.

outputMessage - The JMS message to copy header properties to.

Throws:

java.lang.Exception - if constructed with a null inputMessage, outputmessage, or if there is a problem copying the message properties.

checkSession

public void checkSession()
                  throws java.lang.Exception

Checks for a valid JMS Session.

Throws:

java.lang.Exception