KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > TransactionDelegate


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
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 OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.access;
57
58 import java.sql.Connection JavaDoc;
59
60 /**
61  * Defines callback methods for customizing Cayenne transaction behavior.
62  *
63  * @author Andrei Adamchik
64  * @since 1.1
65  */
66 public interface TransactionDelegate {
67
68     /**
69      * Called within a context of Transaction before transaction is committed.
70      * Delegate can do its own processing, and optionally suppress further
71      * commit processing by Cayenne by returning <code>false</code>.
72      */
73     public boolean willCommit(Transaction transaction);
74
75     /**
76      * Called within a context of Transaction before transaction is marked as
77      * "rollback only" (meaning that further commit is impossible).
78      * Delegate can do its own processing, and optionally suppress further
79      * status processing by Cayenne by returning <code>false</code>.
80      */
81     public boolean willMarkAsRollbackOnly(Transaction transaction);
82
83     /**
84      * Called within a context of Transaction before transaction is rolledback.
85      * Delegate can do its own processing, and optionally suppress further
86      * rolledback processing by Cayenne by returning <code>false</code>.
87      */
88     public boolean willRollback(Transaction transaction);
89
90     /**
91      * Called within a context of a Transaction to notify delegate about a successful
92      * transaction commit.
93      */
94     public void didCommit(Transaction transaction);
95
96     /**
97      *
98      */
99     public void didRollback(Transaction transaction);
100
101     /**
102      * Called within a context of Transaction when a new Connection is added
103      * to the list of Connections participating in transaction.
104      * Delegate can do its own processing, and optionally suppress further
105      * Connection registration inside Transaction by returning <code>false</code>.
106      */
107     public boolean willAddConnection(Transaction transaction, Connection JavaDoc connection);
108 }
109
Popular Tags