1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 William Chesters
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * William Chesters <williamc At paneris.org>
42 * http://paneris.org/~williamc
43 * Obrechtstraat 114, 2517VX Den Haag, The Netherlands
44 */
45
46 package org.melati.poem;
47
48 import org.melati.poem.transaction.ToTidyList;
49
50 /**
51 * A Session Token.
52 *
53 * A Session has an AccessToken, a Time started, a Task,
54 * a Transaction within which the task is running and a Thread which runs the task.
55 */
56 public class SessionToken {
57 Thread thread;
58 long started;
59 PoemTransaction transaction;
60 PoemTask task;
61 AccessToken accessToken;
62 private ToTidyList toTidy = null;
63
64 /**
65 * @param thread
66 * @param transaction
67 * @param accessToken
68 * @param task
69 */
70 SessionToken(Thread thread, PoemTransaction transaction,
71 AccessToken accessToken, PoemTask task) {
72 this.thread = thread;
73 this.started = System.currentTimeMillis();
74 this.transaction = transaction;
75 this.task = task;
76 this.accessToken = accessToken;
77 }
78
79 /**
80 * Close this session and its toTidy list.
81 */
82 void close() {
83 thread = null;
84 started = 0L;
85 transaction = null;
86 task = null;
87 accessToken = null;
88 if (toTidy != null)
89 toTidy.close();
90 }
91
92 /**
93 * @return the list of objects to close when we close
94 */
95 public synchronized ToTidyList toTidy() {
96 if (toTidy == null)
97 toTidy = new ToTidyList();
98 return toTidy;
99 }
100
101 /**
102 * @return Returns the time, as a long, started.
103 */
104 public long getStarted() {
105 return started;
106 }
107
108 /**
109 * @return Returns the task.
110 */
111 public PoemTask getTask() {
112 return task;
113 }
114
115 /**
116 * @return Returns the thread.
117 */
118
119 public Thread getThread() {
120 return thread;
121 }
122
123 /**
124 * @return Returns the transaction.
125 */
126 public PoemTransaction getTransaction() {
127 return transaction;
128 }
129 }