KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > Body


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;
59
60 import java.io.*;
61 import java.util.*;
62 import org.w3c.dom.*;
63 import org.apache.soap.util.*;
64 import org.apache.soap.util.xml.*;
65 import org.apache.soap.encoding.*;
66 import org.apache.soap.rpc.SOAPContext;
67
68 /**
69  * A <code>Body</code> object represents the contents and semantics
70  * of a <code>&lt;SOAP-ENV:Body&gt;</code> element.
71  *
72  * @author Matthew J. Duftler (duftler@us.ibm.com)
73  * @author Sanjiva Weerawarana (sanjiva@watson.ibm.com)
74  */

75 public class Body
76 {
77   private Vector bodyEntries = null;
78   private AttributeHandler attrHandler = new AttributeHandler();
79
80   public void setAttribute(QName attrQName, String JavaDoc value)
81   {
82     attrHandler.setAttribute(attrQName, value);
83   }
84
85   public String JavaDoc getAttribute(QName attrQName)
86   {
87     return attrHandler.getAttribute(attrQName);
88   }
89
90   public void removeAttribute(QName attrQName)
91   {
92     attrHandler.removeAttribute(attrQName);
93   }
94
95   public void declareNamespace(String JavaDoc nsPrefix, String JavaDoc namespaceURI)
96   {
97     attrHandler.declareNamespace(nsPrefix, namespaceURI);
98   }
99
100   public void setBodyEntries(Vector bodyEntries)
101   {
102     this.bodyEntries = bodyEntries;
103   }
104
105   public Vector getBodyEntries()
106   {
107     return bodyEntries;
108   }
109
110   public void marshall(String JavaDoc inScopeEncStyle, Writer sink, NSStack nsStack,
111                        XMLJavaMappingRegistry xjmr, SOAPContext ctx)
112     throws IllegalArgumentException JavaDoc, IOException
113   {
114     attrHandler.populateNSStack(nsStack);
115
116     String JavaDoc declEncStyle = getAttribute(new QName(
117       Constants.NS_URI_SOAP_ENV, Constants.ATTR_ENCODING_STYLE));
118     String JavaDoc actualEncStyle = declEncStyle != null
119                             ? declEncStyle
120                             : inScopeEncStyle;
121
122     // Determine the prefix associated with the NS_URI_SOAP_ENV namespace URI.
123
String JavaDoc soapEnvNSPrefix = attrHandler.getUniquePrefixFromURI(
124       Constants.NS_URI_SOAP_ENV, Constants.NS_PRE_SOAP_ENV, nsStack);
125
126     sink.write('<' + soapEnvNSPrefix + ':' + Constants.ELEM_BODY);
127
128     // Serialize any body attributes.
129
attrHandler.marshall(sink, ctx);
130
131     sink.write('>' + StringUtils.lineSeparator);
132
133     // Serialize any body entries.
134
if (bodyEntries != null)
135     {
136       for (Enumeration e = bodyEntries.elements(); e.hasMoreElements();)
137       {
138         Object JavaDoc obj = e.nextElement();
139         if (obj instanceof Bean)
140         {
141           Bean bodyEntry = (Bean) obj;
142           
143           if (Serializer.class.isAssignableFrom(bodyEntry.type))
144           {
145             ((Serializer)bodyEntry.value).marshall(actualEncStyle,
146                                                    bodyEntry.type,
147                                                    bodyEntry.value,
148                                                    null,
149                                                    sink,
150                                                    nsStack,
151                                                    xjmr,
152                                                    ctx);
153           }
154           else
155           {
156             throw new IllegalArgumentException JavaDoc("Body entries must implement " +
157                                                "the Serializer interface.");
158           }
159         }
160         else if (obj instanceof Element)
161         {
162           Utils.marshallNode((Element)obj, sink);
163         }
164         else
165         {
166           throw new IllegalArgumentException JavaDoc("Unknown type of body entry: '" +
167                                              obj.getClass () + "'");
168         }
169         sink.write(StringUtils.lineSeparator);
170       }
171     }
172
173     sink.write("</" + soapEnvNSPrefix + ':' + Constants.ELEM_BODY + '>' +
174                StringUtils.lineSeparator);
175
176     nsStack.popScope();
177   }
178
179   public static Body unmarshall(Node src, SOAPContext ctx) throws IllegalArgumentException JavaDoc
180   {
181     Element root = (Element)src;
182     Body body = new Body();
183     Vector bodyEntries = new Vector();
184
185     // Deserialize any body attributes.
186
body.attrHandler = AttributeHandler.unmarshall(root, ctx);
187
188     for (Element el = DOMUtils.getFirstChildElement(root);
189                  el != null;
190                  el = DOMUtils.getNextSiblingElement(el))
191     {
192       bodyEntries.addElement(el);
193     }
194
195     body.setBodyEntries(bodyEntries);
196
197     return body;
198   }
199
200   public String JavaDoc toString()
201   {
202     StringWriter sw = new StringWriter();
203     PrintWriter pw = new PrintWriter(sw);
204
205     pw.print("[Attributes=" + attrHandler + "] " +
206              "[BodyEntries=");
207
208     if (bodyEntries != null)
209     {
210       pw.println();
211
212       for (int i = 0; i < bodyEntries.size(); i++)
213       {
214         pw.println("[(" + i + ")=" + bodyEntries.elementAt(i) + "]");
215       }
216     }
217
218     pw.print("]");
219
220     return sw.toString();
221   }
222 }
223
Popular Tags