KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > xmlrpc > XmlRpcTransport


1 /*
2  * Copyright 1999,2005 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 package org.apache.xmlrpc;
19
20 import java.io.InputStream JavaDoc;
21 import java.io.IOException JavaDoc;
22
23 /**
24  * Interface from XML-RPC to an underlying transport, most likely base on HTTP.
25  *
26  * @author <a HREF="mailto:hannes@apache.org">Hannes Wallnoefer</a>
27  * @author <a HREF="mailto:andrew@kungfoocoder.org">Andrew Evers</a>
28  * @version $Id: XmlRpcTransport.java,v 1.3 2005/04/22 10:25:57 hgomez Exp $
29  * @since 1.2
30  */
31 public interface XmlRpcTransport
32 {
33   /**
34    * Send an XML-RPC message. This method is called to send a message to the
35    * other party.
36    *
37    * @param request the request in network encoding.
38    *
39    * @throws IOException if an IOException occurs in the IO level of the transport.
40    * @throws XmlRpcClientException if an exception occurs in the transport.
41    */
42   public InputStream JavaDoc sendXmlRpc(byte [] request)
43   throws IOException JavaDoc, XmlRpcClientException;
44
45   /**
46    * End an XML-RPC request. This method is called by the XmlRpcClient when then
47    * request has been sent and the response (or an exception) recieved.
48    *
49    * @throws XmlRpcClientException if an exception occurs in the transport.
50    */
51   public void endClientRequest()
52   throws XmlRpcClientException;
53 }
54
Popular Tags