01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: 57198 $
34: */
35: public interface ServerILFactory {
36:
37: /**
38: * Constant used to identify the property that holds the ServerILFactor
39: * class name
40: */
41: public final static String SERVER_IL_FACTORY_KEY = "ServerILFactory";
42:
43: /**
44: * Constant used to identify the property that holds the ClientILService
45: * class name
46: */
47: public final static String CLIENT_IL_SERVICE_KEY = "ClientILService";
48:
49: /**
50: * Constant used to identify the property that holds time period between
51: * server pings.
52: */
53: public final static String PING_PERIOD_KEY = "PingPeriod";
54:
55: /**
56: * Constant used to identify the property that holds the client id
57: */
58: public final static String CLIENTID = "ClientID";
59:
60: // init is called before any calls are made to getServerIL()
61: public void init(Properties props) throws Exception;
62:
63: // must return a instance of ServerIL or else throw an Exception.
64: public ServerIL getServerIL() throws Exception;
65: }
|