KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > scalagent > kjoram > ConnectionItf


1 /*
2  * JORAM: Java(TM) Open Reliable Asynchronous Messaging
3  * Copyright (C) 2001 - ScalAgent Distributed Technologies
4  * Copyright (C) 1996 - Dyade
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA.
20  *
21  * Initial developer(s): Frederic Maistre (INRIA)
22  * Contributor(s): Nicolas Tachker (ScalAgent)
23  */
24 package com.scalagent.kjoram;
25
26
27 /**
28  * The <code>ConnectionItf</code> interface defines the methods provided to
29  * <code>Connection</code> objects for actually exchanging requests and
30  * replies with the Joram platform.
31  * <p>
32  * This interface is implemented by classes dedicated to a given communication
33  * protocol (as TCP or SOAP).
34  *
35  */
36 public interface ConnectionItf
37 {
38   /**
39    * Creates a driver for providing the connection with server's replies.
40    *
41    * @param cnx The calling <code>Connection</code> instance.
42    */
43   public Driver createDriver(Connection cnx);
44
45   /**
46    * Sends a JMS request to the server.
47    *
48    * @exception IllegalStateException If the connection failed to
49    * route the sending because it is broken or not established.
50    */
51   public void send(com.scalagent.kjoram.jms.AbstractJmsRequest request)
52               throws com.scalagent.kjoram.excepts.IllegalStateException;
53
54   public String JavaDoc getUserName();
55
56   /** Closes the connection. */
57   public void close();
58 }
59
Popular Tags