001: /*
002: License $Id: Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $
003:
004: Copyright (c) 2001-2005 tagtraum industries.
005:
006: LGPL
007: ====
008:
009: jo! is free software; you can redistribute it and/or
010: modify it under the terms of the GNU Lesser General Public
011: License as published by the Free Software Foundation; either
012: version 2.1 of the License, or (at your option) any later version.
013:
014: jo! is distributed in the hope that it will be useful,
015: but WITHOUT ANY WARRANTY; without even the implied warranty of
016: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: Lesser General Public License for more details.
018:
019: You should have received a copy of the GNU Lesser General Public
020: License along with this library; if not, write to the Free Software
021: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022:
023: For LGPL see <http://www.fsf.org/copyleft/lesser.txt>
024:
025:
026: Sun license
027: ===========
028:
029: This release contains software by Sun Microsystems. Therefore
030: the following conditions have to be met, too. They apply to the
031: files
032:
033: - lib/mail.jar
034: - lib/activation.jar
035: - lib/jsse.jar
036: - lib/jcert.jar
037: - lib/jaxp.jar
038: - lib/crimson.jar
039: - lib/servlet.jar
040: - lib/jnet.jar
041: - lib/jaas.jar
042: - lib/jaasmod.jar
043:
044: contained in this release.
045:
046: a. Licensee may not modify the Java Platform
047: Interface (JPI, identified as classes contained within the javax
048: package or any subpackages of the javax package), by creating additional
049: classes within the JPI or otherwise causing the addition to or modification
050: of the classes in the JPI. In the event that Licensee creates any
051: Java-related API and distribute such API to others for applet or
052: application development, you must promptly publish broadly, an accurate
053: specification for such API for free use by all developers of Java-based
054: software.
055:
056: b. Software is confidential copyrighted information of Sun and
057: title to all copies is retained by Sun and/or its licensors. Licensee
058: shall not modify, decompile, disassemble, decrypt, extract, or otherwise
059: reverse engineer Software. Software may not be leased, assigned, or
060: sublicensed, in whole or in part. Software is not designed or intended
061: for use in on-line control of aircraft, air traffic, aircraft navigation
062: or aircraft communications; or in the design, construction, operation or
063: maintenance of any nuclear facility. Licensee warrants that it will not
064: use or redistribute the Software for such purposes.
065:
066: c. Software is provided "AS IS," without a warranty
067: of any kind. ALL EXPRESS OR IMPLIED REPRESENTATIONS AND WARRANTIES,
068: INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
069: PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED.
070:
071: d. This License is effective until terminated. Licensee may
072: terminate this License at any time by destroying all copies of Software.
073: This License will terminate immediately without notice from Sun if Licensee
074: fails to comply with any provision of this License. Upon such termination,
075: Licensee must destroy all copies of Software.
076:
077: e. Software, including technical data, is subject to U.S.
078: export control laws, including the U.S. Export Administration Act and its
079: associated regulations, and may be subject to export or import regulations
080: in other countries. Licensee agrees to comply strictly with all such
081: regulations and acknowledges that it has the responsibility to obtain
082: licenses to export, re-export, or import Software. Software may not be
083: downloaded, or otherwise exported or re-exported (i) into, or to a national
084: or resident of, Cuba, Iraq, Iran, North Korea, Libya, Sudan, Syria or any
085: country to which the U.S. has embargoed goods; or (ii) to anyone on the
086: U.S. Treasury Department's list of Specially Designated Nations or the U.S.
087: Commerce Department's Table of Denial Orders.
088:
089:
090: Feedback
091: ========
092:
093: We encourage your feedback and suggestions and want to use your feedback to
094: improve the Software. Send all such feedback to:
095: <feedback@tagtraum.com>
096:
097: For more information on tagtraum industries and jo!
098: please see <http://www.tagtraum.com/>.
099:
100:
101: */
102: package com.tagtraum.framework.server;
103:
104: import com.tagtraum.framework.log.C_Log;
105: import com.tagtraum.framework.log.Log;
106:
107: import java.io.IOException;
108: import java.io.Serializable;
109: import java.net.InetAddress;
110:
111: /**
112: * The <code>Listener</code> encapsulates a communication endpoint
113: * of a {@link I_Service}. This means one {@link I_Service} can have
114: * many <code>Listener</code>s. This is necessary to listen to
115: * multiple ports.
116: *
117: * @author <a href="mailto:hs@tagtraum.com">Hendrik Schreiber</a>
118: * @version 1.1beta1 $Id: Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $
119: * @see I_Service
120: * @see I_Listener
121: */
122: public abstract class Listener implements I_Listener, Serializable,
123: Runnable {
124:
125: /**
126: * Source-Version.
127: */
128: public static String vcid = "$Id: Listener.java,v 1.4 2003/09/13 04:59:56 hendriks73 Exp $";
129:
130: /**
131: * Port.
132: */
133: protected int myPort = 0;
134:
135: /**
136: * InetAddresse the <code>Listener</code> shall be bound to.
137: */
138: protected InetAddress myBindAddress = null;
139:
140: /**
141: * Name.
142: */
143: protected String myName = new String();
144:
145: /**
146: * Thread.
147: */
148: protected transient Thread myThread;
149:
150: /**
151: * Flag that indicates whether the <code>Listener</code> thread shall be stopped.
152: */
153: transient protected boolean stopped = false;
154:
155: /**
156: * The {@link I_Service} of this <code>Listener</code>.
157: */
158: protected I_Service myService;
159:
160: /**
161: * Starts the listening loop.
162: *
163: * @exception ServerException if it is not possible to
164: * start this <code>Listener</code>
165: */
166: public synchronized void start() throws ServerException {
167: try {
168: bind();
169:
170: stopped = false;
171: myThread = new Thread(myService.getThreadGroup(), this ,
172: myService.getName() + "." + myName + ": "
173: + getBindAddress().toString());
174:
175: myThread.setDaemon(false);
176: myThread.start();
177:
178: if (Log.getLog(myService.getName()).isLog(C_Log.MODULE)) {
179: Log.getLog(myService.getName()).log(
180: "Listener '" + getName() + "' started.",
181: C_Log.MODULE);
182: }
183: } catch (Throwable t) {
184: stopped = true;
185:
186: if (t instanceof ServerException) {
187: throw (ServerException) t;
188: } else {
189: throw new ServerException("Failed to start listener '"
190: + getName() + "' (" + getBindAddress() + ":"
191: + getPort() + ").", t);
192: }
193: }
194: }
195:
196: /**
197: * Stops the listening loop.
198: *
199: * @exception ServerException if it is not possible to
200: * stop this <code>Listener</code>
201: */
202: public synchronized void stop() throws ServerException {
203: if (Log.getLog(myService.getName()).isLog(C_Log.METHOD)) {
204: Log.getLog(myService.getName()).log(
205: "Trying to stop listener '" + getName() + "' for "
206: + getBindAddress() + ":" + getPort() + ".",
207: C_Log.METHOD);
208: }
209:
210: stopped = true;
211:
212: try {
213: close();
214: } catch (IOException ioe) {
215: throw new ServerException(ioe);
216: } finally {
217: myThread = null;
218: }
219:
220: if (Log.getLog(myService.getName()).isLog(C_Log.MODULE)) {
221: Log.getLog(myService.getName()).log(
222: "Listener '" + getName() + "' stopped.",
223: C_Log.MODULE);
224: }
225: }
226:
227: /**
228: * Binds the <code>Listener</code> to specific <code>InetAddress</code>.
229: * This method should be called {@link #start()}.
230: */
231: protected abstract void bind() throws IOException, ServerException;
232:
233: /**
234: * Is called, when a <code>SO_TIMEOUT</code> happened.
235: * Calls {@link I_Service#handleSoTimeout}.
236: */
237: public void handleSoTimeout() {
238: myService.handleSoTimeout();
239: }
240:
241: /**
242: * Returns <code>SO_TIMEOUT</code> for the accepting socket. Actually
243: * the {@link I_Service}s <code>getSoTimeout()</code> method is called.
244: *
245: * @param aSoTimeout time in ms
246: */
247: public int getSoTimeout() {
248: return myService.getSoTimeout();
249: }
250:
251: /**
252: * Closes the socket of this <code>Listener</code>.
253: */
254: public abstract void close() throws IOException;
255:
256: /**
257: * Indicates whether this <code>Listener</code> is already bound
258: * to a port/address.
259: *
260: * @return <code>true</code> or <code>false</code>
261: */
262: public abstract boolean isBound();
263:
264: /**
265: * Listening-loop.
266: */
267: public abstract void run();
268:
269: /**
270: * Returns the used port.
271: *
272: * @return the used port
273: */
274: public int getPort() {
275: return myPort;
276: }
277:
278: /**
279: * Sets the port.
280: *
281: * @param port the port
282: */
283: public void setPort(int port) {
284: if (isBound()) {
285: throw new IllegalStateException(
286: "Can't set port while Listener is listening.");
287: }
288:
289: myPort = port;
290: }
291:
292: /**
293: * Returns the currently used <code>InetAddress</code>.
294: *
295: * @return the currently used <code>InetAddress</code>
296: */
297: public InetAddress getBindAddress() {
298: return myBindAddress;
299: }
300:
301: /**
302: * Sets the <code>InetAddress</code> to use at the next start.
303: *
304: * @param aBindAddress InetAddress the socket will be bound to
305: */
306: public void setBindAddress(InetAddress aBindAddress) {
307: if (isBound()) {
308: throw new IllegalStateException(
309: "Can't set bindaddress while Listener is listening.");
310: }
311:
312: myBindAddress = aBindAddress;
313: }
314:
315: /**
316: * Returns the service {@link I_Service}.
317: *
318: * @return service.
319: */
320: public I_Service getService() {
321: return myService;
322: }
323:
324: /**
325: * Sets the {@link I_Service}.
326: *
327: * @param aService service.
328: */
329: public void setService(I_Service aService) {
330: myService = aService;
331: }
332:
333: /**
334: * Returns the name of this <code>Listener</code>.
335: *
336: * @return name of this <code>Listener</code>
337: */
338: public String getName() {
339: return myName;
340: }
341:
342: /**
343: * Sets the name of this <code>Listener</code>.
344: *
345: * @param name name of this <code>Listener</code>
346: */
347: public void setName(String aName) {
348: myName = aName;
349: }
350:
351: /**
352: * Returns a string representation.
353: */
354: public String toString() {
355: return getName() + ", " + getBindAddress() + ":" + getPort();
356: }
357:
358: }
|