org.apache.commons.jelly.tags.jms
Class MessageTag

java.lang.Object
  extended byorg.apache.commons.jelly.TagSupport
      extended byorg.apache.commons.jelly.tags.jms.MessageTag
All Implemented Interfaces:
org.apache.commons.jelly.Tag
Direct Known Subclasses:
MapMessageTag, ObjectMessageTag, TextMessageTag

public class MessageTag
extends org.apache.commons.jelly.TagSupport

A tag which creates a JMS message

Version:
$Revision: 155420 $
Author:
James Strachan

Field Summary
private  org.apache.commons.messenger.Messenger connection
          The Messenger used to access the JMS connection
private  javax.jms.Message message
          The JMS Message created
private  java.lang.String var
          The name of the Message variable that is created
 
Fields inherited from class org.apache.commons.jelly.TagSupport
body, context, hasTrimmed, parent, shouldTrim
 
Constructor Summary
MessageTag()
           
 
Method Summary
 void addProperty(java.lang.String name, java.lang.Object value)
          Adds a JMS property to the message
protected  javax.jms.Message createMessage()
           
 void doTag(org.apache.commons.jelly.XMLOutput output)
           
protected  org.apache.commons.messenger.Messenger findConnection()
           
 org.apache.commons.messenger.Messenger getConnection()
           
 javax.jms.Message getMessage()
           
 void setConnection(org.apache.commons.messenger.Messenger connection)
          Sets the Messenger (the JMS connection pool) that will be used to send the message
 void setCorrelationID(java.lang.String correlationID)
          Sets the JMS Correlation ID to be used on the message
 void setReplyTo(javax.jms.Destination destination)
          Sets the reply-to destination to add to the message
 void setType(java.lang.String type)
          Sets the type name of the message
 void setVar(java.lang.String var)
          Sets the name of the variable that the message will be exported to
 
Methods inherited from class org.apache.commons.jelly.TagSupport
findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, findAncestorWithClass, getBody, getBodyText, getBodyText, getContext, getParent, invokeBody, isEscapeText, isTrim, setBody, setContext, setEscapeText, setParent, setTrim, trimBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

var

private java.lang.String var
The name of the Message variable that is created


message

private javax.jms.Message message
The JMS Message created


connection

private org.apache.commons.messenger.Messenger connection
The Messenger used to access the JMS connection

Constructor Detail

MessageTag

public MessageTag()
Method Detail

addProperty

public void addProperty(java.lang.String name,
                        java.lang.Object value)
                 throws org.apache.commons.jelly.JellyTagException
Adds a JMS property to the message

Throws:
org.apache.commons.jelly.JellyTagException

doTag

public void doTag(org.apache.commons.jelly.XMLOutput output)
           throws org.apache.commons.jelly.JellyTagException
Throws:
org.apache.commons.jelly.JellyTagException

setVar

public void setVar(java.lang.String var)
Sets the name of the variable that the message will be exported to


getConnection

public org.apache.commons.messenger.Messenger getConnection()
                                                     throws org.apache.commons.jelly.JellyTagException
Throws:
org.apache.commons.jelly.JellyTagException

setConnection

public void setConnection(org.apache.commons.messenger.Messenger connection)
Sets the Messenger (the JMS connection pool) that will be used to send the message


getMessage

public javax.jms.Message getMessage()
                             throws org.apache.commons.jelly.JellyTagException
Throws:
org.apache.commons.jelly.JellyTagException

setCorrelationID

public void setCorrelationID(java.lang.String correlationID)
                      throws org.apache.commons.jelly.JellyTagException
Sets the JMS Correlation ID to be used on the message

Throws:
org.apache.commons.jelly.JellyTagException

setReplyTo

public void setReplyTo(javax.jms.Destination destination)
                throws org.apache.commons.jelly.JellyTagException
Sets the reply-to destination to add to the message

Throws:
org.apache.commons.jelly.JellyTagException

setType

public void setType(java.lang.String type)
             throws org.apache.commons.jelly.JellyTagException
Sets the type name of the message

Throws:
org.apache.commons.jelly.JellyTagException

findConnection

protected org.apache.commons.messenger.Messenger findConnection()
                                                         throws org.apache.commons.jelly.JellyTagException
Throws:
org.apache.commons.jelly.JellyTagException

createMessage

protected javax.jms.Message createMessage()
                                   throws org.apache.commons.jelly.JellyTagException
Throws:
org.apache.commons.jelly.JellyTagException