org.mariadb.jdbc.internal.protocol.Protocol Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mariadb-java-client Show documentation
Show all versions of mariadb-java-client Show documentation
JDBC driver for MariaDB and MySQL
/*
*
* MariaDB Client for Java
*
* Copyright (c) 2012-2014 Monty Program Ab.
* Copyright (c) 2015-2019 MariaDB Ab.
*
* This library 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.
*
* This library 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 Monty Program Ab [email protected].
*
* This particular MariaDB Client for Java file is work
* derived from a Drizzle-JDBC. Drizzle-JDBC file which is covered by subject to
* the following copyright and notice provisions:
*
* Copyright (c) 2009-2011, Marcus Eriksson
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice, this
* list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* Neither the name of the driver nor the names of its contributors may not be
* used to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
*
*/
package org.mariadb.jdbc.internal.protocol;
import org.mariadb.jdbc.*;
import org.mariadb.jdbc.internal.com.read.dao.*;
import org.mariadb.jdbc.internal.com.send.parameters.*;
import org.mariadb.jdbc.internal.failover.*;
import org.mariadb.jdbc.internal.io.input.*;
import org.mariadb.jdbc.internal.io.output.*;
import org.mariadb.jdbc.internal.util.*;
import org.mariadb.jdbc.internal.util.dao.*;
import org.mariadb.jdbc.util.*;
import java.io.*;
import java.net.*;
import java.nio.charset.*;
import java.sql.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.locks.*;
public interface Protocol {
ServerPrepareResult prepare(String sql, boolean executeOnMaster) throws SQLException;
boolean getAutocommit() throws SQLException;
boolean noBackslashEscapes();
void connect() throws SQLException;
UrlParser getUrlParser();
boolean inTransaction();
FailoverProxy getProxy();
void setProxy(FailoverProxy proxy);
Options getOptions();
boolean hasMoreResults();
void close();
void abort();
void reset() throws SQLException;
void closeExplicit();
boolean isClosed();
void resetDatabase() throws SQLException;
String getCatalog() throws SQLException;
void setCatalog(String database) throws SQLException;
String getServerVersion();
boolean isConnected();
boolean getReadonly() throws SQLException;
@SuppressWarnings("RedundantThrows")
void setReadonly(boolean readOnly) throws SQLException;
boolean isMasterConnection();
boolean mustBeMasterConnection();
HostAddress getHostAddress();
void setHostAddress(HostAddress hostAddress);
String getHost();
int getPort();
void rollback() throws SQLException;
String getDatabase();
String getUsername();
boolean ping() throws SQLException;
boolean isValid(int timeout) throws SQLException;
void executeQuery(String sql) throws SQLException;
void executeQuery(boolean mustExecuteOnMaster, Results results, final String sql)
throws SQLException;
void executeQuery(boolean mustExecuteOnMaster, Results results, final String sql, Charset charset)
throws SQLException;
void executeQuery(
boolean mustExecuteOnMaster,
Results results,
final ClientPrepareResult clientPrepareResult,
ParameterHolder[] parameters)
throws SQLException;
void executeQuery(
boolean mustExecuteOnMaster,
Results results,
final ClientPrepareResult clientPrepareResult,
ParameterHolder[] parameters,
int timeout)
throws SQLException;
boolean executeBatchClient(
boolean mustExecuteOnMaster,
Results results,
final ClientPrepareResult prepareResult,
final List parametersList,
boolean hasLongData)
throws SQLException;
void executeBatchStmt(boolean mustExecuteOnMaster, Results results, final List queries)
throws SQLException;
void executePreparedQuery(
boolean mustExecuteOnMaster,
ServerPrepareResult serverPrepareResult,
Results results,
ParameterHolder[] parameters)
throws SQLException;
boolean executeBatchServer(
boolean mustExecuteOnMaster,
ServerPrepareResult serverPrepareResult,
Results results,
String sql,
List parameterList,
boolean hasLongData)
throws SQLException;
void getResult(Results results) throws SQLException;
void cancelCurrentQuery() throws SQLException;
void interrupt();
void skip() throws SQLException;
boolean checkIfMaster() throws SQLException;
boolean hasWarnings();
long getMaxRows();
void setMaxRows(long max) throws SQLException;
int getMajorServerVersion();
int getMinorServerVersion();
boolean versionGreaterOrEqual(int major, int minor, int patch);
void setLocalInfileInputStream(InputStream inputStream);
int getTimeout();
void setTimeout(int timeout) throws SocketException;
boolean getPinGlobalTxToPhysicalConnection();
long getServerThreadId();
Socket getSocket();
void setTransactionIsolation(int level) throws SQLException;
int getTransactionIsolationLevel();
boolean isExplicitClosed();
void connectWithoutProxy() throws SQLException;
boolean shouldReconnectWithoutProxy();
void setHostFailedWithoutProxy();
void releasePrepareStatement(ServerPrepareResult serverPrepareResult) throws SQLException;
boolean forceReleasePrepareStatement(int statementId) throws SQLException;
void forceReleaseWaitingPrepareStatement() throws SQLException;
ServerPrepareStatementCache prepareStatementCache();
TimeZone getTimeZone();
void prolog(
long maxRows, boolean hasProxy, MariaDbConnection connection, MariaDbStatement statement)
throws SQLException;
void prologProxy(
ServerPrepareResult serverPrepareResult,
long maxRows,
boolean hasProxy,
MariaDbConnection connection,
MariaDbStatement statement)
throws SQLException;
Results getActiveStreamingResult();
void setActiveStreamingResult(Results mariaSelectResultSet);
ReentrantLock getLock();
void setServerStatus(short serverStatus);
void removeHasMoreResults();
void setHasWarnings(boolean hasWarnings);
ServerPrepareResult addPrepareInCache(String key, ServerPrepareResult serverPrepareResult);
void readEofPacket() throws SQLException, IOException;
void skipEofPacket() throws SQLException, IOException;
void changeSocketTcpNoDelay(boolean setTcpNoDelay);
void changeSocketSoTimeout(int setSoTimeout) throws SocketException;
void removeActiveStreamingResult();
void resetStateAfterFailover(
long maxRows, int transactionIsolationLevel, String database, boolean autocommit)
throws SQLException;
void setActiveFutureTask(FutureTask activeFutureTask);
boolean isServerMariaDb();
SQLException handleIoException(Exception initialException);
PacketInputStream getReader();
PacketOutputStream getWriter();
boolean isEofDeprecated();
int getAutoIncrementIncrement() throws SQLException;
boolean sessionStateAware();
String getTraces();
boolean isInterrupted();
void stopIfInterrupted() throws SQLTimeoutException;
}