src-main.org.awakefw.sql.jdbc.http.JdbcHttpTransactionTransfer Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Awake SQL. 
 * Awake SQL: Remote JDBC access over HTTP.                                    
 * Copyright (C) 2013,  KawanSoft SAS
 * (http://www.kawansoft.com). All rights reserved.                    
 *                                                                         
 * Awake SQL is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.         
 *              
 * Awake SQL 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 General Public License
 * along with this program; if not, see .
 *
 * If you develop commercial activities using Awake SQL, you must: 
 * a) disclose and distribute all source code of your own product,
 * b) license your own product under the GNU General Public License.
 * 
 * You can be released from the requirements of the license by
 * purchasing a commercial license. Buying such a license will allow you 
 * to ship Awake SQL with your closed source products without disclosing 
 * the source code.
 *
 * For more information, please contact KawanSoft SAS at this
 * address: [email protected]
 * 
 * Any modifications to this file must keep this entire header
 * intact.
 */
package org.awakefw.sql.jdbc.http;

import java.io.IOException;
import java.sql.SQLException;
import java.util.List;
import java.util.Vector;

import org.apache.http.message.BasicNameValuePair;
import org.awakefw.commons.api.client.InvalidLoginException;
import org.awakefw.file.api.util.AwakeDebug;
import org.awakefw.file.http.HttpTransfer;
import org.awakefw.file.http.HttpTransferOne;
import org.awakefw.file.util.AwakeClientLogger;
import org.awakefw.file.util.Tag;
import org.awakefw.file.util.parms.Parameter;
import org.awakefw.file.util.parms.ReturnCode;
import org.awakefw.sql.api.client.InvalidatedSessionException;
import org.awakefw.sql.jdbc.ConnectionHttp;
import org.awakefw.sql.util.ConnectionParms;
import org.awakefw.sql.util.SqlActionTransaction;
import org.awakefw.sql.util.SqlReturnCode;

/**
 * 
 * For all transaction parameters get/set transfers...
 * 
 */
public class JdbcHttpTransactionTransfer {
    
    /** Set to true to display/log debug info */
    private static boolean DEBUG = AwakeDebug
	    .isSet(JdbcHttpTransactionTransfer.class);

    /** The Http Connection */
    private ConnectionHttp connectionHttp = null;

    /** The Authentication Token */
    private String authenticationToken = null;

    /**
     * Protected constructor, not callable
     */
    protected JdbcHttpTransactionTransfer() {
    }

    /**
     * Constructor
     * 
     * @param connectionHttp
     *            the http Connection
     * @param authenticationToken
     *            the Http Connection Authentication Token
     */

    public JdbcHttpTransactionTransfer(ConnectionHttp connectionHttp,
	    String authenticationToken) {
	this.connectionHttp = connectionHttp;
	this.authenticationToken = authenticationToken;
    }

    /**
     * Sends a setAutoCommit() to server
     * 
     * @param autoCommit
     *            true or false
     */
    public void setAutoCommit(boolean autoCommit) throws SQLException {
	setTransactionAction(SqlActionTransaction.ACTION_SQL_SET_AUTOCOMMIT,
		ConnectionParms.AUTOCOMMIT, autoCommit + "");
    }

    /**
     * Sends a setReadOnly() to server
     * 
     * @param readOnly
     *            true or false
     */
    public void setReadOnly(boolean readOnly) throws SQLException {
	setTransactionAction(SqlActionTransaction.ACTION_SQL_SET_READ_ONLY,
		ConnectionParms.READONLY, readOnly + "");
    }

    /**
     * Sends a setHoldability() to server
     * 
     * @param readOnly
     *            true or false
     */
    public void setHoldability(int holdability) throws SQLException {
	setTransactionAction(SqlActionTransaction.ACTION_SQL_SET_HOLDABILITY,
		ConnectionParms.HOLDABILITY, holdability + "");
    }

    /**
     * Sends a setHoldability() to server
     * 
     * @param readOnly
     *            true or false
     */
    public void setTransactionIsolation(int level) throws SQLException {
	setTransactionAction(
		SqlActionTransaction.ACTION_SQL_SET_TRANSACTION_ISOLATION,
		ConnectionParms.TRANSACTION_ISOLATION, level + "");
    }

