/*

   Derby - Class org.apache.derby.impl.store.access.RAMTransactionContext

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to you 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.apache.derby.impl.store.access;

import org.apache.derby.shared.common.error.ExceptionSeverity;
import org.apache.derby.shared.common.error.StandardException;

import org.apache.derby.iapi.services.context.ContextManager;
import org.apache.derby.iapi.services.context.ContextImpl;

import org.apache.derby.shared.common.sanity.SanityManager;

final class RAMTransactionContext extends ContextImpl
{
	/**
	The transaction this context is managing.
	**/
	private RAMTransaction transaction;

	/**
	   true if any exception causes this transaction to be destroyed
	**/
	private final boolean abortAll;

	/*
	** Context methods (most are implemented by super-class).
	*/

	/**
	Handle cleanup processing for this context. The resources
	associated with a transaction are the open controllers.
	Cleanup involves closing them at the appropriate time.
	Rollback of the underlying transaction is handled by the
	raw store.
	**/
	public void cleanupOnError(Throwable error)
        throws StandardException
	{
        if (SanityManager.DEBUG)
            SanityManager.ASSERT(getContextManager() != null);

		boolean destroy = false;

		if (abortAll == false && (error instanceof StandardException))
		{
			StandardException se = (StandardException) error;

			// If the severity is lower than a transaction error then do nothing.
			if (se.getSeverity() < ExceptionSeverity.TRANSACTION_SEVERITY)
				return;

			// If the session is going to disappear then we want to destroy this
			// transaction, not just abort it.
			if (se.getSeverity() >= ExceptionSeverity.SESSION_SEVERITY)
				destroy = true;
		}
		else
		{
			// abortAll is true or some java* error, throw away the
			// transaction. 
			destroy = true;
		}

        if (transaction != null)
        {
            try
            {
                transaction.invalidateConglomerateCache();
            }
            catch (StandardException se)
            {
                // RESOLVE - what to do in error case.
                if (SanityManager.DEBUG)
                    SanityManager.THROWASSERT(
                        "got error while invalidating cache.", se);
            }

            transaction.closeControllers(true /* close held controllers */ );
        }

        if (destroy)
        {
            transaction = null;
            popMe();
        }

	}

	/*
	** Methods of RAMTransactionContext
	*/

	// this constructor is called with the transaction
	// controller to be saved when the context
	// is created (when the first statement comes in, likely).
	RAMTransactionContext(
    ContextManager  cm,
    String          context_id,
    RAMTransaction  theTransaction, 
    boolean         abortAll)
		throws StandardException
	{
		super(cm, context_id);

		this.abortAll = abortAll;
		transaction = theTransaction;
		transaction.setContext(this);
	}

	/* package */ RAMTransaction getTransaction()
	{
		return transaction;
	}

	/* package */ void setTransaction(
    RAMTransaction  transaction)
	{
		this.transaction = transaction;
	}
}


