KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > mq > il > ClientILService


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.mq.il;
23
24 import org.jboss.mq.Connection;
25
26 /**
27  * This class manages the lifecycle of an instance of the ClientIL
28  * Implementations of this class should have a default constructor.
29  *
30  * @author Hiram Chirino (Cojonudo14@hotmail.com)
31  * @created August 16, 2001
32  * @version $Revision: 37459 $
33  */
34 public interface ClientILService {
35
36    /**
37     * After construction, the ClientILService is initialized with a reference
38     * to the Connection object and the connection properties.
39     *
40     * @param connection Description of Parameter
41     * @param props Description of Parameter
42     * @exception Exception Description of Exception
43     */
44    public void init( Connection connection, java.util.Properties JavaDoc props )
45       throws Exception JavaDoc;
46
47    /**
48     * After initialization, this method may be called to obtain a reference to
49     * a ClientIL object. This object will eventually be serialized and sent to
50     * the server so that he can invoke methods on connection it was initialized
51     * with.
52     *
53     * @return The ClientIL value
54     * @exception Exception Description of Exception
55     */
56    public ClientIL getClientIL()
57       throws Exception JavaDoc;
58
59
60    /**
61     * Once started, the ClientIL instance should process all server requests.
62     *
63     * @exception Exception Description of Exception
64     */
65    public void start()
66       throws Exception JavaDoc;
67
68    /**
69     * Once stopped, the ClientIL instance stop processing all server requests.
70     * if( cr_server != null ) cr_server.close(); if (cr!=null && cr instanceof
71     * java.rmi.Remote) { java.rmi.server.UnicastRemoteObject.unexportObject((java.rmi.Remote)cr,
72     * true); }
73     *
74     * @exception Exception Description of Exception
75     */
76
77    public void stop()
78       throws Exception JavaDoc;
79 }
80
Popular Tags