JMS Tag Library - Tag Documentation

Tag Documentation

The following document contains a summary of all theJellytag libraries.

Tag Libraries

Library	Description
jelly:jms	A tag library for working with JMS using the Messenger project

jelly:jms

A tag library for working with JMS using the Messenger project

Tag Name	Description
connection	Defines a JMS connection for use by other JMS tags.
destination	Creates a Destination object from a String name.
mapEntry	Adds a map entry to the outer Map Message tag
mapMessage	Creates a JMS MapMessage
message	A tag which creates a JMS message
objectMessage	Creates a JMS ObjectMessage
onMessage	This tag creates a JMS MessageListener which will invoke thistag's body whenever a JMS Message is received. The JMS Messagewill be available via a variable, which defaults to the 'message'variable name, but can be overloaded by the var attribute.
property	Defines a property on an outer JMS Message tag
receive	Receives a JMS message.
send	Sends a JMS message to some destination.
stopwatch	This tag can be used to measure the amount of time it takes to process JMS messages.This tag can be wrapped around any custom JMS tag which consumes JMS messages.
subscribe	Performs a subscription to some JMS connection to a destination maybe with a selector.A JMS MessageListener can be specified, or a special child tag can explicitly set it onits parent (so a special tag could construct a MessageListener object and register it with this tag).
textMessage	Creates a JMS TextMessage

Tags

[tag libraries] [tags]

jms:connection

Defines a JMS connection for use by other JMS tags.

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the Messenger (JMS connection pool) to use
trim	boolean
var	java.lang.String	Sets the variable name to use for the exported Messenger (JMS connection pool)

jms:destination

Creates a Destination object from a String name.

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the Destination
trim	boolean
var	java.lang.String	Sets the variable name to use for the Destination

jms:mapEntry

Adds a map entry to the outer Map Message tag

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the entry in the map message
trim	boolean
value	java.lang.Object	Sets the value of the entry in the map message.If no value is set then the body of the tag is used

jms:mapMessage

Creates a JMS MapMessage

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
correlationID	java.lang.String	Sets the JMS Correlation ID to be used on the message
escapeText	boolean
map	java.util.Map	Sets the Map of entries to be used for this Map Message
replyTo	javax.jms.Destination	Sets the reply-to destination to add to the message
trim	boolean
type	java.lang.String	Sets the type name of the message
var	java.lang.String	Sets the name of the variable that the message will be exported to

jms:message

A tag which creates a JMS message

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
correlationID	java.lang.String	Sets the JMS Correlation ID to be used on the message
escapeText	boolean
replyTo	javax.jms.Destination	Sets the reply-to destination to add to the message
trim	boolean
type	java.lang.String	Sets the type name of the message
var	java.lang.String	Sets the name of the variable that the message will be exported to

jms:objectMessage

Creates a JMS ObjectMessage

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
correlationID	java.lang.String	Sets the JMS Correlation ID to be used on the message
escapeText	boolean
object	java.io.Serializable	Sets the body of the message, a serializable java object.If this value is not set or the value is null then the contentof the tag will be used instead.
replyTo	javax.jms.Destination	Sets the reply-to destination to add to the message
trim	boolean
type	java.lang.String	Sets the type name of the message
var	java.lang.String	Sets the name of the variable that the message will be exported to

This tag creates a JMS MessageListener which will invoke thistag's body whenever a JMS Message is received. The JMS Messagewill be available via a variable, which defaults to the 'message'variable name, but can be overloaded by the var attribute.

Attribute Name	Type	Description
escapeText	boolean
trim	boolean
var	java.lang.String	Sets the name of the variable used to make the JMS message available to this tagsbody when a message is received.

jms:property

Defines a property on an outer JMS Message tag

Attribute Name	Type	Description
escapeText	boolean
name	java.lang.String	Sets the name of the JMS property
trim	boolean
value	java.lang.Object	Sets the value of the JMS property.If no value is set then the body of the tag is used

jms:receive

Receives a JMS message.

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
destination	javax.jms.Destination	Sets the JMS Destination to be used by this tag
escapeText	boolean
subject	java.lang.String	Sets the subject as a String which is used to create theJMS Destination to be used by this tag
timeout	long	Sets the timeout period in milliseconds to wait for a message. A valueof -1 will wait forever for a message.
trim	boolean
var	java.lang.String	Sets the variable name to create for the received message, which will be null if nomessage could be returned in the given time period.

jms:send

Sends a JMS message to some destination.

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
destination	javax.jms.Destination	Sets the JMS Destination to be used by this tag
escapeText	boolean
message	javax.jms.Message	Sets the JMS message to be sent
subject	java.lang.String	Sets the subject as a String which is used to create theJMS Destination to be used by this tag
trim	boolean

jms:stopwatch

This tag can be used to measure the amount of time it takes to process JMS messages.This tag can be wrapped around any custom JMS tag which consumes JMS messages.

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
destination	javax.jms.Destination	Sets the JMS Destination to be used by this tag
escapeText	boolean
groupSize	int	Sets the number of messages in the group before the performance statistics are logged
log	org.apache.commons.logging.Log	Sets the logger to which statistic messages will be sent
messageListener	javax.jms.MessageListener	Sets the JMS messageListener used to consume JMS messages on the given destination
subject	java.lang.String	Sets the subject as a String which is used to create theJMS Destination to be used by this tag
trim	boolean

jms:subscribe

Performs a subscription to some JMS connection to a destination maybe with a selector.A JMS MessageListener can be specified, or a special child tag can explicitly set it onits parent (so a special tag could construct a MessageListener object and register it with this tag).

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
destination	javax.jms.Destination	Sets the JMS Destination to be used by this tag
escapeText	boolean
messageListener	javax.jms.MessageListener	Sets the JMS messageListener used ot consume JMS messages on the given destination
selector	java.lang.String	Sets the optional JMS Message selector for the subscription
subject	java.lang.String	Sets the subject as a String which is used to create theJMS Destination to be used by this tag
trim	boolean

jms:textMessage

Creates a JMS TextMessage

Attribute Name	Type	Description
connection	org.apache.commons.messenger.Messenger	Sets the Messenger (the JMS connection pool) that will be used to send the message
correlationID	java.lang.String	Sets the JMS Correlation ID to be used on the message
escapeText	boolean
replyTo	javax.jms.Destination	Sets the reply-to destination to add to the message
text	java.lang.String	Sets the body of the message, a String. If this value is not set orthe value is null then the content of the tag will be used instead.
trim	boolean
type	java.lang.String	Sets the type name of the message
var	java.lang.String	Sets the name of the variable that the message will be exported to