You are viewing a plain text version of this content. The canonical link for it is here.
Posted to soap-dev@ws.apache.org by Glen Daniels <gd...@locus.apache.org> on 2000/07/06 20:14:18 UTC

cvs commit: xml-soap/java/src/org/apache/soap/encoding/soapenc VectorSerializer.java

gdaniels    00/07/06 11:14:18

  Added:       java/src/org/apache/soap/encoding/soapenc
                        VectorSerializer.java
  Log:
  Serializer for Vectors and Enumerations.  Only serializes right now, as we need some form of configuration to indicate that a particular SOAP-ENC:array should deserialize to a Vector...
  
  Revision  Changes    Path
  1.1                  xml-soap/java/src/org/apache/soap/encoding/soapenc/VectorSerializer.java
  
  Index: VectorSerializer.java
  ===================================================================
  /*
   * The Apache Software License, Version 1.1
   *
   *
   * Copyright (c) 2000 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 "SOAP" 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 and was
   * originally based on software copyright (c) 2000, International
   * Business Machines, Inc., http://www.apache.org.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   */
  
  package org.apache.soap.encoding.soapenc;
  
  import java.beans.*;
  import java.io.*;
  import java.util.*;
  import java.lang.reflect.*;
  import org.w3c.dom.*;
  import org.apache.soap.util.*;
  import org.apache.soap.util.xml.*;
  import org.apache.soap.*;
  import org.apache.soap.rpc.*;
  
  /**
   * A <code>VectorSerializer</code> can be used to serialize (but not
   * deserialize) Vectors and Enumerations using the <code>SOAP-ENC</code>
   * encoding style.<p>
   * 
   * This serializer turns Vectors/Enumerations into SOAP arrays.
   * 
   * @author Glen Daniels (gdaniels@allaire.com)
   */
  public class VectorSerializer implements Serializer, Deserializer
  {
    public void marshall(String inScopeEncStyle, Class javaType, Object src,
                         Object context, Writer sink, NSStack nsStack,
                         XMLJavaMappingRegistry xjmr)
      throws IllegalArgumentException, IOException
    {
      nsStack.pushScope();
  
      if ((src != null) && 
  		!(src instanceof Vector) &&
  		!(src instanceof Enumeration))
        throw new IllegalArgumentException("Tried to pass a '" +
  			src.getClass().toString() + "' to VectorSerializer");
  
  	String lengthStr;
  	Enumeration enum;
  	
  	if (src instanceof Enumeration) {
  		/** TODO: Right now we don't include a length on Enumerations,
  		 * due to efficiency concerns.  There should be a way to configure
  		 * doing the length calculation (at the cost of traversing the
  		 * Enumeration) for a particular installation/service/call.
  		 */
  		enum = (Enumeration)src;
  		lengthStr = "";
  	} else {
  		Vector v = (Vector)src;
  		enum = v.elements();
  	
  		lengthStr = src != null
                         ? v.size() + ""
                         : "";
  	}
  
      // Since a Vector can hold objects....
      Class componentType = Object.class;
      QName elementType = xjmr.queryElementType(componentType,
                                                Constants.NS_URI_SOAP_ENC);
  
      if (src == null)
      {
        SoapEncUtils.generateNullArray(inScopeEncStyle,
                                       javaType,
                                       context,
                                       sink,
                                       nsStack,
                                       xjmr,
                                       elementType,
                                       lengthStr);
      }
      else
      {
        SoapEncUtils.generateArrayHeader(inScopeEncStyle,
                                         javaType,
                                         context,
                                         sink,
                                         nsStack,
                                         xjmr,
                                         elementType,
                                         lengthStr);
  
        sink.write(StringUtils.lineSeparator);
  
        for (Enumeration e = enum; e.hasMoreElements(); )
        {
          nsStack.pushScope();
  
          Object value = e.nextElement();
  
          if (value == null)
          {
            SoapEncUtils.generateNullStructure(inScopeEncStyle, componentType,
                                               "item", sink, nsStack, xjmr);
          }
          else
          {
            Class actualComponentType = value.getClass();
  
            xjmr.marshall(inScopeEncStyle, actualComponentType, value, "item",
                          sink, nsStack);
          }
  
          sink.write(StringUtils.lineSeparator);
          nsStack.popScope();
        }
  
        sink.write("</" + context + '>');
      }
  
      nsStack.popScope();
    }
  
    public Bean unmarshall(String inScopeEncStyle, QName elementType, Node src,
                           XMLJavaMappingRegistry xjmr)
      throws IllegalArgumentException
    {
  	  throw new IllegalArgumentException("VectorSerializer used for deserialization");
    }
  
  }