KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > wsif > WSIFResponse


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2002 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 "WSIF" 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) 2001, 2002, 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.wsif;
59
60 import java.io.Serializable JavaDoc;
61
62 import javax.xml.namespace.QName JavaDoc;
63
64 /**
65  * This class represents a service response coming out of WSIF. It
66  * contains the outgoing message or fault message, context information
67  * as well as other information.
68  *
69  * @author Sanjiva Weerawarana <sanjiva@watson.ibm.com>
70  * @author Paul Fremantle <pzf@uk.ibm.com>
71  */
72 public class WSIFResponse implements Serializable JavaDoc {
73     
74     private static final long serialVersionUID = 1L;
75     
76     QName JavaDoc serviceID;
77     String JavaDoc operationName;
78     boolean isFault = false;
79     WSIFMessage outgoingMessage;
80     WSIFMessage faultMessage;
81     WSIFMessage contextMessage;
82
83     String JavaDoc portName;
84     String JavaDoc inputName;
85     String JavaDoc outputName;
86     /**
87      * Constructor.
88      */
89     public WSIFResponse(QName JavaDoc serviceID) {
90         this.serviceID = serviceID;
91     }
92
93     /**
94      * Get the service ID.
95      */
96     public QName JavaDoc getServiceID() {
97         return serviceID;
98     }
99
100     /**
101      * Set the operation name.
102      */
103     public void setOperationName(String JavaDoc operationName) {
104         this.operationName = operationName;
105     }
106
107     /**
108      * Get the operation name.
109      */
110     public String JavaDoc getOperationName() {
111         return operationName;
112     }
113
114     /**
115      * Indicate whether this response contains a a fault message or an
116      * ok response message. Defaults to ok (i.e., the value of the flag
117      * is false).
118      */
119     public void setIsFault(boolean isFault) {
120         this.isFault = isFault;
121     }
122
123     /**
124      * Get the value of the isFault flag. True if response contains a
125      * fault and false otherwise.
126      */
127     public boolean getIsFault() {
128         return isFault;
129     }
130
131     /**
132      * Set the outgoing message. The outgoing message or the fault
133      * message must be set for any given response.
134      */
135     public void setOutgoingMessage(WSIFMessage outgoingMessage) {
136         this.outgoingMessage = outgoingMessage;
137     }
138
139     /**
140      * Get the outgoing message.
141      */
142     public WSIFMessage getOutgoingMessage() {
143         return outgoingMessage;
144     }
145
146     /**
147      * Set the fault message. The outgoing message or the fault
148      * message must be set for any given response.
149      */
150     public void setFaultMessage(WSIFMessage faultMessage) {
151         this.faultMessage = faultMessage;
152     }
153
154     /**
155      * Get the fault message.
156      */
157     public WSIFMessage getFaultMessage() {
158         return faultMessage;
159     }
160
161     /**
162      * Set the context message.
163      */
164     public void setContextMessage(WSIFMessage contextMessage) {
165         this.contextMessage = contextMessage;
166     }
167
168     /**
169      * Get the context message.
170      */
171     public WSIFMessage getContextMessage() {
172         return contextMessage;
173     }
174
175     /**
176      * Printable version.
177      */
178     public String JavaDoc toString() {
179         return "[WSIFResponse:\n"
180             + "\t serviceID = '"
181             + serviceID
182             + "'\n"
183             + "\t operationName = '"
184             + operationName
185             + "'\n"
186             + "\t isFault = '"
187             + isFault
188             + "'\n"
189             + "\t outgoingMessage = '"
190             + outgoingMessage
191             + "'\n"
192             + "\t faultMessage = '"
193             + faultMessage
194             + "'\n"
195             + "\t contextMessage = '"
196             + contextMessage
197             + "']";
198     }
199     /**
200      * Gets the portName
201      * @return Returns a String
202      */
203     public String JavaDoc getPortName() {
204         return portName;
205     }
206     /**
207      * Sets the portName
208      * @param portName The portName to set
209      */
210     public void setPortName(String JavaDoc portName) {
211         this.portName = portName;
212     }
213
214     /**
215      * Gets the inputName
216      * @return Returns a String
217      */
218     public String JavaDoc getInputName() {
219         return inputName;
220     }
221     /**
222      * Sets the inputName
223      * @param inputName The inputName to set
224      */
225     public void setInputName(String JavaDoc inputName) {
226         this.inputName = inputName;
227     }
228
229     /**
230      * Gets the outputName
231      * @return Returns a String
232      */
233     public String JavaDoc getOutputName() {
234         return outputName;
235     }
236     /**
237      * Sets the outputName
238      * @param outputName The outputName to set
239      */
240     public void setOutputName(String JavaDoc outputName) {
241         this.outputName = outputName;
242     }
243
244 }
245
Popular Tags