org.apache.cxf.aegis.util.NamespaceHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cxf-rt-databinding-aegis Show documentation
Show all versions of cxf-rt-databinding-aegis Show documentation
Apache CXF Runtime Aegis Databinding
/**
* 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.cxf.aegis.util;
import java.util.List;
import java.util.StringTokenizer;
import javax.xml.namespace.NamespaceContext;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import org.w3c.dom.Element;
import org.apache.cxf.aegis.DatabindingException;
import org.apache.cxf.helpers.DOMUtils;
import org.apache.cxf.staxutils.StaxUtils;
/**
* Namespace utilities.
*/
public final class NamespaceHelper {
private NamespaceHelper() {
//utility class
}
/**
* Create a unique namespace uri/prefix combination.
*
* @param element
* @param namespaceURI namespace
* @return The namespace with the specified URI. If one doesn't exist, one
* is created.
*/
public static String getUniquePrefix(Element element, String namespaceURI) {
String prefix = getPrefix(element, namespaceURI);
// it is OK to have both namespace URI and prefix be empty.
if (prefix == null) {
if ("".equals(namespaceURI)) {
return "";
}
prefix = DOMUtils.createNamespace(element, namespaceURI);
}
return prefix;
}
public static String getPrefix(Element element, String namespaceURI) {
return DOMUtils.getPrefixRecursive(element, namespaceURI);
}
public static void getPrefixes(Element element, String namespaceURI, List prefixes) {
DOMUtils.getPrefixesRecursive(element, namespaceURI, prefixes);
}
/**
* Create a unique namespace uri/prefix combination.
*
* @param writer target writer.
* @param namespaceURI namespace
* @param declare whether to declare to the stream.
* @return The namespace with the specified URI. If one doesn't exist, one
* is created.
* @throws XMLStreamException
*/
public static String getUniquePrefix(XMLStreamWriter writer, String namespaceURI, boolean declare)
throws XMLStreamException {
return getUniquePrefix(writer, namespaceURI, null, declare);
}
/**
* Make a unique prefix.
* @param writer target writer.
* @param namespaceURI namespace
* @param preferred if there's a proposed prefix (e.g. xsi), here it is.
* @param declare whether to declare to the stream.
* @return the prefix.
* @throws XMLStreamException
*/
public static String getUniquePrefix(XMLStreamWriter writer,
String namespaceURI,
String preferred,
boolean declare)
throws XMLStreamException {
if (preferred != null) {
String existing = writer.getNamespaceContext().getNamespaceURI(preferred);
if (namespaceURI.equals(existing)) {
return preferred;
}
}
String prefix = preferred;
if (prefix == null) {
prefix = writer.getNamespaceContext().getPrefix(namespaceURI);
if (prefix != null) {
declare = false;
}
}
if (prefix == null) {
prefix = StaxUtils.getUniquePrefix(writer);
}
if (declare) {
writer.setPrefix(prefix, namespaceURI);
writer.writeNamespace(prefix, namespaceURI);
}
return prefix;
}
/**
* Generates the name of a XML namespace from a given class name and
* protocol. The returned namespace will take the form
* protocol://domain, where protocol is the
* given protocol, and domain the inversed package name of
* the given class name. For instance, if the given class name is
* org.codehaus.xfire.services.Echo, and the protocol is
* http, the resulting namespace would be
* http://services.xfire.codehaus.org.
*
* @param className the class name
* @param protocol the protocol (eg. http)
* @return the namespace
*/
public static String makeNamespaceFromClassName(String className, String protocol) {
int index = className.lastIndexOf('.');
if (index == -1) {
return protocol + "://" + "DefaultNamespace";
}
String packageName = className.substring(0, index);
StringTokenizer st = new StringTokenizer(packageName, ".");
String[] words = new String[st.countTokens()];
for (int i = 0; i < words.length; ++i) {
words[i] = st.nextToken();
}
StringBuilder sb = new StringBuilder(80);
for (int i = words.length - 1; i >= 0; --i) {
String word = words[i];
// seperate with dot
if (i != words.length - 1) {
sb.append('.');
}
sb.append(word);
}
return protocol + "://" + sb.toString();
}
/**
* Reads a QName from the element text. Reader must be positioned at the
* start tag.
*
* @param reader
* @return
* @throws XMLStreamException
*/
public static QName readQName(XMLStreamReader reader) throws XMLStreamException {
String value = reader.getElementText();
if (value == null) {
return null;
}
int index = value.indexOf(':');
if (index == -1) {
return new QName(value);
}
String prefix = value.substring(0, index);
String localName = value.substring(index + 1);
String ns = reader.getNamespaceURI(prefix);
if (ns == null || localName == null) {
throw new DatabindingException("Invalid QName in mapping: " + value);
}
return new QName(ns, localName, prefix);
}
public static QName createQName(NamespaceContext nc, String value) {
if (value == null) {
return null;
}
int index = value.indexOf(':');
if (index == -1) {
return new QName(nc.getNamespaceURI(""), value, "");
}
String prefix = value.substring(0, index);
String localName = value.substring(index + 1);
String ns = nc.getNamespaceURI(prefix);
return new QName(ns, localName, prefix);
}
public static QName createQName(Element e, String value, String defaultNamespace) {
if (value == null) {
return null;
}
int index = value.indexOf(':');
if (index == -1) {
return new QName(defaultNamespace, value);
}
String prefix = value.substring(0, index);
String localName = value.substring(index + 1);
String jNS = DOMUtils.getNamespace(e, prefix);
if (jNS == null) {
throw new DatabindingException("No namespace was found for prefix: " + prefix);
}
if (localName == null) {
throw new DatabindingException("Invalid QName in mapping: " + value);
}
return new QName(jNS, localName, prefix);
}
}