/*
Copyright 2013 Nationale-Nederlanden
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package nl.nn.adapterframework.jms;
import nl.nn.adapterframework.core.IMessageBrowser;
import nl.nn.adapterframework.core.IMessageBrowsingIterator;
import nl.nn.adapterframework.core.ListenerException;
import nl.nn.adapterframework.core.SenderException;
import nl.nn.adapterframework.core.SenderWithParametersBase;
import nl.nn.adapterframework.core.TimeOutException;
import nl.nn.adapterframework.parameters.ParameterResolutionContext;
import nl.nn.adapterframework.util.DomBuilderException;
import nl.nn.adapterframework.util.XmlBuilder;
import nl.nn.adapterframework.util.XmlUtils;
import org.w3c.dom.Element;
/**
* Sender for browsing and removing queue messages (with input and output in a XML message).
*
* <p>
* When input root element is <code>browse</code> all queue messages are returned.
* </p>
* <p>
* When input root element is <code>remove</code> all queue messages are removed.
* </p>
* <p>
* <b>example (input):</b>
* <code>
* <pre>
* <browse>
* <jmsRealm>qcf</jmsRealm>
* <destinationName>jms/GetPolicyDetailsRequest</destinationName>
* <destinationType>QUEUE</destinationType>
* </browse>
* </pre>
* </code>
* </p>
*
* <p>
* <table border="1">
* <tr><th>attributes</th><th>description</th></tr>
* <tr><td>jmsRealm</td><td> </td></tr>
* <tr><td>destinationName</td><td>name of the JMS destination (queue or topic) to use</td></tr>
* <tr><td>destinationType</td><td>either QUEUE or TOPIC</td></tr>
* </table>
* </p>
*
* <p>
* <b>example (browse output):</b>
* <code>
* <pre>
* <result>
* <items count="2">
* <item>
* <timestamp>Thu Nov 20 13:36:31 CET 2014</timestamp>
* <messageId>ID:LPAB00000003980-61959-1416486781822-3:5:33:1:1</messageId>
* <correlationId>...</correlationId>
* <message><![CDATA[...]]></message>
* </item>
* <item>
* <timestamp>Thu Dec 12 11:59:22 CET 2014</timestamp>
* <messageId>ID:LPAB00000003980-58359-1721486799722-3:4:19:1:1</messageId>
* <correlationId>...</correlationId>
* <message><![CDATA[...]]></message>
* </item>
* </items>
* </result>
* </pre>
* </code>
* </p>
*
* <p>
* <b>example (remove output):</b>
* <code>
* <pre>
* <result>
* <itemsRemoved>2</itemsRemoved>
* </result>
* </pre>
* </code>
* </p>
*
* @author Peter Leeuwenburgh
*/
public class XmlJmsBrowserSender extends SenderWithParametersBase {
public String sendMessage(String correlationID, String message,
ParameterResolutionContext prc) throws SenderException,
TimeOutException {
Element queueBrowserElement;
String root = null;
String jmsRealm = null;
String destinationName = null;
String destinationType = null;
try {
queueBrowserElement = XmlUtils.buildElement(message);
root = queueBrowserElement.getTagName();
jmsRealm = XmlUtils.getChildTagAsString(queueBrowserElement,
"jmsRealm");
destinationName = XmlUtils.getChildTagAsString(queueBrowserElement,
"destinationName");
destinationType = XmlUtils.getChildTagAsString(queueBrowserElement,
"destinationType");
} catch (DomBuilderException e) {
throw new SenderException(getLogPrefix()
+ "got exception parsing [" + message + "]", e);
}
JmsMessageBrowser jmsBrowser = new JmsMessageBrowser();
jmsBrowser.setName("XmlQueueBrowserSender");
jmsBrowser.setJmsRealm(jmsRealm);
jmsBrowser.setDestinationName(destinationName);
jmsBrowser.setDestinationType(destinationType);
IMessageBrowser browser = jmsBrowser;
IMessageBrowsingIterator it = null;
boolean remove = false;
if (root.equalsIgnoreCase("browse")) {
// OK
} else {
if (root.equalsIgnoreCase("remove")) {
remove = true;
} else {
throw new SenderException(getLogPrefix()
+ "unknown root element [" + root + "]");
}
}
XmlBuilder result = new XmlBuilder("result");
XmlBuilder items;
if (remove) {
items = new XmlBuilder("itemsRemoved");
} else {
items = new XmlBuilder("items");
}
try {
int count = 0;
it = browser.getIterator();
while (it.hasNext()) {
count++;
JmsMessageBrowserIteratorItem jmsMessageBrowserIteratorItem = (JmsMessageBrowserIteratorItem) it
.next();
if (remove) {
jmsBrowser.deleteMessage(jmsMessageBrowserIteratorItem
.getJMSMessageID());
} else {
// browse
XmlBuilder item = new XmlBuilder("item");
XmlBuilder timestamp = new XmlBuilder("timestamp");
timestamp.setValue(new java.util.Date(
jmsMessageBrowserIteratorItem.getJMSTimestamp())
.toString());
item.addSubElement(timestamp);
XmlBuilder messageId = new XmlBuilder("messageId");
messageId.setValue(jmsMessageBrowserIteratorItem
.getJMSMessageID());
item.addSubElement(messageId);
XmlBuilder correlationId = new XmlBuilder("correlationId");
correlationId.setValue(jmsMessageBrowserIteratorItem
.getCorrelationId());
item.addSubElement(correlationId);
XmlBuilder msg = new XmlBuilder("message");
msg.setCdataValue(jmsMessageBrowserIteratorItem.getText());
item.addSubElement(msg);
items.addSubElement(item);
}
}
if (remove) {
items.setValue(Integer.toString(count));
} else {
items.addAttribute("count", count);
}
result.addSubElement(items);
} catch (ListenerException e) {
throw new SenderException(getLogPrefix()
+ "got exception browsing messages", e);
} finally {
try {
if (it != null) {
it.close();
}
} catch (ListenerException e) {
log.warn(getLogPrefix()
+ "exception on closing message browser iterator", e);
}
}
return result.toXML();
}
}