KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > soap > transport > SOAPTransport


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.transport;
59
60 import java.net.URL JavaDoc;
61 import java.io.BufferedReader JavaDoc;
62 import java.util.Hashtable JavaDoc;
63 import org.apache.soap.*;
64 import org.apache.soap.encoding.*;
65 import org.apache.soap.rpc.SOAPContext;
66
67 /**
68  * This interface is an abstraction of the transport layer that's carrying
69  * the messages.
70  *
71  * @author Sanjiva Weerawarana (sanjiva@watson.ibm.com)
72  */
73 public interface SOAPTransport {
74   /**
75    * This method is used to request that an envelope be sent.
76    *
77    * @param sendTo the URL to send the envelope to
78    * @param action the SOAPAction header field value
79    * @param headers any other header fields to go to as protocol headers
80    * @param env the envelope to send
81    * @param smr the XML<->Java type mapping registry (passed on)
82    * @param ctx the request SOAPContext
83    *
84    * @exception SOAPException with appropriate reason code if problem
85    */
86   public void send (URL JavaDoc sendTo, String JavaDoc action, Hashtable JavaDoc headers,
87                     Envelope env, SOAPMappingRegistry smr,
88                     SOAPContext ctx)
89     throws SOAPException;
90
91   /**
92    * Return a buffered reader to receive back the response to whatever
93    * was sent to whatever.
94    *
95    * @return a reader to read the results from or null if that's not
96    * possible.
97    */
98   public BufferedReader JavaDoc receive ();
99
100   /**
101    * Return access to headers generated by the protocol.
102    *
103    * @return a hashtable containing all the headers
104    */
105   public Hashtable JavaDoc getHeaders ();
106
107   /**
108    * Return the SOAPContext associated with the response.
109    *
110    * @return response SOAPContext
111    */
112   public SOAPContext getResponseSOAPContext ();
113 }
114
Popular Tags