KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > encoding > soapenc > HashtableSerializer


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "SOAP" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2000, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */

57
58 package org.apache.soap.encoding.soapenc;
59
60 import java.beans.*;
61 import java.io.*;
62 import java.util.*;
63 import java.lang.reflect.*;
64 import org.w3c.dom.*;
65 import org.apache.soap.util.*;
66 import org.apache.soap.util.xml.*;
67 import org.apache.soap.*;
68 import org.apache.soap.rpc.*;
69
70 /**
71  * A <code>HashtableSerializer</code> can be used to serialize and
72  * deserialize Hashtables using the <code>SOAP-ENC</code>
73  * encoding style.<p>
74  *
75  * TODO: This should eventually deal with Maps, but doesn't yet.
76  *
77  * @author Glen Daniels (gdaniels@allaire.com)
78  */

79 public class HashtableSerializer implements Serializer, Deserializer
80 {
81   private static final String JavaDoc STR_KEY = "key";
82   private static final String JavaDoc STR_ITEM = "item";
83   private static final String JavaDoc STR_VALUE = "value";
84   
85   public void marshall(String JavaDoc inScopeEncStyle, Class JavaDoc javaType, Object JavaDoc src,
86                        Object JavaDoc context, Writer sink, NSStack nsStack,
87                        XMLJavaMappingRegistry xjmr, SOAPContext ctx)
88     throws IllegalArgumentException JavaDoc, IOException
89   {
90     if (src == null)
91     {
92       SoapEncUtils.generateNullStructure(inScopeEncStyle,
93                                          javaType,
94                                          context,
95                                          sink,
96                                          nsStack,
97                                          xjmr);
98     }
99     else if (src instanceof Hashtable)
100     {
101       SoapEncUtils.generateStructureHeader(inScopeEncStyle,
102                                            javaType,
103                                            context,
104                                            sink,
105                                            nsStack,
106                                            xjmr);
107
108       sink.write(StringUtils.lineSeparator);
109
110       Hashtable hash = (Hashtable)src;
111
112       for (Enumeration e = hash.keys(); e.hasMoreElements(); )
113       {
114         Object JavaDoc key = e.nextElement();
115         Object JavaDoc value = hash.get(key);
116
117         sink.write("<" + STR_ITEM + ">");
118         sink.write(StringUtils.lineSeparator);
119
120         // ??? Deal with null keys?
121
xjmr.marshall(Constants.NS_URI_SOAP_ENC, key.getClass(), key, STR_KEY,
122                       sink, nsStack, ctx);
123         sink.write(StringUtils.lineSeparator);
124
125         if (value == null)
126         {
127           SoapEncUtils.generateNullStructure(Constants.NS_URI_SOAP_ENC,
128                                              Object JavaDoc.class, STR_VALUE, sink,
129                                              nsStack, xjmr);
130         }
131         else
132         {
133           Class JavaDoc actualComponentType = value.getClass();
134
135           xjmr.marshall(Constants.NS_URI_SOAP_ENC, actualComponentType, value,
136                         STR_VALUE, sink, nsStack, ctx);
137         }
138
139         sink.write(StringUtils.lineSeparator);
140         sink.write("</" + STR_ITEM + ">");
141         sink.write(StringUtils.lineSeparator);
142       }
143
144       sink.write("</" + context + '>');
145     }
146     else
147     {
148       throw new IllegalArgumentException JavaDoc("Tried to pass a '" +
149                                          src.getClass().toString() +
150                                          "' to HashtableSerializer");
151     }
152   }
153
154   public Bean unmarshall(String JavaDoc inScopeEncStyle, QName elementType, Node src,
155                          XMLJavaMappingRegistry xjmr, SOAPContext ctx)
156     throws IllegalArgumentException JavaDoc
157   {
158     Element root = (Element)src;
159     String JavaDoc name = root.getTagName();
160
161     if (SoapEncUtils.isNull(root))
162     {
163       return new Bean(Hashtable.class, null);
164     }
165
166     Hashtable hash = new Hashtable();
167     Element tempEl = DOMUtils.getFirstChildElement(root);
168
169     while (tempEl != null) {
170       // got an item
171
Element keyEl = DOMUtils.getFirstChildElement(tempEl);
172       String JavaDoc tagName = keyEl.getTagName();
173
174       if (!tagName.equalsIgnoreCase(STR_KEY))
175       {
176         throw new IllegalArgumentException JavaDoc("Got <" + tagName +
177                                            "> tag when expecting <" +
178                                            STR_KEY + ">");
179       }
180
181       Element valEl = DOMUtils.getNextSiblingElement(keyEl);
182
183       tagName = valEl.getTagName();
184
185       if (!tagName.equalsIgnoreCase("value"))
186       {
187         throw new IllegalArgumentException JavaDoc("Got <" + tagName +
188                                            "> tag when expecting <" +
189                                            STR_VALUE + ">");
190       }
191
192       Bean keyBean = unmarshallEl(inScopeEncStyle, xjmr, keyEl, ctx);
193       Bean valBean = unmarshallEl(inScopeEncStyle, xjmr, valEl, ctx);
194
195       hash.put(keyBean.value, valBean.value);
196
197       tempEl = DOMUtils.getNextSiblingElement(tempEl);
198     }
199
200     return new Bean(Hashtable.class, hash);
201   }
202
203   private Bean unmarshallEl(String JavaDoc inScopeEncStyle,
204                             XMLJavaMappingRegistry xjmr,
205                             Element targetEl, SOAPContext ctx)
206   {
207     String JavaDoc declEncStyle = DOMUtils.getAttributeNS(targetEl,
208         Constants.NS_URI_SOAP_ENV, Constants.ATTR_ENCODING_STYLE);
209     String JavaDoc actualEncStyle = (declEncStyle != null)
210                             ? declEncStyle
211                             : inScopeEncStyle;
212     QName declItemType = SoapEncUtils.getTypeQName(targetEl);
213
214     return xjmr.unmarshall(actualEncStyle, declItemType, targetEl, ctx);
215   }
216 }
217
Popular Tags