/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.camel.builder.xml;
import java.util.HashMap;
import java.util.Map;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.apache.camel.model.language.XPathExpression;
import org.apache.camel.model.language.XQueryExpression;
import org.apache.camel.spi.NamespaceAware;
import org.apache.camel.util.ObjectHelper;
/**
* A helper class for working with namespaces or creating namespace based expressions
*
* @version $Revision: 660275 $
*/
public class Namespaces {
public static final String DEFAULT_NAMESPACE = "http://activemq.apache.org/camel/schema/spring";
public static final String IN_NAMESPACE = "http://camel.apache.org/xml/in/";
public static final String OUT_NAMESPACE = "http://camel.apache.org/xml/out/";
public static final String SYSTEM_PROPERTIES_NAMESPACE = "http://camel.apache.org/xml/variables/system-properties";
public static final String ENVIRONMENT_VARIABLES = "http://camel.apache.org/xml/variables/environment-variables";
public static final String EXCHANGE_PROPERTY = "http://camel.apache.org/xml/variables/exchange-property";
private Map<String, String> namespaces = new HashMap<String, String>();
/**
* Creates a namespaces object from the given XML element
*
* @param element the XML element representing the XPath namespace context
*/
public Namespaces(Element element) {
add(element);
}
/**
* Creates a namespace context with a single prefix and URI
*/
public Namespaces(String prefix, String uri) {
add(prefix, uri);
}
/**
* Returns true if the given namespaceURI is empty or if it matches the
* given expected namespace
*/
public static boolean isMatchingNamespaceOrEmptyNamespace(String namespaceURI, String expectedNamespace) {
return ObjectHelper.isNullOrBlank(namespaceURI) || namespaceURI.equals(expectedNamespace);
}
public Namespaces add(String prefix, String uri) {
namespaces.put(prefix, uri);
return this;
}
public Namespaces add(Element element) {
// lets set the parent first in case we overload a prefix here
Node parentNode = element.getParentNode();
if (parentNode instanceof org.w3c.dom.Element) {
add((Element) parentNode);
}
NamedNodeMap attributes = element.getAttributes();
int size = attributes.getLength();
for (int i = 0; i < size; i++) {
Attr node = (Attr) attributes.item(i);
String name = node.getName();
if (name.startsWith("xmlns:")) {
String prefix = name.substring("xmlns:".length());
String uri = node.getValue();
add(prefix, uri);
}
}
return this;
}
/**
* Creates the XPath expression using the current namespace context
*/
public XPathExpression xpath(String expression) {
XPathExpression answer = new XPathExpression(expression);
configure(answer);
return answer;
}
/**
* Creates the XPath expression using the current namespace context
*/
public XPathExpression xpath(String expression, Class<?> resultType) {
XPathExpression answer = xpath(expression);
answer.setResultType(resultType);
return answer;
}
/**
* Creates the XQuery expression using the current namespace context
*/
public XQueryExpression xquery(String expression) {
XQueryExpression answer = new XQueryExpression(expression);
configure(answer);
return answer;
}
/**
* Creates the XQuery expression using the current namespace context
* and the given expected return type
*/
public XQueryExpression xquery(String expression, Class<?> resultType) {
XQueryExpression answer = new XQueryExpression(expression);
answer.setResultType(resultType);
configure(answer);
return answer;
}
public Map<String, String> getNamespaces() {
return namespaces;
}
/**
* Configures the namespace aware object
*/
public void configure(NamespaceAware namespaceAware) {
namespaceAware.setNamespaces(getNamespaces());
}
}