org.kawanfw.sql.servlet.connection.SavepointUtil Maven / Gradle / Ivy

Go to download
/*
 * This file is part of AceQL. 
 * AceQL: Remote JDBC access over HTTP.                                     
 * Copyright (C) 2015,  KawanSoft SAS
 * (http://www.kawansoft.com). All rights reserved.                                
 *                                                                               
 * AceQL is free software; you can redistribute it and/or                 
 * modify it under the terms of the GNU Lesser General Public                    
 * License as published by the Free Software Foundation; either                  
 * version 2.1 of the License, or (at your option) any later version.            
 *                                                                               
 * AceQL is distributed in the hope that it will be useful,               
 * but WITHOUT ANY WARRANTY; without even the implied warranty of                
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             
 * Lesser General Public License for more details.                               
 *                                                                               
 * You should have received a copy of the GNU Lesser General Public              
 * License along with this library; if not, write to the Free Software           
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  
 * 02110-1301  USA
 *
 * Any modifications to this file must keep this entire header
 * intact.
 */
package org.kawanfw.sql.servlet.connection;

import java.io.IOException;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Savepoint;
import java.util.logging.Level;

import javax.servlet.http.HttpServletRequest;

import org.kawanfw.commons.api.server.CommonsConfigurator;
import org.kawanfw.commons.server.util.ServerLogger;
import org.kawanfw.commons.util.FrameworkDebug;
import org.kawanfw.commons.util.HtmlConverter;
import org.kawanfw.commons.util.TransferStatus;
import org.kawanfw.file.util.parms.Parameter;
import org.kawanfw.sql.transport.SavepointHttp;
import org.kawanfw.sql.util.ConnectionParms;
import org.kawanfw.sql.util.SqlActionTransaction;
import org.kawanfw.sql.util.SqlReturnCode;

/**
 * @author Nicolas de Pomereu
 * 
 *         Wrapper for savepoint commands to decrease code in ServerSqlDispatch
 */
public class SavepointUtil {

    private static boolean DEBUG = FrameworkDebug.isSet(SavepointUtil.class);

    /**
     * Calls a setSavepoint(), setSavepoint(name), rollback(Savepoint
     * savepoint), releaseSavepoint(Savepoint savepoint)
     * 
     * @param request
     * @param commonsConfigurator
     * @param out
     * @param action
     * @throws IOException
     * @throws SQLException
     * @throws IllegalArgumentException
     */
    public static void setSavepointExecute(HttpServletRequest request,
	    CommonsConfigurator commonsConfigurator, PrintWriter out,
	    String action) throws IOException, SQLException,
	    IllegalArgumentException {

	String connectionId = request
		.getParameter(ConnectionParms.CONNECTION_ID);
	String username = request.getParameter(Parameter.USERNAME);

	ConnectionStore connectionStore = new ConnectionStore(username,
		connectionId);
	Connection connection = connectionStore.get();

	debug("");
	debug("setSavepointExecute");
	debug("action       : " + action);
	debug("connectionId : " + connectionId);
	debug("username     : " + username);

	if (connection == null) {
	    out.println(TransferStatus.SEND_OK);
	    out.println(SqlReturnCode.SESSION_INVALIDATED);
	    return;
	}

	if (action.equals(SqlActionTransaction.ACTION_SQL_SET_SAVEPOINT)) {

	    Savepoint savepoint = connection.setSavepoint();
	    connectionStore.put(savepoint);

	    SavepointHttp savepointHttp = new SavepointHttp(
		    savepoint.getSavepointId(), "noname");
	    String savepointStr = savepointHttp.toString();
	    savepointStr = HtmlConverter.toHtml(savepointStr);
	    out.println(TransferStatus.SEND_OK);
	    out.println(savepointStr);
	    return;

	} else if (action
		.equals(SqlActionTransaction.ACTION_SQL_SET_SAVEPOINT_NAME)) {
	    String name = request.getParameter(ConnectionParms.NAME);

	    name = HtmlConverter.fromHtml(name);

	    Savepoint savepoint = connection.setSavepoint(name);
	    connectionStore.put(savepoint);

	    SavepointHttp savepointHttp = new SavepointHttp(-1,
		    savepoint.getSavepointName());
	    String savepointStr = savepointHttp.toString();
	    savepointStr = HtmlConverter.toHtml(savepointStr);
	    out.println(TransferStatus.SEND_OK);
	    out.println(savepointStr);
	    return;

	} else if (action
		.equals(SqlActionTransaction.ACTION_SQL_SET_ROLLBACK_SAVEPOINT)) {
	    String savepointStr = request
		    .getParameter(ConnectionParms.SAVEPOINT);
	    savepointStr = HtmlConverter.fromHtml(savepointStr);

	    Savepoint savepointInfo = SavepointHttp
		    .buildFromString(savepointStr);

	    Savepoint savepoint = connectionStore.getSavepoint(savepointInfo);

	    if (savepoint == null) {
		throw new SQLException("Savepoint does not esxists anymore");
	    }

	    connection.rollback(savepoint);

	    out.println(TransferStatus.SEND_OK);
	    return;

	} else if (action
		.equals(SqlActionTransaction.ACTION_SQL_SET_RELEASE_SAVEPOINT)) {
	    String savepointStr = request
		    .getParameter(ConnectionParms.SAVEPOINT);
	    savepointStr = HtmlConverter.fromHtml(savepointStr);

	    Savepoint savepointInfo = SavepointHttp
		    .buildFromString(savepointStr);

	    Savepoint savepoint = connectionStore.getSavepoint(savepointInfo);

	    if (savepoint == null) {
		throw new SQLException("Savepoint does not esxists anymore");
	    }

	    connection.releaseSavepoint(savepoint);
	    connectionStore.remove(savepointInfo);

	    out.println(TransferStatus.SEND_OK);
	    return;
	} else {
	    throw new IllegalArgumentException(
		    "Invalid Sql Action for setSavepointExecute(): " + action);
	}

    }

    /**
     * Method called by children Servlet for debug purpose println is done only
     * if class name name is in kawansoft-debug.ini
     */
    public static void debug(String s) {
	if (DEBUG) {
	    ServerLogger.getLogger().log(Level.WARNING, s);
	}
    }

}