View Javadoc

1   /***
2    * Redistribution and use of this software and associated documentation
3    * ("Software"), with or without modification, are permitted provided
4    * that the following conditions are met:
5    *
6    * 1. Redistributions of source code must retain copyright
7    *    statements and notices.  Redistributions must also contain a
8    *    copy of this document.
9    *
10   * 2. Redistributions in binary form must reproduce the
11   *    above copyright notice, this list of conditions and the
12   *    following disclaimer in the documentation and/or other
13   *    materials provided with the distribution.
14   *
15   * 3. The name "Exolab" must not be used to endorse or promote
16   *    products derived from this Software without prior written
17   *    permission of Exoffice Technologies.  For written permission,
18   *    please contact info@exolab.org.
19   *
20   * 4. Products derived from this Software may not be called "Exolab"
21   *    nor may "Exolab" appear in their names without prior written
22   *    permission of Exoffice Technologies. Exolab is a registered
23   *    trademark of Exoffice Technologies.
24   *
25   * 5. Due credit should be given to the Exolab Project
26   *    (http://www.exolab.org/).
27   *
28   * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29   * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
32   * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39   * OF THE POSSIBILITY OF SUCH DAMAGE.
40   *
41   * Copyright 2002-2003 (C) Exoffice Technologies Inc. All Rights Reserved.
42   *
43   *
44   * $Id: StateTransactionLogEntry.java,v 1.1 2004/11/26 01:51:01 tanderson Exp $
45   *
46   * Date			Author  Changes
47   * 20/11/2001   jima    Created
48   */
49  package org.exolab.jms.tranlog;
50  
51  
52  import java.io.Externalizable;
53  import java.io.IOException;
54  import java.io.ObjectInput;
55  import java.io.ObjectOutput;
56  
57  
58  public class StateTransactionLogEntry
59      extends BaseTransactionLogEntry
60      implements Externalizable {
61  
62      /***
63       * This is the unique id used to identify the version of the class
64       * for the purpose of Serialization
65       */
66      static final long serialVersionUID = 1;
67  
68      /***
69       * State of the tranaction, which is identified in the base class
70       */
71      private TransactionState _state;
72  
73  
74      /***
75       * Default constuctor for serialization
76       */
77      public StateTransactionLogEntry() {
78      }
79  
80      /***
81       * Create an instance of this object for the specified transaction
82       * identifier and resource identifier.
83       * <p>
84       * Mark as the transaction being created now
85       *
86       * @param txid - transaction identifier
87       * @param rid - resource identifier
88       */
89      StateTransactionLogEntry(ExternalXid txid, String rid) {
90          this(txid, rid, System.currentTimeMillis());
91      }
92  
93      /***
94       * Create an instance of this object for the specified transaction
95       * identifier and resource identifier
96       * <p>
97       * Mark the transaction as being created at the specified time
98       *
99       * @param txid - the transaction identifier
100      * @param rid - the resource identifier
101      * @param created - a timestamp for this transaction
102      */
103     StateTransactionLogEntry(ExternalXid txid, String rid, long created) {
104         super(txid, rid, created);
105     }
106 
107     /***
108      * Set the transaction state
109      *
110      * @param state
111      */
112     public void setState(TransactionState state) {
113         _state = state;
114     }
115 
116     /***
117      * Get the transaction state
118      *
119      * @return TransactionState
120      */
121     public TransactionState getState() {
122         return _state;
123     }
124 
125     // implementation of Externalizable.writeExternal
126     public void writeExternal(ObjectOutput stream)
127         throws IOException {
128         stream.writeLong(serialVersionUID);
129         stream.writeObject(_state);
130         super.writeExternal(stream);
131     }
132 
133     // implementation of Externalizable.writeExternal
134     public void readExternal(ObjectInput stream)
135         throws IOException, ClassNotFoundException {
136         long version = stream.readLong();
137         if (version == serialVersionUID) {
138             _state = (TransactionState) stream.readObject();
139             super.readExternal(stream);
140         } else {
141             throw new IOException("No support for StateTransactionLogEntry " +
142                 "with version " + version);
143         }
144     }
145 }