ServerILFactory


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 java.util.Properties  ;
25  
26  /**
27   * This interface is used to define a factory to produce ServerIL objects. This
28   * is used by the client in the GenericConnectionFactory class. Implementations
29   * should provide a default constructor.
30   * 
31   * @author Hiram Chirino (Cojonudo14@hotmail.com) 
32   * @author Adrian Brock (adrian@jboss.com)
33   * @version $Revision: 37459 $
34   */
35  public interface ServerILFactory
36  {
37  
38      /**
39       * Constant used to identify the property that holds the ServerILFactor
40       * class name
41       */
42      public final static String   SERVER_IL_FACTORY_KEY = "ServerILFactory";
43  
44      /**
45       * Constant used to identify the property that holds the ClientILService
46       * class name
47       */
48      public final static String   CLIENT_IL_SERVICE_KEY = "ClientILService";
49  
50      /**
51       * Constant used to identify the property that holds time period between
52       * server pings.
53       */
54      public final static String   PING_PERIOD_KEY = "PingPeriod";
55  
56      /**
57       * Constant used to identify the property that holds the client id
58       */
59      public final static String   CLIENTID = "ClientID";
60  
61      // init is called before any calls are made to getServerIL()
62      public void init(Properties   props) throws Exception  ;
63  
64      // must return a instance of ServerIL or else throw an Exception.
65      public ServerIL getServerIL() throws Exception  ;
66  }
67
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags