Tag Documentation

[tag libraries] [tags]

The following document contains a summary of all theJellytag libraries.

Tag Libraries

[tag libraries] [tags]

LibraryDescription
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 NameDescription
connectionDefines a JMS connection for use by other JMS tags.
destinationCreates a Destination object from a String name.
mapEntryAdds a map entry to the outer Map Message tag
mapMessageCreates a JMS MapMessage
messageA tag which creates a JMS message
objectMessageCreates a JMS ObjectMessage
onMessageThis 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.
propertyDefines a property on an outer JMS Message tag
receiveReceives a JMS message.
sendSends a JMS message to some destination.
stopwatchThis 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.
subscribePerforms 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).
textMessageCreates a JMS TextMessage

Tags

[tag libraries] [tags]

jms:connection

Defines a JMS connection for use by other JMS tags.

Attribute NameTypeDescription
escapeTextboolean
namejava.lang.StringSets the name of the Messenger (JMS connection pool) to use
trimboolean
varjava.lang.StringSets the variable name to use for the exported Messenger (JMS connection pool)

jms:destination

Creates a Destination object from a String name.

Attribute NameTypeDescription
escapeTextboolean
namejava.lang.StringSets the name of the Destination
trimboolean
varjava.lang.StringSets the variable name to use for the Destination

jms:mapEntry

Adds a map entry to the outer Map Message tag

Attribute NameTypeDescription
escapeTextboolean
namejava.lang.StringSets the name of the entry in the map message
trimboolean
valuejava.lang.ObjectSets 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 NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
correlationIDjava.lang.StringSets the JMS Correlation ID to be used on the message
escapeTextboolean
mapjava.util.MapSets the Map of entries to be used for this Map Message
replyTojavax.jms.DestinationSets the reply-to destination to add to the message
trimboolean
typejava.lang.StringSets the type name of the message
varjava.lang.StringSets the name of the variable that the message will be exported to

jms:message

A tag which creates a JMS message

Attribute NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
correlationIDjava.lang.StringSets the JMS Correlation ID to be used on the message
escapeTextboolean
replyTojavax.jms.DestinationSets the reply-to destination to add to the message
trimboolean
typejava.lang.StringSets the type name of the message
varjava.lang.StringSets the name of the variable that the message will be exported to

jms:objectMessage

Creates a JMS ObjectMessage

Attribute NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
correlationIDjava.lang.StringSets the JMS Correlation ID to be used on the message
escapeTextboolean
objectjava.io.SerializableSets 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.
replyTojavax.jms.DestinationSets the reply-to destination to add to the message
trimboolean
typejava.lang.StringSets the type name of the message
varjava.lang.StringSets the name of the variable that the message will be exported to

jms: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.

Attribute NameTypeDescription
escapeTextboolean
trimboolean
varjava.lang.StringSets 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 NameTypeDescription
escapeTextboolean
namejava.lang.StringSets the name of the JMS property
trimboolean
valuejava.lang.ObjectSets 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 NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
destinationjavax.jms.DestinationSets the JMS Destination to be used by this tag
escapeTextboolean
subjectjava.lang.StringSets the subject as a String which is used to create theJMS Destination to be used by this tag
timeoutlongSets the timeout period in milliseconds to wait for a message. A valueof -1 will wait forever for a message.
trimboolean
varjava.lang.StringSets 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 NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
destinationjavax.jms.DestinationSets the JMS Destination to be used by this tag
escapeTextboolean
messagejavax.jms.MessageSets the JMS message to be sent
subjectjava.lang.StringSets the subject as a String which is used to create theJMS Destination to be used by this tag
trimboolean

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 NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
destinationjavax.jms.DestinationSets the JMS Destination to be used by this tag
escapeTextboolean
groupSizeintSets the number of messages in the group before the performance statistics are logged
logorg.apache.commons.logging.LogSets the logger to which statistic messages will be sent
messageListenerjavax.jms.MessageListenerSets the JMS messageListener used to consume JMS messages on the given destination
subjectjava.lang.StringSets the subject as a String which is used to create theJMS Destination to be used by this tag
trimboolean

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 NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
destinationjavax.jms.DestinationSets the JMS Destination to be used by this tag
escapeTextboolean
messageListenerjavax.jms.MessageListenerSets the JMS messageListener used ot consume JMS messages on the given destination
selectorjava.lang.StringSets the optional JMS Message selector for the subscription
subjectjava.lang.StringSets the subject as a String which is used to create theJMS Destination to be used by this tag
trimboolean

jms:textMessage

Creates a JMS TextMessage

Attribute NameTypeDescription
connectionorg.apache.commons.messenger.MessengerSets the Messenger (the JMS connection pool) that will be used to send the message
correlationIDjava.lang.StringSets the JMS Correlation ID to be used on the message
escapeTextboolean
replyTojavax.jms.DestinationSets the reply-to destination to add to the message
textjava.lang.StringSets 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.
trimboolean
typejava.lang.StringSets the type name of the message
varjava.lang.StringSets the name of the variable that the message will be exported to