/*
* Copyright 2002-2014 the original author or authors.
*
* 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 org.springframework.integration.xml.router;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.w3c.dom.DOMException;
import org.w3c.dom.Node;
import org.springframework.integration.router.AbstractMappingMessageRouter;
import org.springframework.integration.xml.DefaultXmlPayloadConverter;
import org.springframework.integration.xml.XmlPayloadConverter;
import org.springframework.messaging.Message;
import org.springframework.util.Assert;
import org.springframework.xml.xpath.NodeMapper;
import org.springframework.xml.xpath.XPathExpression;
import org.springframework.xml.xpath.XPathExpressionFactory;
/**
* Message Router that uses {@link XPathExpression} evaluation to determine channel names.
*
* @author Jonas Partner
* @author Oleg Zhurakousky
*/
public class XPathRouter extends AbstractMappingMessageRouter {
private volatile NodeMapper<Object> nodeMapper = new TextContentNodeMapper();
private final XPathExpression xPathExpression;
private volatile XmlPayloadConverter converter = new DefaultXmlPayloadConverter();
private volatile boolean evaluateAsString = false;
/**
* Create a router that uses an XPath expression. The expression may
* contain zero or more namespace prefixes.
*
* @param expression the XPath expression as a String
* @param namespaces map of namespaces with prefixes as the map keys
*/
public XPathRouter(String expression, Map<String, String> namespaces) {
Assert.hasText(expression, "expression must not be empty");
this.xPathExpression = XPathExpressionFactory.createXPathExpression(expression, namespaces);
}
/**
* Create a router uses an XPath expression with one namespace. For example,
* expression='/ns1:one/@type' prefix='ns1' namespace='www.example.org'
*
* @param expression the XPath expression as a String
* @param prefix namespace prefix
* @param namespace namespace uri
*/
public XPathRouter(String expression, String prefix, String namespace) {
Assert.hasText(expression, "expression must not be empty");
Map<String, String> namespaces = new HashMap<String, String>();
namespaces.put(prefix, namespace);
this.xPathExpression = XPathExpressionFactory.createXPathExpression(expression, namespaces);
}
/**
* Create a router that uses an XPath expression with no namespaces.
* For example '/one/@type'
*
* @param expression the XPath expression as a String
*/
public XPathRouter(String expression) {
Assert.hasText(expression, "expression must not be empty");
this.xPathExpression = XPathExpressionFactory.createXPathExpression(expression);
}
/**
* Create a router that uses the provided XPath expression.
*
* @param expression the XPath expression
*/
public XPathRouter(XPathExpression expression) {
Assert.notNull(expression, "expression must not be null");
this.xPathExpression = expression;
}
public void setEvaluateAsString(boolean evaluateAsString) {
this.evaluateAsString = evaluateAsString;
}
/**
* Specify the Converter to use when converting payloads prior to XPath evaluation.
*
* @param converter The payload converter.
*/
public void setConverter(XmlPayloadConverter converter) {
Assert.notNull(converter, "converter must not be null");
this.converter = converter;
}
@Override
public String getComponentType() {
return "xml:xpath-router";
}
@Override
protected List<Object> getChannelKeys(Message<?> message) {
Node node = this.converter.convertToNode(message.getPayload());
if (this.evaluateAsString) {
return Collections.singletonList((Object) this.xPathExpression.evaluateAsString(node));
}
else {
return this.xPathExpression.evaluate(node, this.nodeMapper);
}
}
private static class TextContentNodeMapper implements NodeMapper<Object> {
TextContentNodeMapper() {
super();
}
@Override
public Object mapNode(Node node, int nodeNum) throws DOMException {
return node.getTextContent();
}
}
}