/**
* Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. Apereo
* 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 the
* following location:
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>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.apereo.portal.utils;
import java.sql.Connection;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apereo.portal.jdbc.RDBMServices;
/**
* This type is a place to centralize the portal's sql transaction code.
*/
public class SqlTransaction {
private static final Log log = LogFactory.getLog(SqlTransaction.class);
/** SqlTransaction constructor comment. */
public SqlTransaction() {
super();
}
/**
* @param conn java.sql.Connection
* @exception java.sql.SQLException
*/
public static void begin(Connection conn) throws java.sql.SQLException {
/*
* Previously this method was invoked in a try-catch SQLException block.
* Prior to 2.5.1, RDBMS.setAutoCommit didn't actually throw SQLException, and
* as of 2.5.1 its method declaration was corrected to reflect this.
*/
RDBMServices.setAutoCommit(conn, false);
}
/**
* @param conn java.sql.Connection
* @exception java.sql.SQLException
*/
public static void commit(Connection conn) throws java.sql.SQLException {
/*
* Previously this method was invoked in a try-catch SQLException block.
* Prior to 2.5.1, RDBMS.commit() and RDBMS.setAutoCommit didn't actually
* throw SQLException, and as of 2.5.1 its method declaration was corrected
* to reflect this.
*/
RDBMServices.commit(conn);
RDBMServices.setAutoCommit(conn, true);
}
protected static void logNoTransactionWarning() {
String msg =
"You are running the portal on a database that does not support transactions. "
+ "This is not a supported production environment for uPortal. "
+ "Sooner or later, your database will become corrupt.";
log.warn(msg);
}
/**
* @param conn java.sql.Connection
* @exception java.sql.SQLException
*/
public static void rollback(Connection conn) throws java.sql.SQLException {
RDBMServices.rollback(conn);
RDBMServices.setAutoCommit(conn, true);
}
/**
* @param conn java.sql.Connection
* @param newValue boolean
* @exception java.sql.SQLException
*/
public static void setAutoCommit(Connection conn, boolean newValue)
throws java.sql.SQLException {
/*
* Previously this method was invoked in a try-catch SQLException block.
* Prior to 2.5.1, RDBMS.setAutocommit() didn't actually
* throw SQLException, and as of 2.5.1 its method declaration was corrected
* to reflect this.
*/
RDBMServices.setAutoCommit(conn, newValue);
}
}