001/* 002 * Copyright (c) 2009 The openGion Project. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 013 * either express or implied. See the License for the specific language 014 * governing permissions and limitations under the License. 015 */ 016package org.opengion.fukurou.db; 017 018import java.sql.Connection; 019 020/** 021 * コネクションを共有して、トランザクションを実現するインターフェースです。 022 * 023 * 基本的には、TransactionTag で利用されますが、一部、このオブジェクトを 024 * 渡して、直接、利用するケースもあります。 025 * 026 * トランザクション の実クラスには、リアルタイムで commit,rollback を行う、 027 * TransactionReal クラスと、内部にキャッシュされた コネクションを、終了時点で 028 * 一括処理を行う、TransactionImpl があります。 029 * TransactionTag で利用するのが、TransactionImpl で、トランザクション処理を行わない 030 * ケースで利用するのが、TransactionReal クラスになります。 031 * TransactionReal クラス は、トランザクション処理を「行わない」場合に、共通ロジックを 032 * 提供するために用意されたクラスです。 033 * 034 * @og.rev 5.1.9.0 (2010/08/01) 新規作成 035 * 036 * @version 5.0 037 * @author Kazuhiko Hasegawa 038 * @since JDK6.0, 039 */ 040public interface Transaction { 041 042 /** 043 * 指定のDBID に対応した、Connection オブジェクトを返します。 044 * 内部Mapに存在していれば、そのコネクションを、存在しなければ、 045 * 新しく作成します。 046 * 047 * @param dbid 接続先ID 048 * 049 * @return 指定のDBID に対応した、コネクションオブジェクト 050 */ 051 Connection getConnection( final String dbid ) ; 052 053 /** 054 * コミット処理が行われた場合に、内部フラグ(isCommit)を true にセットします。 055 * 1回でもコミットが行われており、ロールバックが行われていなければ、 056 * コミットされます。 057 * 058 * 検索処理のみで、エラーが発生していない場合は、コミットも行われないケースがあります。 059 * 060 * @return 正常:true/異常:false 061 */ 062 boolean commit() ; 063 064 /** 065 * ロールバック処理が行われた場合に、内部フラグ(isRollback)を true にセットします。 066 * 1回でもロールバックが行われていれば、最終的にはロールバックされます。 067 * 068 * @return 正常:true/異常:false 069 */ 070 boolean rollback() ; 071 072 /** 073 * トランザクションの、終了時処理を行います。 074 * 075 * それまでの処理は、すべて正常に処理できた場合に、使用します。 076 * close( false ) と同じです。 077 * 078 * @see #close( boolean ) 079 * 080 * @return 正常:true/異常:false 081 */ 082 boolean close() ; 083 084 /** 085 * トランザクションの、終了時処理を行います。 086 * 087 * 引数は、正常かどうかを判定するフラグです。異常の場合は、true をセットします。 088 * ここでは、実際には何もしませんが、内部的にエラーフラグをセットします。 089 * (エラーの場合のみセット。リセットはされません) 090 * 一度でも、エラーが発生したコネクションは、破棄します。それ以外は、プールに戻します。 091 * 092 * @param errFlag エラー状態 [true:/false:通常] 093 * 094 * @return 正常:true/異常:false 095 */ 096 boolean close( final boolean errFlag ) ; 097}