KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mule > umo > provider > UMOConnectable


1 /*
2  * $Id: UMOConnectable.java 3798 2006-11-04 04:07:14Z aperepel $
3  * --------------------------------------------------------------------------------------
4  * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
5  *
6  * The software in this package is published under the terms of the MuleSource MPL
7  * license, a copy of which has been included with this distribution in the
8  * LICENSE.txt file.
9  */

10
11 package org.mule.umo.provider;
12
13 /**
14  * Interface for objects that should connect to a resource.
15  *
16  * @author <a HREF="mailto:gnt@codehaus.org">Guillaume Nodet</a>
17  * @version $Revision: 3798 $
18  */

19 public interface UMOConnectable
20 {
21
22     /**
23      * Make the connection to the underlying transport. The fact that this object is
24      * connected or not should have no influence on the lifecycle, especially the
25      * start / stop state if applicable.
26      *
27      * @throws Exception
28      */

29     void connect() throws Exception JavaDoc;
30
31     /**
32      * Disconnect the from the underlying transport
33      *
34      * @throws Exception
35      */

36     void disconnect() throws Exception JavaDoc;
37
38     /**
39      * Determines if this object is connected or not
40      *
41      * @return
42      */

43     boolean isConnected();
44
45     /**
46      * Returns a string identifying the underlying resource
47      *
48      * @return
49      */

50     String JavaDoc getConnectionDescription();
51 }
52
Popular Tags