001: /*
002: License $Id: JoRemoteSession.java,v 1.5 2005/03/15 20:09:44 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.jobalancer;
103:
104: import com.tagtraum.framework.util.SerializableHashMap;
105:
106: import javax.servlet.http.HttpSessionBindingEvent;
107: import javax.servlet.http.HttpSessionBindingListener;
108: import java.io.Serializable;
109: import java.rmi.RemoteException;
110: import java.rmi.server.UnicastRemoteObject;
111: import java.util.Enumeration;
112: import java.util.Iterator;
113: import java.util.Vector;
114:
115: /**
116: * Realizes a remote session object that can be wrapped by a {@link JoRemoteSessionWrapper}.
117: *
118: * TODO: Translate all comments to English.
119: *
120: * @author Hendrik Schreiber
121: * @version 1.1beta1 $Id: JoRemoteSession.java,v 1.5 2005/03/15 20:09:44 hendriks73 Exp $
122: */
123: public class JoRemoteSession extends UnicastRemoteObject implements
124: I_JoRemoteSession, Serializable {
125:
126: /**
127: * Source-Version
128: */
129: public static String vcid = "$Id: JoRemoteSession.java,v 1.5 2005/03/15 20:09:44 hendriks73 Exp $";
130:
131: /**
132: * Gültigkeitsflag
133: */
134: protected boolean valid = true;
135:
136: /**
137: * Identifier
138: */
139: protected String myID;
140:
141: /**
142: * Zeigt an, ob die ID bereits gesetzt worden ist.
143: */
144: private boolean myIDSet;
145:
146: /**
147: * SessionContext, zu dem diese Session gehört.
148: */
149: protected transient I_JoRemoteSessionContext mySessionContext;
150:
151: /**
152: * Zeit der Erstellung
153: */
154: protected long myCreationTime;
155:
156: /**
157: * Letzter Zugriff auf diese Session
158: */
159: protected long myLastAccess;
160:
161: /**
162: * Aktueller Zugriff auf diese Session
163: */
164: protected long myPostLastAccess;
165:
166: /**
167: * Values of this session
168: */
169: protected SerializableHashMap myValues = new SerializableHashMap();
170:
171: /**
172: * Maximale Zeit, die diese Session ohne einen Request überlebt.
173: */
174: protected int myMaxInactiveInterval;
175:
176: /**
177: * Initialisiert diese Session.
178: */
179: public JoRemoteSession() throws RemoteException {
180: super ();
181:
182: myCreationTime = System.currentTimeMillis();
183: myLastAccess = -1;
184: myPostLastAccess = myCreationTime;
185: myIDSet = false;
186: }
187:
188: /**
189: * Setzt den Indentifikationsstring dieser Session.
190: *
191: * @exception IllegalStateException falls die SessionID bereits gesetzt worden ist.
192: */
193: public void setId(String anID) throws RemoteException {
194: if (myIDSet) {
195: throw new IllegalStateException("ID has already been set.");
196: }
197:
198: myID = anID;
199:
200: mySessionContext.addSession(this );
201: setMaxInactiveInterval(mySessionContext
202: .getDefaultMaxInactiveInterval());
203: }
204:
205: /**
206: * Sets the sessioncontext of this session.
207: *
208: * @param aContext zugehöriger SessionContext
209: * @exception IllegalStateException falls der SessionContext bereits gesetzt worden ist.
210: */
211: public void setSessionContext(I_JoRemoteSessionContext aContext) {
212: mySessionContext = aContext;
213: }
214:
215: /**
216: * Gibt den Indentifikationsstring dieser Session zurück.
217: *
218: * @exception IllegalStateException falls die Session bereits ungültig ist.
219: * @return SessionID
220: */
221: public String getId() throws RemoteException {
222: checkValidity();
223:
224: return myID;
225: }
226:
227: /**
228: * Gibt die Zeit zurück, zu der diese Session erzeugt wurde.
229: *
230: * @exception IllegalStateException falls die Session bereits ungültig ist.
231: * @return Zeit in ms seit 1.1.1970 UTC
232: */
233: public long getCreationTime() throws RemoteException {
234: checkValidity();
235:
236: return myCreationTime;
237: }
238:
239: /**
240: * Gibt die Zeit zurück, zu der diese Session das letzte mal
241: * benutzt wurde.
242: *
243: * @exception IllegalStateException falls die Session bereits ungültig ist.
244: * @return Zeit in ms seit 1.1.1970 UTC
245: */
246: public long getLastAccessedTime() throws RemoteException {
247: return myLastAccess;
248: }
249:
250: /**
251: * Markiert den Zeitpunkt der letzten Nutzung.
252: */
253: public void markAccessed() {
254: myLastAccess = myPostLastAccess;
255: myPostLastAccess = System.currentTimeMillis();
256: }
257:
258: /**
259: * Erkl�rt diese Session für ungültig.
260: *
261: * @exception IllegalStateException falls die Session bereits ungültig ist.
262: */
263: public synchronized void invalidate() throws RemoteException {
264: checkValidity();
265:
266: Iterator i = myValues.keySet().iterator();
267:
268: while (i.hasNext()) {
269: removeAttribute((String) i.next());
270:
271: i = myValues.keySet().iterator();
272: }
273:
274: valid = false;
275:
276: mySessionContext.removeSession(myID);
277: }
278:
279: /**
280: * Hinterlegt ein Objekt unter einem Schlüssel in dieser Session.
281: *
282: * @exception IllegalStateException falls die Session bereits ungültig ist.
283: * @param name Schl�ssel
284: * @param name Objekt
285: */
286: public synchronized void setAttribute(String name, Object value)
287: throws RemoteException {
288: checkValidity();
289: myValues.put(name, value);
290: }
291:
292: /**
293: * Gibt ein in dieser Session hinterlegtes Objekt zurück.
294: *
295: * @exception IllegalStateException falls die Session bereits ungültig ist.
296: * @param name Schlüssel
297: * @return Objekt
298: */
299: public synchronized Object getAttribute(String name)
300: throws RemoteException {
301: checkValidity();
302:
303: return myValues.get(name);
304: }
305:
306: /**
307: * Entfernt ein in dieser Session hinterlegtes Objekt zurück.
308: *
309: * @exception IllegalStateException falls die Session bereits ungültig ist.
310: * @param name Schlüssel
311: */
312: public synchronized void removeAttribute(String name)
313: throws RemoteException {
314: checkValidity();
315:
316: Object value = myValues.remove(name);
317:
318: if (value != null) {
319: if (value instanceof HttpSessionBindingListener) {
320: // the null in the event should be this, but that's a problem (rik)
321: ((HttpSessionBindingListener) value)
322: .valueUnbound(new HttpSessionBindingEvent(null,
323: name));
324: }
325: }
326: }
327:
328: /**
329: * Gibt eine Enumeration mit allen Schlüsseln zurück, unter
330: * denen ein Objekt an diese Session gebunden wurde.
331: *
332: * @return Enumeration mit allen Schlüsseln.
333: */
334: public synchronized Enumeration getAttributeNames()
335: throws RemoteException {
336: checkValidity();
337:
338: Vector v = new Vector(myValues.keySet());
339:
340: return v.elements();
341: }
342:
343: /**
344: * Gibt einen Array mit allen Schl�sseln zurück, unter
345: * denen ein Objekt an diese Session gebunden wurde.
346: *
347: * @return Array mit allen Schlüsseln.
348: */
349: public synchronized String[] getValueNames() throws RemoteException {
350: checkValidity();
351:
352: String[] s = new String[myValues.size()];
353:
354: return (String[]) myValues.keySet().toArray(s);
355: }
356:
357: /**
358: * Gibt an, ob eine Session <i>neu</i> ist. Die genaue Definition
359: * von <i>neu</i> ist der Servlet-API-Spezifikation zu entnehmen.
360: *
361: * @return <code>true</code> oder <code>false</code>
362: */
363: public boolean isNew() throws RemoteException {
364: return myLastAccess == -1;
365: }
366:
367: /**
368: * Gibt die maximale Zeit, die eine Session inaktiv existieren kann,
369: * in Sekunden zurück.
370: *
371: * @return Zeit in Sekunden.
372: */
373: public int getMaxInactiveInterval() throws RemoteException {
374: checkValidity();
375:
376: return myMaxInactiveInterval;
377: }
378:
379: /**
380: * Setzt die maximale Zeit, die eine Session inaktiv existieren kann.
381: *
382: * @param interval Zeit in Sekunden.
383: */
384: public void setMaxInactiveInterval(int interval)
385: throws RemoteException {
386: myMaxInactiveInterval = interval;
387: }
388:
389: /**
390: * �berpr�ft, ob die Session noch gültig ist.
391: *
392: * @exception IllegalStateException falls die Session nicht mehr gültig ist.
393: */
394: protected void checkValidity() throws IllegalStateException {
395: if (!valid) {
396: throw new IllegalStateException("Session is not valid.");
397: }
398: }
399:
400: /**
401: * Indicates whether this session is still valid.
402: */
403: public boolean isValid() throws RemoteException {
404: return valid;
405: }
406:
407: /*
408: * private synchronized void writeObject(java.io.ObjectOutputStream s) throws IOException
409: * {
410: * String logname = sessionContext.getServletContextPeer().getHost().getName();
411: * try {
412: * s.defaultWriteObject();
413: * }
414: * catch (NotSerializableException nse) {
415: * Log.getLog(logname).log("Failed to serialize session " + id + ": " + nse.toString());
416: * }
417: * if (Log.isLog(logname)) {
418: * Enumeration e = values.getWarnings();
419: * while (e.hasMoreElements()) {
420: * Log.getLog(logname).log("Session " + id + ": " + (String)e.nextElement());
421: * }
422: * }
423: * }
424: *
425: * private synchronized void readObject(java.io.ObjectInputStream s) throws IOException, ClassNotFoundException, NotActiveException
426: * {
427: * s.defaultReadObject();
428: * }
429: *
430: */
431: }
|