Delete-Object
Removes a message from a JMS queue.
|
|
This webject can be used only after your environment has been set up for messaging.
|
SYNTAX
<ie:webject name="Delete-Object" type="MSG">
<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
|
|
DBUSER
|
|
|
SERVICE
|
|
|
GROUP_OUT
|
|
|
PASSWD
|
|
|
WHERE
|
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 status group to create and return upon success. The default for this parameter is delete-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
Identifies the LDAP relative distinguished name of the JMS queue to remove the message from. 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
Specifies a properly formatted JMS message selector, as defined in the Sun Java Message Service specification, used to select a subset of messages from the message queue for deletion. The first message in the subset on the queue is deleted. The default behavior for this parameter is for the first message on the queue to be deleted. This parameter is optional.
EXAMPLE
The following example deletes a JMS message from the specified queue:
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Delete-Object" type="MSG">
<ie:param name="DBUSER" data="$(@FORM[]dbuser[])"/>
<ie:param name="PASSWD" data="$(@FORM[]passwd[])"/>
<ie:param name="QUEUE" data="$(@FORM[]queue[])"/>
<ie:param name="WHERE" data="$(@FORM[]where[])"/>
<ie:param name="GROUP_OUT" data="results"/>
</ie:webject>
To actually run this example you would need to provide a form where the dbuser, passwd, queue, and where variables are identified.