    /**
     * Sets a transaction with a unique parm : setReadOnly(), setHoldability(),
     * setTransactionIsolation()
     * 
     * @param transactionAction
     *            the action
     * @param transactionParmName
     *            the parm name
     * @param transactionParmValue
     *            the parm value
     * @throws SQLException
     */
    private void setTransactionAction(String transactionAction,
	    String transactionParmName, String transactionParmValue)
	    throws SQLException {

	// Launch the Servlet
	HttpTransfer httpTransfer = new HttpTransferOne(
		connectionHttp.getUrl(), connectionHttp.getHttpProxy(),
		connectionHttp.getHttpProtocolParameters(),
		connectionHttp.getAwakeProgressManager());

	List requestParams = new Vector();
	requestParams.add(new BasicNameValuePair(Parameter.ACTION,
		transactionAction));
	requestParams.add(new BasicNameValuePair(Parameter.USERNAME,
		connectionHttp.getUsername()));
	requestParams.add(new BasicNameValuePair(Parameter.TOKEN,
		this.authenticationToken));

	requestParams.add(new BasicNameValuePair(
		ConnectionParms.CONNECTION_ID, connectionHttp
			.getConnectionId()));
	requestParams.add(new BasicNameValuePair(transactionParmName,
		transactionParmValue));

	try {
	    httpTransfer.send(requestParams);
	} catch (Exception e) {
	    JdbcHttpTransferUtil.wrapExceptionAsSQLException(e);
	}

	String receive = httpTransfer.recv();
	receive = receive.trim();

	debug("httpTransfer.recv(): " + receive + ":");

	if (receive.startsWith(ReturnCode.INVALID_LOGIN_OR_PASSWORD)) {
	    throw new SQLException(new InvalidLoginException());
	}

	if (receive.startsWith(SqlReturnCode.SESSION_INVALIDATED)) {
	    throw new SQLException(new InvalidatedSessionException());
	}

	return;
    }

    /**
     * Init the remote connection on the server
     */
    public void initRemoteConnection() throws SQLException {
	sendTransactionAction(SqlActionTransaction.ACTION_SQL_INIT_REMOTE_CONNECTION);
    }

    /**
     * Sends a Connection.commit() to server
     */
    public void commit() throws SQLException {
	sendTransactionAction(SqlActionTransaction.ACTION_SQL_COMMIT);
    }

    /**
     * Sends a Connection.rollback() to server
     */
    public void rollback() throws SQLException {
	sendTransactionAction(SqlActionTransaction.ACTION_SQL_ROLLBACK);
    }

    /**
     * Sends a Connection.rollback() to server
     */
    public void close() throws SQLException {
	sendTransactionAction(SqlActionTransaction.ACTION_SQL_CON_CLOSE);
    }

    /**
     * Sends a transaction action (commit, rollback or close) to the server
     */
    private void sendTransactionAction(String transactionAction)
	    throws SQLException {

	// Launch the Servlet
	HttpTransfer httpTransfer = new HttpTransferOne(
		connectionHttp.getUrl(), connectionHttp.getHttpProxy(),
		connectionHttp.getHttpProtocolParameters(),
		connectionHttp.getAwakeProgressManager());

	List requestParams = new Vector();
	requestParams.add(new BasicNameValuePair(Parameter.ACTION,
		transactionAction));
	requestParams.add(new BasicNameValuePair(Parameter.USERNAME,
		connectionHttp.getUsername()));
	requestParams.add(new BasicNameValuePair(Parameter.TOKEN,
		this.authenticationToken));

	requestParams.add(new BasicNameValuePair(
		ConnectionParms.CONNECTION_ID, connectionHttp
			.getConnectionId()));

	try {
	    httpTransfer.send(requestParams);
	} catch (Exception e) {
	    JdbcHttpTransferUtil.wrapExceptionAsSQLException(e);
	}

	String receive = httpTransfer.recv();
	receive = receive.trim();

	debug("httpTransfer.recv(): " + receive + ":");

	if (receive.startsWith(ReturnCode.INVALID_LOGIN_OR_PASSWORD)) {
	    throw new SQLException(new InvalidLoginException());
	}

	if (receive.startsWith(SqlReturnCode.SESSION_INVALIDATED)) {
	    throw new SQLException(new InvalidatedSessionException());
	}

	return;
    }

