01: /*--
02:
03: Copyright (C) 2002 Anthony Eden.
04: All rights reserved.
05:
06: Redistribution and use in source and binary forms, with or without
07: modification, are permitted provided that the following conditions
08: are met:
09:
10: 1. Redistributions of source code must retain the above copyright
11: notice, this list of conditions, and the following disclaimer.
12:
13: 2. Redistributions in binary form must reproduce the above copyright
14: notice, this list of conditions, and the disclaimer that follows
15: these conditions in the documentation and/or other materials
16: provided with the distribution.
17:
18: 3. The names "OBE" and "Open Business Engine" must not be used to
19: endorse or promote products derived from this software without prior
20: written permission. For written permission, please contact
21: me@anthonyeden.com.
22:
23: 4. Products derived from this software may not be called "OBE" or
24: "Open Business Engine", nor may "OBE" or "Open Business Engine"
25: appear in their name, without prior written permission from
26: Anthony Eden (me@anthonyeden.com).
27:
28: In addition, I request (but do not require) that you include in the
29: end-user documentation provided with the redistribution and/or in the
30: software itself an acknowledgement equivalent to the following:
31: "This product includes software developed by
32: Anthony Eden (http://www.anthonyeden.com/)."
33:
34: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
38: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
39: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
40: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
43: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
44: POSSIBILITY OF SUCH DAMAGE.
45:
46: For more information on OBE, please see <http://obe.sourceforge.net/>.
47:
48: */
49:
50: package org.obe.client;
51:
52: import org.apache.xmlrpc.XmlRpcClient;
53:
54: /**
55: * A basic interface implemented by any class which will provide XmlRpcClient
56: * implementations.
57: *
58: * @author Anthony Eden
59: */
60: public interface XmlRpcClientProvider {
61: /**
62: * Get an XmlRpcClient instance. This method may return null if a connection
63: * cannot be established. Reasons for not being able to establish a connection
64: * include network failures, down servers, or a decision by a user to not open
65: * a connection.
66: *
67: * @return An XmlRpcClient object or null if a connection is not established
68: */
69: XmlRpcClient getClient();
70:
71: /** Disconnect. */
72: void disconnect();
73: }
|