com.fluidbpm.ws.client.v1.sqlutil.sqlnative.SQLUtilWebSocketExecuteNativeSQLClient Maven / Gradle / Ivy

Go to download
/*
 * Koekiebox CONFIDENTIAL
 *
 * [2012] - [2017] Koekiebox (Pty) Ltd
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of Koekiebox and its suppliers, if any. The intellectual and
 * technical concepts contained herein are proprietary to Koekiebox
 * and its suppliers and may be covered by South African and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material is strictly
 * forbidden unless prior written permission is obtained from Koekiebox.
 */

package com.fluidbpm.ws.client.v1.sqlutil.sqlnative;

import com.fluidbpm.program.api.util.UtilGlobal;
import com.fluidbpm.program.api.vo.sqlutil.sqlnative.NativeSQLQuery;
import com.fluidbpm.program.api.vo.sqlutil.sqlnative.SQLResultSet;
import com.fluidbpm.program.api.vo.ws.WS;
import com.fluidbpm.ws.client.FluidClientException;
import com.fluidbpm.ws.client.v1.websocket.ABaseClientWebSocket;
import com.fluidbpm.ws.client.v1.websocket.AGenericListMessageHandler;
import com.fluidbpm.ws.client.v1.websocket.IMessageReceivedCallback;
import org.json.JSONObject;

import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * Java Web Socket Client for {@code SQLUtil} related actions.
 * Implementation is making use of {@link CompletableFuture}.
 *
 * {@code this} client allows one to execute native SQL using
 * one of the configured SQL DataSources.
 *
 * @author jasonbruwer on 2018-05-26
 * @since v1.8
 *
 * @see JSONObject
 * @see SQLResultSet
 */
public class SQLUtilWebSocketExecuteNativeSQLClient extends
		ABaseClientWebSocket> {

	/**
	 * Constructor that sets the Service Ticket from authentication.
	 * The ResultSet will not be compressed.
	 *
	 * @param endpointBaseUrlParam URL to base endpoint.
	 * @param messageReceivedCallbackParam Callback for when a message is received.
	 * @param serviceTicketAsHexParam The Server issued Service Ticket.
	 * @param timeoutInMillisParam The timeout of the request in millis.
	 *
	 * @see com.fluidbpm.program.api.vo.compress.CompressedResponse
	 */
	public SQLUtilWebSocketExecuteNativeSQLClient(
		String endpointBaseUrlParam,
		IMessageReceivedCallback messageReceivedCallbackParam,
		String serviceTicketAsHexParam,
		long timeoutInMillisParam
	) {
		this(endpointBaseUrlParam,
				messageReceivedCallbackParam,
				serviceTicketAsHexParam,
				timeoutInMillisParam,
				false,
				UtilGlobal.EMPTY);
	}

	/**
	 * Constructor that sets the Service Ticket from authentication.
	 *
	 * @param endpointBaseUrlParam URL to base endpoint.
	 * @param messageReceivedCallbackParam Callback for when a message is received.
	 * @param serviceTicketAsHexParam The Server issued Service Ticket.
	 * @param timeoutInMillisParam The timeout of the request in millis.
	 * @param compressResponseParam Compress the SQL Result in Base-64.
	 * @param compressResponseCharsetParam Compress response using provided charset.
	 *
	 * @see com.fluidbpm.program.api.vo.compress.CompressedResponse
	 */
	public SQLUtilWebSocketExecuteNativeSQLClient(
		String endpointBaseUrlParam,
		IMessageReceivedCallback messageReceivedCallbackParam,
		String serviceTicketAsHexParam,
		long timeoutInMillisParam,
		boolean compressResponseParam,
		String compressResponseCharsetParam
	) {
		super(endpointBaseUrlParam,
				messageReceivedCallbackParam,
				timeoutInMillisParam,
				WS.Path.SQLUtil.Version1.getExecuteNativeSQLWebSocket(
						serviceTicketAsHexParam,
						compressResponseParam,
						compressResponseCharsetParam),
				compressResponseParam);

		this.setServiceTicket(serviceTicketAsHexParam);
	}

	/**
	 * Executes a native SQL query on the remote Fluid instance.
	 *
	 * The relevant access must exist.
	 *
	 * @param nativeSQLQueriesParam The SQL Queries to execute.
	 *
	 * @return The SQL Execution result as {@code SQLResultSet}'s.
	 *
	 * @throws FluidClientException if data-source name is not set.
	 */
	public List executeNativeSQLSynchronized(NativeSQLQuery ... nativeSQLQueriesParam) {
		if (nativeSQLQueriesParam == null) return null;

		//Start a new request...
		String uniqueReqId = this.initNewRequest();
		//Send all the messages...
		for (NativeSQLQuery queryToExec : nativeSQLQueriesParam) {
			if (queryToExec.getDatasourceName() == null || queryToExec.getDatasourceName().isEmpty()) {
				throw new FluidClientException(
					"No data-source name provided. Not allowed.",
					FluidClientException.ErrorCode.FIELD_VALIDATE
				);
			}
			
			this.setEchoIfNotSet(queryToExec);

			//Send the actual message...
			this.sendMessage(queryToExec, uniqueReqId);
		}

		try {
			List returnValue =
					this.getHandler(uniqueReqId).getCF().get(this.getTimeoutInMillis(), TimeUnit.MILLISECONDS);

			//Connection was closed.. this is a problem....
			if (this.getHandler(uniqueReqId).isConnectionClosed()) {
				throw new FluidClientException(
						"SQLUtil-WebSocket-ExecuteNativeSQL: " +
								"The connection was closed by the server prior to the response received.",
						FluidClientException.ErrorCode.IO_ERROR);
			}

			return returnValue;
		} catch (InterruptedException exceptParam) {
			//Interrupted...
			throw new FluidClientException(
					"SQLUtil-WebSocket-ExecuteNativeSQL: " +
							exceptParam.getMessage(),
					exceptParam,
					FluidClientException.ErrorCode.STATEMENT_EXECUTION_ERROR);
		} catch (ExecutionException executeProblem) {
			//Error on the web-socket...
			Throwable cause = executeProblem.getCause();
			//Fluid client exception...
			if (cause instanceof FluidClientException) {
				throw (FluidClientException)cause;
			} else {
				throw new FluidClientException(
						"SQLUtil-WebSocket-ExecuteNativeSQL: " +
								cause.getMessage(), cause,
						FluidClientException.ErrorCode.STATEMENT_EXECUTION_ERROR);
			}
		} catch (TimeoutException eParam) {
			//Timeout...
			String errMessage = this.getExceptionMessageVerbose(
					"SQLUtil-WebSocket-ExecuteNativeSQL",
					uniqueReqId, (Object[]) nativeSQLQueriesParam);
			throw new FluidClientException(errMessage, FluidClientException.ErrorCode.IO_ERROR);
		} finally {
			this.removeHandler(uniqueReqId);
		}
	}

	/**
	 * Create a new instance of the handler class for {@code this} client.
	 *
	 * @return new instance of {@code CreateFormContainerMessageHandler}
	 */
	@Override
	public SQLResultSetMessageHandler getNewHandlerInstance() {
		return new SQLResultSetMessageHandler(
				this.messageReceivedCallback,
				this.webSocketClient,
				this.compressResponse
		);
	}
}