KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > trove > util > tq > TransactionQueueEvent


1 /* ====================================================================
2  * Trove - Copyright (c) 1997-2000 Walt Disney Internet Group
3  * ====================================================================
4  * The Tea Software License, Version 1.1
5  *
6  * Copyright (c) 2000 Walt Disney Internet Group. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Walt Disney Internet Group (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove" and "BeanDoc" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@dig.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle" or "Trove", nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or "BeanDoc" appear in their name, without prior
35  * written permission of the Walt Disney Internet Group.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE WALT DISNEY INTERNET GROUP OR ITS
41  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
43  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
44  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
45  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
47  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */

52
53 package com.go.trove.util.tq;
54
55 import java.util.EventObject JavaDoc;
56 import java.util.Date JavaDoc;
57
58 /******************************************************************************
59  * An event that contains information from a {@link TransactionQueue}.
60  * TransactionQueueEvents can be received by implementing a
61  * {@link TransactionQueueListener}.
62  *
63  * @author Brian S O'Neill
64  * @version
65  * <!--$$Revision:--> 11 <!-- $-->, <!--$$JustDate:--> 9/25/00 <!-- $-->
66  */

67 public class TransactionQueueEvent extends EventObject JavaDoc {
68     private Transaction mTransaction;
69     private Throwable JavaDoc mThrowable;
70     private long mTimestampMillis;
71     private long mStageDuration;
72
73     private transient Date JavaDoc mTimestamp;
74
75     public TransactionQueueEvent(TransactionQueue source,
76                                  Transaction transaction) {
77         super(source);
78         mTransaction = transaction;
79         mTimestampMillis = System.currentTimeMillis();
80     }
81
82     public TransactionQueueEvent(TransactionQueue source,
83                                  Transaction transaction,
84                                  Throwable JavaDoc throwable) {
85         super(source);
86         mTransaction = transaction;
87         mThrowable = throwable;
88         mTimestampMillis = System.currentTimeMillis();
89     }
90
91     /**
92      * Copies the given event, but gives it a new timestamp and computes a
93      * stage duration.
94      */

95     public TransactionQueueEvent(TransactionQueueEvent event) {
96         super(event.getSource());
97         mTransaction = event.mTransaction;
98         mThrowable = event.mThrowable;
99         mStageDuration = (mTimestampMillis = System.currentTimeMillis()) -
100             event.mTimestampMillis;
101     }
102
103     /**
104      * Copies the given event, but gives it a different throwable, a new
105      * timestamp and computes a stage duration.
106      */

107     public TransactionQueueEvent(TransactionQueueEvent event,
108                                  Throwable JavaDoc throwable) {
109         super(event.getSource());
110         mTransaction = event.mTransaction;
111         mThrowable = throwable;
112         mStageDuration = (mTimestampMillis = System.currentTimeMillis()) -
113             event.mTimestampMillis;
114     }
115
116     public TransactionQueue getTransactionQueue() {
117         return (TransactionQueue)getSource();
118     }
119
120     /**
121      * Returns the date and time of this event.
122      */

123     public Date JavaDoc getTimestamp() {
124         if (mTimestamp == null) {
125             mTimestamp = new Date JavaDoc(mTimestampMillis);
126         }
127         return mTimestamp;
128     }
129
130     /**
131      * Returns the date and time of this event as milliseconds since 1970.
132      */

133     public long getTimestampMillis() {
134         return mTimestampMillis;
135     }
136
137     /**
138      * Returns the amount of time, in milliseconds, that the transaction was
139      * in a TransactionQueue stage. The implied meaning of this value depends
140      * on how this event was passed to a listener.
141      *
142      * @see TransactionQueueListener
143      */

144     public long getStageDuration() {
145         return mStageDuration;
146     }
147
148     /**
149      * Returns the transaction that was being processed by the
150      * TransactionQueue.
151      */

152     public Transaction getTransaction() {
153         return mTransaction;
154     }
155
156     /**
157      * Returns the exception that occurred while servicing the transaction, if
158      * applicable.
159      */

160     public Throwable JavaDoc getThrowable() {
161         return mThrowable;
162     }
163 }
164
Popular Tags