    /**
     * Sends a getReadOnly to the server
     * 
     * @return the server getReadOnly()
     * @throws SQLException
     */
    public boolean isReadOnly() throws SQLException {
	String readOnlyStr = getTransactionAction(SqlActionTransaction.ACTION_SQL_IS_READ_ONLY);
	return Boolean.parseBoolean(readOnlyStr);
    }

    /**
     * Sends a getAutoCommit() the server
     * 
     * @return the server getAutoCommit()
     * @throws SQLException
     */
    public boolean getAutoCommit() throws SQLException {
	String autoCommitStr = getTransactionAction(SqlActionTransaction.ACTION_SQL_GET_AUTOCOMMIT);
	return Boolean.parseBoolean(autoCommitStr);
    }

    /**
     * Sends a getHoldability() to the server
     * 
     * @return
     * @throws SQLException
     */
    public int getHoldability() throws SQLException {
	String holdabilityStr = getTransactionAction(SqlActionTransaction.ACTION_SQL_GET_HOLDABILITY);

	int holdability = -1;

	try {
	    holdability = Integer.parseInt(holdabilityStr);
	} catch (NumberFormatException e) {
	    throw new SQLException(Tag.AWAKE_PRODUCT_FAIL + e.getMessage(),
		    new IOException(e.getMessage(), e));
	}

	return holdability;
    }

    /**
     * Gets the server default Connection.getTransactionIsolation()
     * 
     * @return the server default Connection.getTransactionIsolation()
     */
    public int getTransactionIsolation() throws SQLException {
	String levelStr = getTransactionAction(SqlActionTransaction.ACTION_SQL_GET_TRANSACTION_ISOLATION);

	int level = -1;

	try {
	    level = Integer.parseInt(levelStr);
	} catch (NumberFormatException e) {
	    throw new SQLException(Tag.AWAKE_PRODUCT_FAIL + e.getMessage(),
		    new IOException(e.getMessage(), e));
	}

	return level;
    }

    /**
     * Gets a transaction action (commit, rollback or close) to the server
     */
    private String getTransactionAction(String transactionAction)
	    throws SQLException {

	// Launch the Servlet
	HttpTransfer httpTransfer = new HttpTransferOne(
		connectionHttp.getUrl(), connectionHttp.getHttpProxy(),
		connectionHttp.getHttpProtocolParameters(),
		connectionHttp.getAwakeProgressManager());

	List requestParams = new Vector();
	requestParams.add(new BasicNameValuePair(Parameter.ACTION,
		transactionAction));
	requestParams.add(new BasicNameValuePair(Parameter.USERNAME,
		connectionHttp.getUsername()));
	requestParams.add(new BasicNameValuePair(Parameter.TOKEN,
		this.authenticationToken));

	requestParams.add(new BasicNameValuePair(
		ConnectionParms.CONNECTION_ID, connectionHttp
			.getConnectionId()));

	try {
	    httpTransfer.send(requestParams);
	} catch (Exception e) {
	    JdbcHttpTransferUtil.wrapExceptionAsSQLException(e);
	}

	String receive = httpTransfer.recv();
	receive = receive.trim();

	debug("httpTransfer.recv(): " + receive + ":");

	if (receive.startsWith(ReturnCode.INVALID_LOGIN_OR_PASSWORD)) {
	    throw new SQLException(new InvalidLoginException());
	}

	if (receive.startsWith(SqlReturnCode.SESSION_INVALIDATED)) {
	    throw new SQLException(new InvalidatedSessionException());
	}

	return receive;
    }

    /**
     * Debug tool
     * 
     * @param s
     */

    // @SuppressWarnings("unused")
    private void debug(String s) {
	if (DEBUG) {
	    AwakeClientLogger.log(s);
	}
    }
}