/*
 * Copyright (c) 2009 The openGion Project.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.opengion.fukurou.db;

import org.opengion.fukurou.util.Closer;
import org.opengion.fukurou.util.ApplicationInfo;

import java.sql.Connection;

/**
 * Transaction インターフェースを継承した、リアルタイムトランザクションクラスです。
 *
 * これは、通常のトランザクションクラスと異なり、トランザクション処理をしません。
 * つまり、トランザクション処理を行わないときに、メソッド等の共通的な使用ができるようにする、
 * Connection のラップクラスになります。
 * ただし、このクラスが生成されてから、クローズされるまでは、内部に保留した Connection は、
 * ずっと使い続けられますので、ConnectionFactory から取り出した Connection と同様に
 * トランザクション性は維持されます。
 * このクラスより作成された、Statement は、取り出し側で、きちんとクロース処理を
 *
 * このクラスでは、コミット、ロールバック、クローズ処理は、リアルタイムに行われます。
 *
 * @og.rev 5.1.9.0 (2010/08/01) 新規作成
 *
 * @version  5.0
 * @author	 Kazuhiko Hasegawa
 * @since    JDK6.0,
 */
public class TransactionReal implements Transaction {
	private final Connection conn ;
	private final String     dbid ;

	/**
	 * ApplicationInfo と、DBIDを指定して作成する、コンストラクター
	 *
	 * このクラスは、トランザクション処理をしない場合に、従来の Connection の
	 * 代わりに使用することを想定したクラスのオブジェクトを作成します。
	 *
	 * @param	dbid  String DBID
	 * @param	appInfo  ApplicationInfo 内部統制用のアクセス情報
	 */
	public TransactionReal( final String dbid , final ApplicationInfo appInfo ) {
		this.dbid = dbid;
		this.conn = ConnectionFactory.connection( dbid,appInfo );
	}

	/**
	 * 内部キャッシュされている、Connection オブジェクトを返します。
	 * 最初に呼ばれたときに、作成し、以降は、そのコネクションを返します。
	 *
	 * @param	dbid  String DBID (このクラスでは無視されます)
	 * @return	Connection 指定のDBID に対応した、Connection オブジェクト
	 */
	public Connection getConnection( final String dbid ) {
	//	if( ( dbid != null && ! dbid.equalsIgnoreCase( this.dbid )) ||
	//		( dbid == null && this.dbid != null ) ) {
	//		String errMsg = "内部コネクション構築時の DBIDと異なります。"
	//					+ "内部 dbid=[" + this.dbid + "], 引数 dbid=[" + dbid + "]" ;
	//		throw new RuntimeException( errMsg );
	//	}

		return conn ;
	}

	/**
	 * コミット処理を行います。
	 *
	 * これは、呼ばれる都度、リアルタイムに処理します。
	 *
	 * @return 正常:true/異常:false
	 */
	public boolean commit() {
		return Closer.commit( conn );
	}

	/**
	 * ロールバック処理を行います。
	 *
	 * これは、呼ばれる都度、リアルタイムに処理します。
	 *
	 * @return 正常:true/異常:false
	 */
	public boolean rollback() {
		return Closer.rollback( conn );
	}

	/**
	 * トランザクションの、終了時処理を行います。
	 *
	 * @see #close( boolean )
	 * @return 正常:true/異常:false
	 */
	public boolean close() {
		return close( false );
	}

	/**
	 * コネクションの、終了時処理を行います。
	 *
	 * 引数は、正常かどうかを判定するフラグです。異常の場合は、true をセットします。
	 * これは、ConnectionFactory のプールに戻すかどうかを判断するのに使われます。
	 * 一度でも、エラーが発生したコネクションは、破棄します。
	 * それ以外は、プールに戻します。
	 *
	 * @param	errFlag  boolean エラー状態(true)/通常(false)
	 * @return 正常:true/異常:false
	 */
	public boolean close( final boolean errFlag ) {
		if( errFlag ) { ConnectionFactory.remove( conn,dbid ); }	// 削除
		else {			ConnectionFactory.close( conn,dbid );  }	// 返却

		return true;
	}
}
