Browse-Queue
Selects a message or set of messages in a queue, allowing the properties on messages to be viewed while not actually returning message content.
|
|
This webject can be used only after your environment has been set up for messaging or for queuing tasks.
|
SYNTAX
<ie:webject name="Browse-Queue" type="MSG">
<ie:param name="ATTRIBUTE" data="attribute_name"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="GROUP_OUT" data="group_name"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="QUEUE" data="managed_queue_name"/>
<ie:param name="WHERE" data="message_selector"/>
</ie:webject>
PARAMETERS
|
Required
|
Select
|
Optional
|
|
QUEUE
|
|
ATTRIBUTE
|
|
|
DBUSER
|
|
|
SERVICE
|
|
|
GROUP_OUT
|
|
|
PASSWD
|
|
|
WHERE
|
ATTRIBUTE
Specifies which JMS properties should be added to the output group as attributes. In addition to properties manually set on a message at the time of queuing the following JMS-specific properties can be returned as well:
◦ JMSDestination
◦ JMSDeliveryMode
◦ JMSMessageID
◦ JMSTimestamp
◦ JMSCorrelationID
◦ JMSReplyTo
◦ JMSRedelivered
◦ JMSExpiration
◦ JMSPriority
◦ JMSType
The default for this parameter is “*”, in which case all properties set as attributes are returned. This parameter is optional.
DBUSER
The username to use when connecting to the MOM. If this parameter is specified, the parameter value takes precedence over any existing credentials mapping for the authenticated user, or any value specified in the
.msg.username and
.jms.username properties of the service that is used to connect to the MOM. For more information, see
Credentials Mapping for MOMs.
If this parameter is omitted, the mapped credentials for the Info*Engine messaging software are used. If no such mapping is found, then the mapped credentials for the Java Messaging Service (JMS) are used. If neither of these mapped credentials are found, then the value set in the .msg.username property is used. If the .msg.username property is not set, then the value set in the .jms.username property is used. If neither property is set and you do not specify a value for this DBUSER parameter, Info*Engine does not specify a username when connecting to the MOM, and an anonymous connection is attempted.
This parameter is optional.
SERVICE
The name of the Info*Engine property set that is configured for connectivity to a specific JMS service. This allows you to configure more than one JMS service per Info*Engine Virtual Machine (VM). This parameter is optional.
GROUP_OUT
The name of the group to create that contains the queue identifiers of the objects in the message queue. The default for this parameter is browse-results. This parameter is optional.
PASSWD
The password to use when connecting to the MOM. If this parameter is specified, the parameter value takes precedence over existing credentials mapping for the authenticated user, or any value specified in the
.msg.password and
.jms.password properties of the service that is used to connect to the MOM. For more information, see
Credentials Mapping for MOMs.
If this parameter is omitted, the mapped credentials for the Info*Engine messaging software are used. If no such mapping is found, then the mapped credentials for the Java Messaging Service (JMS) are used. If neither such mapped credentials are found, then the value set in the .msg.password property is used. If the .msg.password property is not set, then the value set in the .jms.password property is used. If neither property is set and you do not specify a value for this PASSWD parameter, Info*Engine does not specify a password when connecting to the MOM.
This parameter is optional.
QUEUE
The LDAP relative distinguished name of the managed queue to be browsed. The value is an LDAP distinguished name relative to a configured base URI. If relative, the cn= (common name attribute) is implicit if not explicitly specified. This parameter is required.
WHERE
The JMS where clause used to select the messages from the queue. If no where clause is specified, all messages in the queue are returned. This parameter is optional.
EXAMPLE
The following example browses a specified queue for all attributes, then returns the default “browse-results” group using the Return-Groups webject:
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Browse-Queue" type="MSG">
<ie:param name="QUEUE" data="$(@FORM[]QUEUE[0])"/>
</ie:webject>
<ie:webject name="Return-Groups" type="GRP">
<ie:param name="GROUP_IN" data="*"/>
</ie:webject>
To actually run this example, you must provide a form where the QUEUE variable is identified.
