org.glassfish.hk2.xml.internal.XmlStreamImpl Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.hk2.xml.internal;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.Unmarshaller.Listener;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import org.glassfish.hk2.utilities.general.GeneralUtilities;
import org.glassfish.hk2.utilities.general.IndentingXMLStreamWriter;
import org.glassfish.hk2.utilities.reflection.ClassReflectionHelper;
import org.glassfish.hk2.utilities.reflection.Logger;
import org.glassfish.hk2.xml.api.XmlHk2ConfigurationBean;
import org.glassfish.hk2.xml.api.XmlRootHandle;
import org.glassfish.hk2.xml.jaxb.internal.BaseHK2JAXBBean;
import org.glassfish.hk2.xml.spi.Model;
/**
* @author jwells
*
*/
public class XmlStreamImpl {
private final static boolean DEBUG_PARSING = XmlServiceImpl.DEBUG_PARSING;
@SuppressWarnings("unchecked")
public static T parseRoot(XmlServiceImpl xmlService,
Model rootModel,
XMLStreamReader reader,
Unmarshaller.Listener listener) throws Exception {
Class rootProxyClass = rootModel.getProxyAsClass();
ClassReflectionHelper classReflectionHelper = xmlService.getClassReflectionHelper();
BaseHK2JAXBBean hk2Root = Utilities.createBean(rootProxyClass);
hk2Root._setClassReflectionHelper(classReflectionHelper);
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug Created root bean with model " + hk2Root._getModel());
}
Map referenceMap = new HashMap();
List unresolved = new LinkedList();
while(reader.hasNext()) {
int event = reader.next();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug got xml event (A) " + eventToString(event));
}
switch(event) {
case XMLStreamConstants.START_ELEMENT:
String elementTag = reader.getName().getLocalPart();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug starting document tag " + elementTag);
}
handleElement(hk2Root, null, reader, classReflectionHelper, listener, referenceMap, unresolved, elementTag);
break;
case XMLStreamConstants.END_DOCUMENT:
// Resolve any forward references
Utilities.fillInUnfinishedReferences(referenceMap, unresolved);
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug finished reading document");
}
return (T) hk2Root;
default:
// Do nothing
}
}
throw new IllegalStateException("Unexpected end of XMLReaderStream");
}
private static void handleElement(BaseHK2JAXBBean target,
BaseHK2JAXBBean parent,
XMLStreamReader reader,
ClassReflectionHelper classReflectionHelper,
Listener listener,
Map referenceMap,
List unresolved,
String outerElementTag) throws Exception {
listener.beforeUnmarshal(target, parent);
Map> listChildren = new HashMap>();
Map> arrayChildren = new HashMap>();
ModelImpl targetModel = target._getModel();
Map nonChildProperties = targetModel.getNonChildProperties();
Map childProperties = targetModel.getChildrenByName();
int numAttributes = reader.getAttributeCount();
for (int lcv = 0; lcv < numAttributes; lcv++) {
String attributeName = reader.getAttributeLocalName(lcv);
String attributeValue = reader.getAttributeValue(lcv);
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug handling attribute " + attributeName + " with value " + attributeValue);
}
ChildDataModel childDataModel = nonChildProperties.get(attributeName);
if (childDataModel == null) continue;
Class childType = targetModel.getNonChildType(attributeName);
if (!childDataModel.isReference()) {
Object convertedValue = Utilities.getDefaultValue(attributeValue, childType);
target._setProperty(attributeName, convertedValue);
}
else {
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug attribute " + attributeName + " is a reference");
}
// Reference
ReferenceKey rk = new ReferenceKey(childDataModel.getChildType(), attributeValue);
BaseHK2JAXBBean reference = referenceMap.get(rk);
if (reference != null) {
target._setProperty(attributeName, reference);
}
else {
unresolved.add(new UnresolvedReference(childDataModel.getChildType(), attributeValue, attributeName, target));
}
}
}
while(reader.hasNext()) {
int event = reader.next();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug got xml event (B) " + eventToString(event));
}
switch(event) {
case XMLStreamConstants.START_ELEMENT:
String elementTag = reader.getName().getLocalPart();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug starting parse of element " + elementTag);
}
ChildDataModel cdm = nonChildProperties.get(elementTag);
if (cdm != null) {
String elementValue = advanceNonChildElement(reader, elementTag);
Class childType = cdm.getChildTypeAsClass();
if (!cdm.isReference()) {
Object convertedValue = Utilities.getDefaultValue(elementValue, childType);
target._setProperty(elementTag, convertedValue);
}
else {
ReferenceKey referenceKey = new ReferenceKey(cdm.getChildType(), elementValue);
BaseHK2JAXBBean reference = referenceMap.get(referenceKey);
if (reference != null) {
target._setProperty(elementTag, reference);
}
else {
unresolved.add(new UnresolvedReference(cdm.getChildType(),
elementValue, elementTag, target));
}
}
break;
}
ParentedModel informedChild = childProperties.get(elementTag);
if (informedChild != null) {
ModelImpl grandChild = informedChild.getChildModel();
BaseHK2JAXBBean hk2Root = Utilities.createBean(grandChild.getProxyAsClass());
hk2Root._setClassReflectionHelper(classReflectionHelper);
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceBean created child bean of " + outerElementTag + " with model " + hk2Root._getModel());
}
handleElement(hk2Root, target, reader, classReflectionHelper, listener, referenceMap, unresolved, elementTag);
if (informedChild.getChildType().equals(ChildType.DIRECT)) {
target._setProperty(elementTag, hk2Root);
}
else if (informedChild.getChildType().equals(ChildType.LIST)) {
List cList = listChildren.get(elementTag);
if (cList == null) {
cList = new ArrayList();
listChildren.put(elementTag, cList);
}
cList.add(hk2Root);
}
else if (informedChild.getChildType().equals(ChildType.ARRAY)) {
List cList = arrayChildren.get(elementTag);
if (cList == null) {
cList = new LinkedList();
arrayChildren.put(elementTag, cList);
}
cList.add(hk2Root);
}
break;
}
// If here we have an unknown stanza, just skip it
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceBean found unknown element in " + outerElementTag + " named " + elementTag + " skipping");
}
skip(reader, elementTag);
break;
case XMLStreamConstants.CHARACTERS:
// Do nothing
break;
case XMLStreamConstants.END_ELEMENT:
for (Map.Entry> entry : listChildren.entrySet()) {
// Kind of cheating with the erasure, but hey, it works!
target._setProperty(entry.getKey(), entry.getValue());
}
for (Map.Entry> entry : arrayChildren.entrySet()) {
String childTag = entry.getKey();
ParentedModel pn = targetModel.getChild(childTag);
Class childType = pn.getChildModel().getOriginalInterfaceAsClass();
List individuals = entry.getValue();
Object actualArray = Array.newInstance(childType, individuals.size());
int index = 0;
for (BaseHK2JAXBBean individual : individuals) {
Array.set(actualArray, index++, individual);
}
target._setProperty(childTag, actualArray);
}
listener.afterUnmarshal(target, parent);
// Put the finished product into the reference map
String keyProp = target._getKeyPropertyName();
if (keyProp != null) {
String keyVal = (String) target._getProperty(keyProp);
String myType = target._getModel().getOriginalInterface();
if (keyVal != null && myType != null) {
referenceMap.put(new ReferenceKey(myType, keyVal), target);
}
}
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug ending parse of element " + outerElementTag);
}
return;
case XMLStreamConstants.COMMENT:
break;
default:
// Do nothing
}
}
}
private static String advanceNonChildElement(XMLStreamReader reader, String outerTag) throws Exception {
String retVal = null;
while (reader.hasNext()) {
int nextEvent = reader.next();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug got xml event (C) " + eventToString(nextEvent));
}
switch (nextEvent) {
case XMLStreamConstants.CHARACTERS:
String text = reader.getText();
retVal = text.trim();
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug characters of tag " + outerTag + " is " + retVal);
}
break;
case XMLStreamConstants.END_ELEMENT:
if (DEBUG_PARSING) {
Logger.getLogger().debug("XmlServiceDebug ending parse of non-child element " + outerTag);
}
return retVal;
default:
// Everything else would be comments or other stuff
// If not we have a bigger problem
}
}
return retVal;
}
private static void skip(XMLStreamReader reader, String skipOverTag) throws Exception {
while (reader.hasNext()) {
int event = reader.next();
if (DEBUG_PARSING) {
String name = null;
if (reader.hasName()) {
name = reader.getName().getLocalPart();
}
Logger.getLogger().debug("XmlServiceDebug got xml event (D) " + eventToString(event) + " with name " + name);
}
if (XMLStreamConstants.END_ELEMENT != event) continue;
String elementTag = reader.getName().getLocalPart();
if (skipOverTag.equals(elementTag)) return;
}
}
private static String eventToString(int event) {
switch (event) {
case XMLStreamConstants.START_ELEMENT : return "START_ELEMENT" ;
case XMLStreamConstants.END_ELEMENT : return "END_ELEMENT" ;
case XMLStreamConstants.PROCESSING_INSTRUCTION : return "PROCESSING_INSTRUCTION" ;
case XMLStreamConstants.CHARACTERS : return "CHARACTERS" ;
case XMLStreamConstants.COMMENT : return "COMMENT" ;
case XMLStreamConstants.SPACE : return "SPACE" ;
case XMLStreamConstants.START_DOCUMENT : return "START_DOCUMENT" ;
case XMLStreamConstants.END_DOCUMENT : return "END_DOCUMENT" ;
case XMLStreamConstants.ENTITY_REFERENCE : return "ENTITY_REFERENCE" ;
case XMLStreamConstants.ATTRIBUTE : return "ATTRIBUTE" ;
case XMLStreamConstants.DTD : return "DTD" ;
case XMLStreamConstants.CDATA : return "CDATA" ;
case XMLStreamConstants.NAMESPACE : return "NAMESPACE" ;
case XMLStreamConstants.NOTATION_DECLARATION : return "NOTATION_DECLARATION" ;
case XMLStreamConstants.ENTITY_DECLARATION : return "ENTITY_DECLARATION" ;
default : return "UNKNOWN EVENT: " + event;
}
}
public static void marshall(OutputStream outputStream, XmlRootHandle root) throws IOException {
try {
marshallXmlStream(outputStream, root);
}
catch (XMLStreamException xse) {
throw new IOException(xse);
}
}
private static void marshallXmlStream(OutputStream outputStream, XmlRootHandle root) throws XMLStreamException {
XMLStreamWriter rawWriter = XMLOutputFactory.newInstance().createXMLStreamWriter(outputStream);
IndentingXMLStreamWriter indenter = new IndentingXMLStreamWriter(rawWriter);
try {
indenter.writeStartDocument();
XmlHk2ConfigurationBean bean = (XmlHk2ConfigurationBean) root.getRoot();
if (bean != null) {
marshallElement(indenter, bean, null);
}
indenter.writeEndDocument();
}
finally {
rawWriter.close();
}
}
@SuppressWarnings("unchecked")
private static void marshallElement(XMLStreamWriter indenter, XmlHk2ConfigurationBean bean, ParentedModel parented) throws XMLStreamException {
ModelImpl model = bean._getModel();
Map beanLikeMap = bean._getBeanLikeMap();
String xmlTag;
if (parented == null) {
xmlTag = model.getRootName();
}
else {
xmlTag = parented.getChildXmlTag();
}
indenter.writeStartElement(xmlTag);
Map attributeModels = model.getAllAttributeChildren();
for (Map.Entry entry : attributeModels.entrySet()) {
String attributeTag = entry.getKey();
ChildDataModel childDataModel = entry.getValue();
Object value = beanLikeMap.get(attributeTag);
if (value == null) continue;
String valueAsString;
if (!childDataModel.isReference()) {
valueAsString = value.toString();
}
else {
XmlHk2ConfigurationBean reference = (XmlHk2ConfigurationBean) value;
valueAsString = reference._getKeyValue();
}
if (GeneralUtilities.safeEquals(valueAsString, childDataModel.getDefaultAsString())) continue;
indenter.writeAttribute(attributeTag, valueAsString);
}
Map elementDescriptors = model.getAllElementChildren();
for (Map.Entry entry : elementDescriptors.entrySet()) {
String elementTag = entry.getKey();
ChildDescriptor descriptor = entry.getValue();
Object value = beanLikeMap.get(elementTag);
if (value == null) continue;
ParentedModel parentedChild = descriptor.getParentedModel();
if (parentedChild != null) {
if (ChildType.LIST.equals(parentedChild.getChildType())) {
List asList = (List) value;
if (asList.isEmpty()) continue;
for (XmlHk2ConfigurationBean child : asList) {
marshallElement(indenter, child, parentedChild);
}
}
else if (ChildType.ARRAY.equals(parentedChild.getChildType())) {
int length = Array.getLength(value);
if (length <= 0) continue;
for (int lcv = 0; lcv < length; lcv++) {
XmlHk2ConfigurationBean child = (XmlHk2ConfigurationBean) Array.get(value, lcv);
marshallElement(indenter, child, parentedChild);
}
}
else {
// Direct
marshallElement(indenter, (XmlHk2ConfigurationBean) value, parentedChild);
}
}
else {
ChildDataModel childDataModel = descriptor.getChildDataModel();
if (!childDataModel.isReference()) {
String valueAsString = value.toString();
if (GeneralUtilities.safeEquals(valueAsString, childDataModel.getDefaultAsString())) continue;
indenter.writeStartElement(elementTag);
indenter.writeCharacters(valueAsString);
indenter.writeEndElement();
}
else {
XmlHk2ConfigurationBean reference = (XmlHk2ConfigurationBean) value;
String keyValue = reference._getKeyValue();
indenter.writeStartElement(elementTag);
indenter.writeCharacters(keyValue);
indenter.writeEndElement();
}
}
}
indenter.writeEndElement();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy