KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > rpc > Response


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.rpc;
59
60 import java.io.*;
61 import java.util.*;
62 import org.w3c.dom.*;
63 import org.apache.soap.util.xml.*;
64 import org.apache.soap.*;
65 import org.apache.soap.encoding.*;
66 import javax.mail.MessagingException JavaDoc;
67 import javax.mail.BodyPart JavaDoc;
68
69 /**
70  * A <code>Response</code> object represents an <em>RPC</em> response. Both
71  * the client and the server use <code>Response</code> objects to represent
72  * the result of a method invocation.
73  *
74  * @author Matthew J. Duftler (duftler@us.ibm.com)
75  * @author Sanjiva Weerawarana (sanjiva@watson.ibm.com)
76  */

77 public class Response extends RPCMessage
78 {
79   private Parameter returnValue;
80   private Fault fault;
81
82   /**
83    * Use this constructor when everything went well.
84    */

85   public Response(String JavaDoc targetObjectURI, String JavaDoc methodName,
86                   Parameter returnValue, Vector params, Header header,
87                   String JavaDoc encodingStyleURI, SOAPContext ctx)
88   {
89     super(targetObjectURI, methodName, params, header, encodingStyleURI, ctx);
90
91     this.returnValue = returnValue;
92   }
93
94   /**
95    * Use this constructor when things didn't go so well.
96    */

97   public Response(String JavaDoc targetObjectURI, String JavaDoc methodName,
98                   Fault fault, Vector params, Header header,
99                   String JavaDoc encodingStyleURI, SOAPContext ctx)
100   {
101     super(targetObjectURI, methodName, params, header, encodingStyleURI,
102           ctx);
103
104     this.fault = fault;
105   }
106
107   public void setReturnValue(Parameter returnValue)
108   {
109     this.returnValue = returnValue;
110   }
111
112   public Parameter getReturnValue()
113   {
114     return returnValue;
115   }
116
117   public void setFault(Fault fault)
118   {
119     this.fault = fault;
120   }
121
122   public Fault getFault()
123   {
124     return fault;
125   }
126
127   public boolean generatedFault()
128   {
129     return fault != null;
130   }
131
132   public Envelope buildEnvelope()
133   {
134     return super.buildEnvelope(true);
135   }
136
137   public static Response extractFromEnvelope(Envelope env,
138                                              SOAPMappingRegistry smr,
139                                              SOAPContext ctx)
140     throws IllegalArgumentException JavaDoc
141   {
142     return (Response)RPCMessage.extractFromEnvelope(env, null, true, smr, ctx);
143   }
144
145   /**
146    * Find the Mimepart referred to by the given URI. This can be:<ul>
147    * <li>An absolute URI, in which case a part is located with a
148    * corresponding Content-Location header.
149    * <li>A relative URI, in which case an absolute URI is constructed
150    * relative to the Content-Location header of the root SOAP part
151    * or the multipart and the previous rule is then applied.
152    * <li>A URI of the format "cid:xxx"> in which case a part is located
153    * with a matching Content-ID header.
154    * </ul>Returns null if the part is not found.
155    * <p>Note: relative URIs not entirely implemented yet.
156    *
157    * @param uri the URI
158    * @return the Part or null if not found
159    */

160   public BodyPart JavaDoc findBodyPart(String JavaDoc uri) {
161     return ctx.findBodyPart(uri);
162   }
163
164   /**
165    * Return the number of enclosed BodyPart objects.
166    *
167    * @return number of parts
168    * @exception MessagingException
169    */

170   public int getPartCount() throws MessagingException JavaDoc {
171     return ctx.getCount();
172   }
173
174   /**
175    * Get the specified Part by its index. Parts are numbered starting at 0.
176    *
177    * @param index the index of the desired Part
178    * @return the Part
179    * @exception IndexOutOfBoundsException if no such Part exists
180    */

181   public BodyPart JavaDoc getBodyPart(int index) throws IndexOutOfBoundsException JavaDoc {
182     return ctx.getBodyPart(index);
183   }
184 }
185
Popular Tags