KickJava   Java API By Example, From Geeks To Geeks.

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


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>Header</code> object represents the contents and semantics
70  * of a <code>&lt;SOAP-ENV:Header&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 Header
76 {
77   private Vector headerEntries = 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 setHeaderEntries(Vector headerEntries)
101   {
102     this.headerEntries = headerEntries;
103   }
104
105   public Vector getHeaderEntries()
106   {
107     return headerEntries;
108   }
109
110   public void marshall(Writer sink, NSStack nsStack,
111                        XMLJavaMappingRegistry xjmr, SOAPContext ctx)
112     throws IllegalArgumentException JavaDoc, IOException
113   {
114     attrHandler.populateNSStack(nsStack);
115
116     // Determine the prefix associated with the NS_URI_SOAP_ENV namespace URI.
117
String JavaDoc soapEnvNSPrefix = attrHandler.getUniquePrefixFromURI(
118       Constants.NS_URI_SOAP_ENV, Constants.NS_PRE_SOAP_ENV, nsStack);
119
120     // If there are header entries, generate the <SOAP-ENV:Header> element,
121
// and serialize the header entries.
122
if (headerEntries != null)
123     {
124       sink.write('<' + soapEnvNSPrefix + ':' + Constants.ELEM_HEADER);
125
126       // Serialize any header attributes.
127
attrHandler.marshall(sink, ctx);
128
129       sink.write('>' + StringUtils.lineSeparator);
130
131       // Serialize the header entries within the <SOAP-ENV:Header> element.
132
for (Enumeration e = headerEntries.elements(); e.hasMoreElements();)
133       {
134         Element headerEntryEl = (Element)e.nextElement();
135
136         Utils.marshallNode(headerEntryEl, sink);
137
138         sink.write(StringUtils.lineSeparator);
139       }
140
141       sink.write("</" + soapEnvNSPrefix + ':' + Constants.ELEM_HEADER +
142                  '>' + StringUtils.lineSeparator);
143     }
144
145     nsStack.popScope();
146   }
147
148   public static Header unmarshall(Node src, SOAPContext ctx)
149     throws IllegalArgumentException JavaDoc
150   {
151     Element root = (Element)src;
152     Header header = new Header();
153     Vector headerEntries = new Vector();
154
155     // Deserialize any header attributes.
156
header.attrHandler = AttributeHandler.unmarshall(root, ctx);
157
158     for (Element el = DOMUtils.getFirstChildElement(root);
159                  el != null;
160                  el = DOMUtils.getNextSiblingElement(el))
161     {
162       headerEntries.addElement(el);
163     }
164
165     header.setHeaderEntries(headerEntries);
166
167     return header;
168   }
169
170   public String JavaDoc toString()
171   {
172     StringWriter sw = new StringWriter();
173     PrintWriter pw = new PrintWriter(sw);
174
175     pw.print("[Attributes=" + attrHandler + "] " +
176              "[HeaderEntries={");
177
178     if (headerEntries != null)
179     {
180       for (int i = 0; i < headerEntries.size(); i++)
181       {
182         if (i > 0)
183         {
184           pw.print(", ");
185         }
186
187         pw.print("[" + headerEntries.elementAt(i) + "]");
188       }
189     }
190
191     pw.print("}]");
192
193     return sw.toString();
194   }
195 }
196
Popular Tags