| SerializationContextImpl.java |
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Axis" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.jboss.axis.encoding;
import org.jboss.axis.AxisEngine;
import org.jboss.axis.Constants;
import org.jboss.axis.Handler;
import org.jboss.axis.Message;
import org.jboss.axis.MessageContext;
import org.jboss.axis.attachments.Attachments;
import org.jboss.axis.client.Call;
import org.jboss.axis.description.OperationDesc;
import org.jboss.axis.description.TypeDesc;
import org.jboss.axis.encoding.ser.BaseSerializerFactory;
import org.jboss.axis.encoding.ser.JAFDataHandlerSerializer;
import org.jboss.axis.enums.Use;
import org.jboss.axis.handlers.soap.SOAPService;
import org.jboss.axis.schema.SchemaVersion;
import org.jboss.axis.soap.SOAPConstants;
import org.jboss.axis.types.HexBinary;
import org.jboss.axis.utils.IDKey;
import org.jboss.axis.utils.JavaUtils;
import org.jboss.axis.utils.Mapping;
import org.jboss.axis.utils.Messages;
import org.jboss.axis.utils.NSStack;
import org.jboss.axis.utils.XMLUtils;
import org.jboss.axis.wsdl.symbolTable.SchemaUtils;
import org.jboss.axis.wsdl.symbolTable.SymbolTable;
import org.jboss.logging.Logger;
import org.w3c.dom.Attr;
import org.w3c.dom.CDATASection;
import org.w3c.dom.CharacterData;
import org.w3c.dom.Comment;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import org.xml.sax.Attributes;
import org.xml.sax.helpers.AttributesImpl;
import javax.xml.namespace.QName;
import javax.xml.rpc.JAXRPCException;
import javax.xml.rpc.holders.QNameHolder;
import javax.xml.soap.SOAPMessage;
import java.io.IOException;
import java.io.Writer;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Stack;
/**
* Manage a serialization, including keeping track of namespace mappings
* and element stacks.
*
* @author Glen Daniels (gdaniels@macromedia.com)
* @author Rich Scheuerle <scheu@us.ibm.com>
*/
public class SerializationContextImpl implements SerializationContext
{
private static Logger log = Logger.getLogger(SerializationContextImpl.class.getName());
private NSStack nsStack = new NSStack();
private boolean writingStartTag = false;
private boolean onlyXML = true;
private int indent = 0;
private boolean startOfDocument = true;
private Writer writer;
private int lastPrefixIndex = 1;
private MessageContext msgContext;
private QName currentXMLType;
// Stack<QName>
private Stack elementStack = new Stack();
/**
* The SOAP context we're using
*/
private SOAPConstants soapConstants = SOAPConstants.SOAP11_CONSTANTS;
private boolean pretty;
private static QName multirefQName = new QName("", "multiRef");
private static Class[] getSerializerClasses =
new Class[]{String.class, Class.class, QName.class};
/**
* Should I write out objects as multi-refs?
* <p/>
* !!! For now, this is an all-or-nothing flag. Either ALL objects will
* be written in-place as hrefs with the full serialization at the end
* of the body, or we'll write everything inline (potentially repeating
* serializations of identical objects).
*/
private boolean doMultiRefs = false;
/**
* Should I send an XML declaration?
*/
private boolean sendXMLDecl = true;
/**
* Should I send xsi:type attributes?
*/
private boolean sendXSIType = true;
/**
* Should I send minimized elements? As in <element/> instead of
* <element></element>.
*/
private boolean sendMinimizedElements = true;
/**
* A place to hold objects we cache for multi-ref serialization, and
* remember the IDs we assigned them.
*/
private HashMap multiRefValues = null;
private int multiRefIndex = -1;
private boolean noNamespaceMappings = true;
// Interop tests with SunOne appserver don't work in document/literal
// when the content of the body defines a default namespace
// TDI 24-June-2004
private boolean noDefaultNamespace;
class MultiRefItem
{
String id;
QName xmlType;
Boolean sendType;
Object value;
MultiRefItem(String id,
QName xmlType,
Boolean sendType, Object value)
{
this.id = id;
this.xmlType = xmlType;
this.sendType = sendType;
this.value = value;
}
}
/**
* These three variables are necessary to process
* multi-level object graphs for multi-ref serialization.
* While writing out nested multi-ref objects (via outputMultiRef), we
* will fill the secondLevelObjects vector
* with any new objects encountered.
* The outputMultiRefsFlag indicates whether we are currently within the
* outputMultiRef() method (so that serialization() knows to update the
* secondLevelObjects vector).
* The forceSer variable is the trigger to force actual serialization of the indicated object.
*/
private HashSet secondLevelObjects = null;
private Object forceSer = null;
private boolean outputMultiRefsFlag = false;
/**
* Which schema version are we using?
*/
SchemaVersion schemaVersion = SchemaVersion.SCHEMA_2001;
/**
* A list of particular namespace -> prefix mappings we should prefer.
* See getPrefixForURI() below.
*/
HashMap preferredPrefixes = new HashMap();
/**
* Construct SerializationContextImpl with associated writer
*
* @param writer java.io.Writer
*/
public SerializationContextImpl(Writer writer)
{
this.writer = writer;
initialize();
}
private void initialize()
{
// These are the preferred prefixes we'll use instead of the "ns1"
// style defaults. MAKE SURE soapConstants IS SET CORRECTLY FIRST!
preferredPrefixes.put(soapConstants.getEncodingURI(),
Constants.NS_PREFIX_SOAP_ENC);
preferredPrefixes.put(Constants.NS_URI_XML,
Constants.NS_PREFIX_XML);
preferredPrefixes.put(schemaVersion.getXsdURI(),
Constants.NS_PREFIX_SCHEMA_XSD);
preferredPrefixes.put(schemaVersion.getXsiURI(),
Constants.NS_PREFIX_SCHEMA_XSI);
}
/**
* Construct SerializationContextImpl with associated writer and MessageContext
*
* @param writer java.io.Writer
* @param msgContext is the MessageContext
*/
public SerializationContextImpl(Writer writer, MessageContext msgContext)
{
this.writer = writer;
this.msgContext = msgContext;
Handler optionSource = null;
if (msgContext != null)
{
soapConstants = msgContext.getSOAPConstants();
// optionSource = msgContext.getService();
if (optionSource == null)
optionSource = msgContext.getAxisEngine();
// Use whatever schema is associated with this MC
schemaVersion = msgContext.getSchemaVersion();
Boolean shouldSendDecl = (Boolean)optionSource.getOption(AxisEngine.PROP_XML_DECL);
if (shouldSendDecl != null)
sendXMLDecl = shouldSendDecl.booleanValue();
Boolean shouldSendMultiRefs =
(Boolean)msgContext.getProperty(AxisEngine.PROP_DOMULTIREFS);
if (shouldSendMultiRefs == null)
shouldSendMultiRefs =
(Boolean)optionSource.getOption(AxisEngine.PROP_DOMULTIREFS);
if (shouldSendMultiRefs != null)
doMultiRefs = shouldSendMultiRefs.booleanValue();
Boolean shouldSendMinimized =
(Boolean)optionSource.getOption(AxisEngine.PROP_SEND_MINIMIZED_ELEMENTS);
if (shouldSendMinimized != null)
sendMinimizedElements = shouldSendMinimized.booleanValue();
// The SEND_TYPE_ATTR and PROP_SEND_XSI options indicate
// whether the elements should have xsi:type attributes.
// Only turn this off is the user tells us to
if (!msgContext.isPropertyTrue(Call.SEND_TYPE_ATTR, true))
sendXSIType = false;
Boolean opt = (Boolean)optionSource.getOption(AxisEngine.PROP_SEND_XSI);
if ((opt != null) && (opt.equals(Boolean.FALSE)))
{
sendXSIType = false;
}
// A Literal use operation overrides the above settings. Don't
// send xsi:type, and don't do multiref in that case.
OperationDesc operation = msgContext.getOperation();
if (operation != null)
{
if (operation.getUse() != Use.ENCODED)
{
sendXSIType = false;
doMultiRefs = false;
}
}
else
{
// A Literal use service overrides the above settings.
SOAPService service = msgContext.getService();
if (service != null)
{
if (service.getUse() != Use.ENCODED)
{
sendXSIType = false;
doMultiRefs = false;
}
}
}
}
// Set up preferred prefixes based on current schema, soap ver, etc.
initialize();
}
/**
* Get whether the serialization should be pretty printed.
*
* @return true/false
*/
public boolean getPretty()
{
return pretty;
}
/**
* Indicate whether the serialization should be pretty printed.
*
* @param pretty true/false
*/
public void setPretty(boolean pretty)
{
this.pretty = pretty;
}
/**
* Are we doing multirefs?
*
* @return true or false
*/
public boolean getDoMultiRefs()
{
return doMultiRefs;
}
/**
* Set whether we are doing multirefs
*/
public void setDoMultiRefs(boolean shouldDo)
{
doMultiRefs = shouldDo;
}
/**
* Set whether or not we should write XML declarations.
*
* @param sendDecl true/false
*/
public void setSendDecl(boolean sendDecl)
{
sendXMLDecl = sendDecl;
}
/**
* Get whether or not to write xsi:type attributes.
*
* @return true/false
*/
public boolean shouldSendXSIType()
{
return sendXSIType;
}
/**
* Get whether or not to write the default namespace.
*
* @return true/false
*/
public boolean isNoDefaultNamespace()
{
return noDefaultNamespace;
}
/**
* Set whether or not to write the default namespace.
*/
public void setNoDefaultNamespace(boolean noDefaultNamespace)
{
this.noDefaultNamespace = noDefaultNamespace;
}
/**
* Get the TypeMapping we're using.
*
* @return TypeMapping or null
*/
public TypeMapping getTypeMapping()
{
// Always allow the default mappings
if (msgContext == null)
return DefaultTypeMappingImpl.getSingleton();
String encodingStyle = msgContext.getEncodingStyle();
if (encodingStyle == null)
encodingStyle = soapConstants.getEncodingURI();
return (TypeMapping)msgContext.
getTypeMappingRegistry().getTypeMapping(encodingStyle);
}
/**
* Get the TypeMappingRegistry we're using.
*
* @return TypeMapping or null
*/
public TypeMappingRegistry getTypeMappingRegistry()
{
if (msgContext == null)
return null;
return msgContext.getTypeMappingRegistry();
}
/**
* Get a prefix for a namespace URI. This method will ALWAYS
* return a valid prefix - if the given URI is already mapped in this
* serialization, we return the previous prefix. If it is not mapped,
* we will add a new mapping and return a generated prefix of the form
* "ns<num>".
*
* @param uri is the namespace uri
* @return prefix
*/
public String getPrefixForURI(String uri)
{
return getPrefixForURI(uri, null, false);
}
/**
* Get a prefix for the given namespace URI. If one has already been
* defined in this serialization, use that. Otherwise, map the passed
* default prefix to the URI, and return that. If a null default prefix
* is passed, use one of the form "ns<num>"
*/
public String getPrefixForURI(String uri, String defaultPrefix)
{
return getPrefixForURI(uri, defaultPrefix, false);
}
/**
* Get a prefix for the given namespace URI. If one has already been
* defined in this serialization, use that. Otherwise, map the passed
* default prefix to the URI, and return that. If a null default prefix
* is passed, use one of the form "ns<num>"
*/
public String getPrefixForURI(String uri, String defaultPrefix, boolean attribute)
{
if ((uri == null) || (uri.length() == 0))
return null;
// If we're looking for an attribute prefix, we shouldn't use the
// "" prefix, but always register/find one.
String prefix = nsStack.getPrefix(uri, attribute);
if (prefix == null)
{
prefix = (String)preferredPrefixes.get(uri);
if (prefix == null)
{
if (defaultPrefix == null)
{
prefix = "ns" + lastPrefixIndex++;
}
else
{
prefix = defaultPrefix;
}
}
registerPrefixForURI(prefix, uri);
}
return prefix;
}
/**
* Register prefix for the indicated uri
*
* @param prefix
* @param uri is the namespace uri
*/
public void registerPrefixForURI(String prefix, String uri)
{
if (log.isDebugEnabled())
log.debug("registerPrefixForURI(" + prefix + ", " + uri + ")");
// This is a workaround for http://jira.jboss.com/jira/browse/JBWS-64
if ("".equals(uri))
{
log.warn("Ignoring invalid namespace mapping: [prefix=" + prefix + ",uri=" + uri + "]");
return;
}
if ((uri != null) && (prefix != null))
{
if (noNamespaceMappings)
{
nsStack.push();
noNamespaceMappings = false;
}
nsStack.add(uri, prefix);
}
}
/**
* Return the current message
*/
public Message getCurrentMessage()
{
if (msgContext == null)
return null;
return msgContext.getCurrentMessage();
}
/**
* Get the MessageContext we're operating with
*/
public MessageContext getMessageContext()
{
return msgContext;
}
/**
* Convert QName to a string of the form <prefix>:<localpart>
*
* @param qName
* @return prefixed qname representation for serialization.
*/
public String qName2String(QName qName, boolean writeNS)
{
String prefix = null;
String namespaceURI = qName.getNamespaceURI();
if (namespaceURI.length() == 0)
{
if (writeNS)
{
// If this is unqualified (i.e. prefix ""), set the default
// namespace to ""
String defaultNS = nsStack.getNamespaceURI("");
if (defaultNS != null && defaultNS.length() > 0)
{
registerPrefixForURI("", "");
}
}
}
else
{
prefix = getPrefixForURI(namespaceURI);
}
if ((prefix == null) || (prefix.length() == 0))
return qName.getLocalPart();
StringBuffer sb = new StringBuffer(prefix);
sb.append(':');
sb.append(qName.getLocalPart());
return sb.toString();
}
public String qName2String(QName qName)
{
return qName2String(qName, false);
}
/**
* Convert attribute QName to a string of the form <prefix>:<localpart>
* There are slightly different rules for attributes:
* - There is no default namespace
* - any attribute in a namespace must have a prefix
*
* @param qName QName
* @return prefixed qname representation for serialization.
*/
public String attributeQName2String(QName qName)
{
String prefix = null;
if (qName.getNamespaceURI().length() > 0)
{
prefix = getPrefixForURI(qName.getNamespaceURI(), null, true);
}
if ((prefix == null) || (prefix.length() == 0))
return qName.getLocalPart();
StringBuffer sb = new StringBuffer(prefix);
sb.append(':');
sb.append(qName.getLocalPart());
return sb.toString();
}
/**
* Get the QName associated with the specified class.
*
* @param cls Class of an object requiring serialization.
* @return appropriate QName associated with the class.
*/
public QName getQNameForClass(Class cls)
{
return getTypeMapping().getTypeQName(cls);
}
/**
* Indicates whether the object should be interpretted as a primitive
* for the purposes of multi-ref processing. A primitive value
* is serialized directly instead of using id/href pairs. Thus
* primitive serialization/deserialization is slightly faster.
*
* @param value to be serialized
* @return true/false
*/
public boolean isPrimitive(Object value)
{
if (value == null) return true;
Class javaType = value.getClass();
if (javaType.isPrimitive()) return true;
if (javaType == String.class) return true;
if (Calendar.class.isAssignableFrom(javaType)) return true;
if (Date.class.isAssignableFrom(javaType)) return true;
if (HexBinary.class.isAssignableFrom(javaType)) return true;
if (Element.class.isAssignableFrom(javaType)) return true;
if (javaType == byte[].class) return true;
// There has been discussion as to whether arrays themselves should
// be regarded as multi-ref.
// Here are the three options:
// 1) Arrays are full-fledged Objects and therefore should always be
// multi-ref'd (Pro: This is like java. Con: Some runtimes don't
// support this yet, and it requires more stuff to be passed over the wire.)
// 2) Arrays are not full-fledged Objects and therefore should
// always be passed as single ref (note the elements of the array
// may be multi-ref'd.) (Pro: This seems reasonable, if a user
// wants multi-referencing put the array in a container. Also
// is more interop compatible. Con: Not like java serialization.)
// 3) Arrays of primitives should be single ref, and arrays of
// non-primitives should be multi-ref. (Pro: Takes care of the
// looping case. Con: Seems like an obtuse rule.)
//
// Changing the code from (1) to (2) to see if interop fairs better.
if (javaType.isArray()) return true;
// Note that java.lang wrapper classes (i.e. java.lang.Integer) are
// not primitives unless the corresponding type is an xsd type.
// (If the wrapper maps to a soap encoded primitive, it can be nillable
// and multi-ref'd).
QName qName = getQNameForClass(javaType);
if (qName != null && Constants.isSchemaXSD(qName.getNamespaceURI()))
{
if (SchemaUtils.isSimpleSchemaType(qName))
{
return true;
}
}
return false;
}
/**
* Serialize the indicated value as an element with the name
* indicated by elemQName.
* The attributes are additional attribute to be serialized on the element.
* The value is the object being serialized. (It may be serialized
* directly or serialized as an mult-ref'd item)
* The value is an Object, which may be a wrapped primitive, the
* javaType is the actual unwrapped object type.
* The xmlType (if specified) is the QName of the type that is used to set
* xsi:type. If not specified, xsi:type is set by using the javaType to
* find an appopriate xmlType from the TypeMappingRegistry.
* The sendNull flag indicates whether null values should be sent over the
* wire (default is to send such values with xsi:nil="true").
* The sendType flag indicates whether the xsi:type flag should be sent
* (default is true).
*
* @param elemQName is the QName of the element
* @param attributes are additional attributes
* @param value is the object to serialize
*/
public void serialize(QName elemQName,
Attributes attributes,
Object value)
throws IOException
{
serialize(elemQName, attributes, value, null, true, null);
}
/**
* Serialize the indicated value as an element with the name
* indicated by elemQName.
* The attributes are additional attribute to be serialized on the element.
* The value is the object being serialized. (It may be serialized
* directly or serialized as an mult-ref'd item)
* The value is an Object, which may be a wrapped primitive.
* The xmlType (if specified) is the QName of the type that is used to set
* xsi:type.
* The sendNull flag indicates whether null values should be sent over the
* wire (default is to send such values with xsi:nil="true").
* The sendType flag indicates whether the xsi:type flag should be sent
* (default is true).
*
* @param elemQName is the QName of the element
* @param attributes are additional attributes
* @param value is the object to serialize
* @param xmlType is the qname of the type or null.
* @param sendNull determines whether to send null values.
* @param sendType determines whether to set xsi:type attribute.
*/
public void serialize(QName elemQName,
Attributes attributes,
Object value,
QName xmlType,
boolean sendNull,
Boolean sendType)
throws IOException
{
boolean shouldSendType = (sendType == null) ? shouldSendXSIType() :
sendType.booleanValue();
if (value == null)
{
// If the value is null, the element is
// passed with xsi:nil="true" to indicate that no object is present.
if (sendNull)
{
AttributesImpl attrs = new AttributesImpl();
if (attributes != null && 0 < attributes.getLength())
attrs.setAttributes(attributes);
if (shouldSendType)
attrs = (AttributesImpl)setTypeAttribute(attrs, xmlType);
String nil = schemaVersion.getNilQName().getLocalPart();
attrs.addAttribute(schemaVersion.getXsiURI(), nil, "xsi:" + nil,
"CDATA", "1");
startElement(elemQName, attrs);
endElement();
}
return;
}
Message msg = getCurrentMessage();
if (null != msg)
{
//Get attachments. returns null if no attachment support.
Attachments attachments = msg.getAttachmentsImpl();
if (null != attachments)
{
// Attachment support
if (attachments.isAttachment(value) || getSerializer(value.getClass(), xmlType, null) instanceof JAFDataHandlerSerializer)
{
// This is an object that should be treated as an attachment, so allow the
// attachment to do its own serialization
serializeActual(elemQName, attributes, value, xmlType, sendType);
// No need to add to mulitRefs.
// Attachment data stream handled by the message
return;
}
}
}
// If multi-reference is enabled and this object value is not a primitive
// and we are not forcing serialization of the object, then generate
// an element href (and store the object for subsequent outputMultiRef
// processing).
// NOTE : you'll notice that everywhere we register objects in the
// multiRefValues and secondLevelObjects collections, we key them
// using getIdentityKey(value) instead of the Object reference itself.
// THIS IS IMPORTANT, and please make sure you understand what's
// going on if you change any of this code. It's this way to make
// sure that individual Objects are serialized separately even if the
// hashCode() and equals() methods have been overloaded to make two
// Objects appear equal.
if (doMultiRefs && (msgContext == null || msgContext.isEncoded()) &&
(value != forceSer) && !isPrimitive(value))
{
if (multiRefIndex == -1)
multiRefValues = new HashMap();
String id;
// Look for a multi-ref descriptor for this Object.
MultiRefItem mri = (MultiRefItem)multiRefValues.get(getIdentityKey(value));
if (mri == null)
{
// Didn't find one, so create one, give it a new ID, and store
// it for next time.
multiRefIndex++;
id = "id" + multiRefIndex;
mri = new MultiRefItem(id, xmlType, sendType, value);
multiRefValues.put(getIdentityKey(value), mri);
/**
* If we're SOAP 1.2, we can "inline" the serializations,
* so put it out now, with it's ID.
*/
if (soapConstants == SOAPConstants.SOAP12_CONSTANTS)
{
AttributesImpl attrs = new AttributesImpl();
if (attributes != null && 0 < attributes.getLength())
attrs.setAttributes(attributes);
attrs.addAttribute("", Constants.ATTR_ID, "id", "CDATA",
id);
serializeActual(elemQName, attrs, value, xmlType, sendType);
return;
}
/** If we're in the middle of writing out
* the multi-refs, we've already cloned the list of objects
* and so even though we add a new one to multiRefValues,
* it won't get serialized this time around.
*
* To deal with this, we maintain a list of "second level"
* Objects - ones that need serializing as a result of
* serializing the first level. When outputMultiRefs() is
* nearly finished, it checks to see if secondLevelObjects
* is empty, and if not, it goes back and loops over those
* Objects. This can happen N times depending on how deep
* the Object graph goes.
*/
if (outputMultiRefsFlag)
{
if (secondLevelObjects == null)
secondLevelObjects = new HashSet();
secondLevelObjects.add(getIdentityKey(value));
}
}
else
{
// Found one, remember it's ID
id = mri.id;
}
// Serialize an HREF to our object
AttributesImpl attrs = new AttributesImpl();
if (attributes != null && 0 < attributes.getLength())
attrs.setAttributes(attributes);
attrs.addAttribute("", soapConstants.getAttrHref(), soapConstants.getAttrHref(),
"CDATA", '#' + id);
startElement(elemQName, attrs);
endElement();
return;
}
// The forceSer variable is set by outputMultiRefs to force
// serialization of this object via the serialize(...) call
// below. However, if the forced object contains a self-reference, we
// get into an infinite loop..which is why it is set back to null
// before the actual serialization.
if (value == forceSer)
forceSer = null;
// Actually serialize the value. (i.e. not an href like above)
serializeActual(elemQName, attributes, value, xmlType, sendType);
}
/**
* Get an IDKey that represents the unique identity of the object.
* This is used as a unique key into a HashMap which will
* not give false hits on other Objects where hashCode() and equals()
* have been overriden to match.
*
* @param value the Object to hash
* @return a unique IDKey for the identity
*/
private IDKey getIdentityKey(Object value)
{
return new IDKey(value);
}
/**
* The serialize method uses hrefs to reference all non-primitive
* values. These values are stored and serialized by calling
* outputMultiRefs after the serialize method completes.
*/
public void outputMultiRefs() throws IOException
{
if (!doMultiRefs || (multiRefValues == null) ||
soapConstants == SOAPConstants.SOAP12_CONSTANTS)
return;
outputMultiRefsFlag = true;
AttributesImpl attrs = new AttributesImpl();
attrs.addAttribute("", "", "", "", "");
String encodingURI = soapConstants.getEncodingURI();
// explicitly state that this attribute is not a root
String prefix = getPrefixForURI(encodingURI);
String root = prefix + ":root";
attrs.addAttribute(encodingURI, Constants.ATTR_ROOT, root,
"CDATA", "0");
// Make sure we put the encodingStyle on each multiref element we output.
addEncodingStyleAttribute(attrs);
// Make a copy of the keySet because it could be updated
// during processing
HashSet keys = new HashSet();
keys.addAll(multiRefValues.keySet());
Iterator i = keys.iterator();
while (i.hasNext())
{
while (i.hasNext())
{
Object val = i.next();
MultiRefItem mri = (MultiRefItem)multiRefValues.get(val);
attrs.setAttribute(0, "", Constants.ATTR_ID, "id", "CDATA",
mri.id);
forceSer = mri.value;
// Now serialize the value.
// The sendType parameter is defaulted for interop purposes.
// Some of the remote services do not know how to
// ascertain the type in these circumstances (though Axis does).
serialize(multirefQName, attrs, mri.value,
mri.xmlType,
true,
Boolean.TRUE); // mri.sendType
}
// Done processing the iterated values. During the serialization
// of the values, we may have run into new nested values. These
// were placed in the secondLevelObjects map, which we will now
// process by changing the iterator to locate these values.
if (secondLevelObjects != null)
{
i = secondLevelObjects.iterator();
secondLevelObjects = null;
}
}
// Reset maps and flags
forceSer = null;
outputMultiRefsFlag = false;
multiRefValues = null;
multiRefIndex = -1;
secondLevelObjects = null;
}
/** Add the encoding style as an attribute
* According to the BP-1.0/4.1.7 we should not do that but the s1as interop tests fail otherwise
* [TDI 11-Sep-2004]
*/
private void addEncodingStyleAttribute(AttributesImpl attrs)
{
String encodingStyle;
if (msgContext != null)
{
encodingStyle = msgContext.getEncodingStyle();
}
else
{
encodingStyle = soapConstants.getEncodingURI();
}
String encStyle = getPrefixForURI(soapConstants.getEnvelopeURI()) + ':' + Constants.ATTR_ENCODING_STYLE;
attrs.addAttribute(soapConstants.getEnvelopeURI(), Constants.ATTR_ENCODING_STYLE, encStyle, "CDATA", encodingStyle);
}
public void startDocument() throws IOException
{
if (startOfDocument && sendXMLDecl)
{
writer.write("<?xml version=\"1.0\" encoding=\"");
// The origional logic is very simple
// writer.write(XMLUtils.getEncoding());
// The following logic is devised to utilize CHARACTER_SET_ENCODING property from SAAJ 1.2.
String encoding = null;
if (msgContext != null)
{
encoding = (String)msgContext.getProperty(SOAPMessage.CHARACTER_SET_ENCODING);
}
if (encoding == null)
{
encoding = XMLUtils.getEncoding();
}
writer.write(encoding);
writer.write("\"?>\n");
startOfDocument = false;
}
}
public void endDocument() throws IOException
{
}
/**
* Writes (using the Writer) the start tag for element QName along with the
* indicated attributes and namespace mappings.
*
* @param qName is the name of the element
* @param attributes are the attributes to write
*/
public void startElement(QName qName, Attributes attributes)
throws IOException
{
ArrayList vecQNames = new ArrayList();
if (log.isDebugEnabled())
{
log.debug(Messages.getMessage("startElem00",
"[" + qName.getNamespaceURI() + "]:" + qName.getLocalPart()));
}
if (writingStartTag)
{
writer.write('>');
if (pretty) writer.write(JavaUtils.LS);
indent++;
}
if (pretty) for (int i = 0; i < indent; i++) writer.write(' ');
String elementQName = qName2String(qName, true);
writer.write('<');
writer.write(elementQName);
if (attributes != null)
{
for (int i = 0; i < attributes.getLength(); i++)
{
String qname = attributes.getQName(i);
writer.write(' ');
String prefix = "";
String uri = attributes.getURI(i);
if (uri != null && uri.length() > 0)
{
if (qname.length() == 0)
{
// If qname isn't set, generate one
prefix = getPrefixForURI(uri);
}
else
{
// If it is, make sure the prefix looks reasonable.
int idx = qname.indexOf(':');
if (idx > -1)
{
prefix = qname.substring(0, idx);
prefix = getPrefixForURI(uri, prefix, true);
}
if (uri.equals(Constants.NS_URI_XMLNS))
{
prefix = "xmlns";
}
}
if (prefix.length() > 0)
{
qname = prefix + ':' + attributes.getLocalName(i);
}
else
{
qname = attributes.getLocalName(i);
}
}
else
{
qname = attributes.getQName(i);
if (qname.length() == 0)
qname = attributes.getLocalName(i);
}
if (qname.startsWith("xmlns"))
{
vecQNames.add(qname);
}
writer.write(qname);
writer.write("=\"");
writer.write(XMLUtils.xmlEncodeString(attributes.getValue(i)));
writer.write('"');
}
}
if (noNamespaceMappings)
{
nsStack.push();
}
else
{
for (Mapping map = nsStack.topOfFrame(); map != null; map = nsStack.next())
{
StringBuffer sb = new StringBuffer("xmlns");
boolean isDefaultNS = map.getPrefix().equals("");
if (!isDefaultNS || !isNoDefaultNamespace())
{
if (!isDefaultNS)
{
sb.append(':');
sb.append(map.getPrefix());
}
if (vecQNames.indexOf(sb.toString()) == -1)
{
writer.write(' ');
sb.append("=\"");
sb.append(map.getNamespaceURI());
sb.append('"');
writer.write(sb.toString());
}
}
}
noNamespaceMappings = true;
}
writingStartTag = true;
elementStack.push(qName);
onlyXML = true;
}
/**
* Writes the end element tag for the open element.
*/
public void endElement()
throws IOException
{
QName qname = (QName)elementStack.pop();
String elementQName = qName2String(qname, true);
if (log.isDebugEnabled())
{
log.debug(Messages.getMessage("endElem00", "" + elementQName));
}
nsStack.pop();
if (writingStartTag)
{
if (sendMinimizedElements)
{
writer.write("/>");
}
else
{
writer.write("></");
writer.write(elementQName);
writer.write('>');
}
if (pretty) writer.write(JavaUtils.LS);
writingStartTag = false;
return;
}
if (onlyXML)
{
indent--;
if (pretty) for (int i = 0; i < indent; i++) writer.write(' ');
}
writer.write("</");
writer.write(elementQName);
writer.write('>');
if (pretty) if (indent > 0) writer.write(JavaUtils.LS);
onlyXML = true;
}
/**
* Convenience operation to write out (to Writer) the characters
* in p1 starting at index p2 for length p3.
*
* @param p1 character array to write
* @param p2 starting index in array
* @param p3 length to write
*/
public void writeChars(char[] p1, int p2, int p3)
throws IOException
{
if (writingStartTag)
{
writer.write('>');
writingStartTag = false;
}
writeSafeString(String.valueOf(p1, p2, p3));
onlyXML = false;
}
/**
* Convenience operation to write out (to Writer) the String
*
* @param string is the String to write.
*/
public void writeString(String string)
throws IOException
{
if (writingStartTag)
{
writer.write('>');
writingStartTag = false;
}
writer.write(string);
onlyXML = false;
}
/**
* Convenience operation to write out (to Writer) the String
* properly encoded with xml entities (like &)
*
* @param string is the String to write.
*/
public void writeSafeString(String string)
throws IOException
{
writeString(XMLUtils.xmlEncodeString(string));
}
/**
* Output a DOM representation to a SerializationContext
*
* @param el is a DOM Element
*/
public void writeDOMElement(Element el)
throws IOException
{
AttributesImpl attributes = null;
NamedNodeMap attrMap = el.getAttributes();
if (attrMap.getLength() > 0)
{
attributes = new AttributesImpl();
for (int i = 0; i < attrMap.getLength(); i++)
{
Attr attr = (Attr)attrMap.item(i);
String tmp = attr.getNamespaceURI();
if (tmp != null && tmp.equals(Constants.NS_URI_XMLNS))
{
String prefix = attr.getLocalName();
if (prefix != null)
{
if (prefix.equals("xmlns"))
prefix = "";
String nsURI = attr.getValue();
registerPrefixForURI(prefix, nsURI);
}
continue;
}
attributes.addAttribute(attr.getNamespaceURI(),
attr.getLocalName(),
attr.getName(),
"CDATA", attr.getValue());
}
}
String namespaceURI = el.getNamespaceURI();
String localPart = el.getLocalName();
if (localPart == null)
localPart = el.getNodeName();
QName qName = new QName(namespaceURI, localPart);
startElement(qName, attributes);
NodeList children = el.getChildNodes();
for (int i = 0; i < children.getLength(); i++)
{
Node child = children.item(i);
if (child instanceof Element)
{
writeDOMElement((Element)child);
}
else if (child instanceof CDATASection)
{
writeString("<![CDATA[");
writeString(((Text)child).getData());
writeString("]]>");
}
else if (child instanceof Comment)
{
writeString("<!--");
writeString(((CharacterData)child).getData());
writeString("-->");
}
else if (child instanceof Text)
{
writeSafeString(((Text)child).getData());
}
}
endElement();
}
/**
* Convenience method to get the Serializer for a specific
* java type
*
* @param javaType is Class for a type to serialize
* @return Serializer
*/
public final Serializer getSerializerForJavaType(Class javaType)
{
SerializerFactory serF = null;
Serializer ser = null;
try
{
serF = (SerializerFactory)getTypeMapping().getSerializer(javaType);
if (serF != null)
{
ser = (Serializer)serF.getSerializerAs(Constants.AXIS_SAX);
}
}
catch (JAXRPCException e)
{
}
return ser;
}
/**
* Obtains the type attribute that should be serialized and returns the new list of Attributes
*
* @param attributes of the qname
* @param type is the qname of the type
* @return new list of Attributes
*/
public Attributes setTypeAttribute(Attributes attributes, QName type)
{
if (type == null ||
type.getLocalPart().indexOf(SymbolTable.ANON_TOKEN) >= 0 ||
((attributes != null) &&
(attributes.getIndex(Constants.URI_DEFAULT_SCHEMA_XSI,
"type") != -1)))
return attributes;
AttributesImpl attrs = new AttributesImpl();
if (attributes != null && 0 < attributes.getLength())
attrs.setAttributes(attributes);
String prefix = getPrefixForURI(Constants.URI_DEFAULT_SCHEMA_XSI,
"xsi");
attrs.addAttribute(Constants.URI_DEFAULT_SCHEMA_XSI,
"type",
prefix + ":type",
"CDATA", attributeQName2String(type));
return attrs;
}
/**
* Invoked to do the actual serialization of the qName (called by serialize above).
* additional attributes that will be serialized with the qName.
*
* @param elemQName is the QName of the element
* @param attributes are additional attributes
* @param value is the object to serialize
* @param xmlType (optional) is the desired type QName.
* @param sendType indicates whether the xsi:type attribute should be set.
*/
private void serializeActual(QName elemQName,
Attributes attributes,
Object value,
QName xmlType,
Boolean sendType)
throws IOException
{
boolean shouldSendType = (sendType == null) ? shouldSendXSIType() :
sendType.booleanValue();
if (value != null)
{
Class javaType = value.getClass();
TypeMapping tm = getTypeMapping();
if (tm == null)
{
throw new IOException(Messages.getMessage("noSerializer00",
value.getClass().getName(),
"" + this));
}
// Set currentXMLType to the one desired one.
// Note for maxOccurs usage this xmlType is the
// type of the component not the type of the array.
currentXMLType = xmlType;
// if we're looking for xsd:anyType, accept anything...
if (Constants.equals(Constants.XSD_ANYTYPE, xmlType))
{
xmlType = null;
shouldSendType = true;
}
// Try getting a serializer for the prefered xmlType
QNameHolder actualXMLType = new QNameHolder();
Serializer ser = getSerializer(javaType, xmlType, actualXMLType);
if (ser != null)
{
// Send the xmlType if indicated or if
// the actual xmlType is different than the
// prefered xmlType
if (shouldSendType || (xmlType != null && !xmlType.equals(actualXMLType.value)))
{
// Only do this if we are encoded
// TDI 21-June-2004
if (msgContext != null && msgContext.isEncoded())
attributes = setTypeAttribute(attributes, actualXMLType.value);
}
// -----------------
// NOTE: I have seen doc/lit tests that use
// the type name as the element name in multi-ref cases
// (for example <soapenc:Array ... >)
// In such cases the xsi:type is not passed along.
// -----------------
// The multiref QName is our own fake name.
// It may be beneficial to set the name to the
// type name, but I didn't see any improvements
// in the interop tests.
//if (name.equals(multirefQName) && type != null)
// name = type;
ser.serialize(elemQName, attributes, value, this);
return;
}
// if no serializer was configured try to find one dynamically using WSDLJava
// generated metadata
try
{
Method method = value.getClass().getMethod("getSerializer", getSerializerClasses);
if (method != null)
{
Serializer serializer = (Serializer)method.invoke(value,
new Object[]{"", value.getClass(), elemQName});
TypeDesc typedesc = TypeDesc.getTypeDescForClass(value.getClass());
if (typedesc != null)
{
QName qname = typedesc.getXmlType();
if (qname != null)
{
attributes = setTypeAttribute(attributes,
qname);
}
}
serializer.serialize(elemQName, attributes, value, this);
return;
}
}
catch (Exception e)
{
}
throw new IOException(Messages.getMessage("noSerializer00",
value.getClass().getName(), "" + tm));
}
// !!! Write out a generic null, or get type info from somewhere else?
}
/**
* Get the currently prefered xmlType
*
* @return QName of xmlType or null
*/
public QName getCurrentXMLType()
{
return currentXMLType;
}
/**
* Walk the interfaces of a class looking for a serializer for that
* interface. Include any parent interfaces in the search also.
*/
private SerializerFactory getSerializerFactoryFromInterface(Class javaType,
QName xmlType,
TypeMapping tm)
{
SerializerFactory serFactory = null;
Class[] interfaces = javaType.getInterfaces();
if (interfaces != null)
{
for (int i = 0; i < interfaces.length; i++)
{
Class iface = interfaces[i];
serFactory = (SerializerFactory)tm.getSerializer(iface,
xmlType);
if (serFactory == null)
serFactory = getSerializerFactoryFromInterface(iface, xmlType, tm);
if (serFactory != null)
break;
}
}
return serFactory;
}
/**
* getSerializer
* Attempts to get a serializer for the indicated javaType and xmlType.
*
* @param javaType is the type of the object
* @param xmlType is the preferred qname type.
* @param actualXMLType is set to a QNameHolder or null.
* If a QNameHolder, the actual xmlType is returned.
* @return found class/serializer or null
*/
private Serializer getSerializer(Class javaType, QName xmlType, QNameHolder actualXMLType)
{
log.debug("Enter:getSerializer: [class=" + javaType + ",xmlType=" + xmlType + "]");
SerializerFactory serFactory = null;
TypeMapping tm = getTypeMapping();
if (actualXMLType != null)
{
actualXMLType.value = null;
}
while (javaType != null)
{
serFactory = (SerializerFactory)tm.getSerializer(javaType, xmlType);
if (serFactory != null)
break;
// Walk my interfaces...
serFactory = getSerializerFactoryFromInterface(javaType, xmlType, tm);
// Finally, head to my superclass
if (serFactory != null)
break;
javaType = javaType.getSuperclass();
}
// Using the serialization factory, create a serializer
Serializer ser = null;
if (serFactory != null)
{
ser = (Serializer)serFactory.getSerializerAs(Constants.AXIS_SAX);
if (actualXMLType != null)
{
// Get the actual qname xmlType from the factory.
// If not found via the factory, fall back to a less
// performant solution.
if (serFactory instanceof BaseSerializerFactory)
{
actualXMLType.value =
((BaseSerializerFactory)serFactory).getXMLType();
}
if (actualXMLType.value == null)
{
actualXMLType.value =
((TypeMappingImpl)tm).getXMLType(javaType,
xmlType);
}
}
}
log.debug("Exit:getSerializer: " + ser);
return ser;
}
public String getValueAsString(Object value, QName xmlType) throws IOException
{
Serializer ser = getSerializer(value.getClass(), xmlType, null);
if (!(ser instanceof SimpleValueSerializer))
{
throw new IOException(Messages.getMessage("needSimpleValueSer",
ser.getClass().getName()));
}
SimpleValueSerializer simpleSer = (SimpleValueSerializer)ser;
return simpleSer.getValueAsString(value, this);
}
/** Get the stack of element qnames.
*/
public Stack getElementStack()
{
return elementStack;
}
}
| SerializationContextImpl.java |