/*
* Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 2.0, as published by the
* Free Software Foundation.
*
* This program is also distributed with certain software (including but not
* limited to OpenSSL) that is licensed under separate terms, as designated in a
* particular file or component or in included license documentation. The
* authors of MySQL hereby grant you an additional permission to link the
* program and your derivative works with the separately licensed software that
* they have included with MySQL.
*
* Without limiting anything contained in the foregoing, this file, which is
* part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
* version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program 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 General Public License, version 2.0,
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.cj;
import java.io.
IOException;
import java.util.
List;
import java.util.concurrent.
CompletableFuture;
import java.util.function.
BiFunction;
import java.util.function.
Function;
import java.util.function.
Supplier;
import com.mysql.cj.conf.
HostInfo;
import com.mysql.cj.conf.
PropertySet;
import com.mysql.cj.exceptions.
CJCommunicationsException;
import com.mysql.cj.protocol.
ColumnDefinition;
import com.mysql.cj.protocol.
ResultListener;
import com.mysql.cj.protocol.
ResultStreamer;
import com.mysql.cj.protocol.x.
ResultCreatingResultListener;
import com.mysql.cj.protocol.x.
StatementExecuteOk;
import com.mysql.cj.protocol.x.
StatementExecuteOkBuilder;
import com.mysql.cj.protocol.x.
XMessageBuilder;
import com.mysql.cj.protocol.x.
XProtocol;
import com.mysql.cj.protocol.x.
XProtocolError;
import com.mysql.cj.result.
RowList;
import com.mysql.cj.xdevapi.
FilterParams;
import com.mysql.cj.xdevapi.
FilterableStatement;
import com.mysql.cj.xdevapi.
PreparableStatement;
import com.mysql.cj.xdevapi.
SqlDataResult;
import com.mysql.cj.xdevapi.
SqlResult;
import com.mysql.cj.xdevapi.
SqlResultImpl;
import com.mysql.cj.xdevapi.
SqlUpdateResult;
public class
MysqlxSession extends
CoreSession {
public
MysqlxSession(
HostInfo hostInfo,
PropertySet propSet) {
super(
hostInfo,
propSet);
// create protocol instance
this.
protocol = new
XProtocol(
hostInfo,
propSet);
this.
messageBuilder = this.
protocol.
getMessageBuilder();
this.
protocol.
connect(
hostInfo.
getUser(),
hostInfo.
getPassword(),
hostInfo.
getDatabase());
}
public
MysqlxSession(
XProtocol prot) {
super(null,
prot.
getPropertySet());
this.
protocol =
prot;
this.
messageBuilder = this.
protocol.
getMessageBuilder();
}
@
Override
public
String getProcessHost() {
return this.
protocol.
getSocketConnection().
getHost();
}
public int
getPort() {
return this.
protocol.
getSocketConnection().
getPort();
}
@
Override
public void
quit() {
try {
this.
protocol.
close();
} catch (
IOException ex) {
throw new
CJCommunicationsException(
ex);
}
super.quit();
}
/**
* Consume an OK packet from the underlying protocol.
*
* @return <code>null</code>
*/
public
Void readOk() {
((
XProtocol) this.
protocol).
readOk();
return null;
}
/**
* Check if current session is using a MySQL server that supports prepared statements.
*
* @return
* {@code true} if the MySQL server in use supports prepared statements
*/
public boolean
supportsPreparedStatements() {
return ((
XProtocol) this.
protocol).
supportsPreparedStatements();
}
/**
* Check if enough statements were executed in the underlying MySQL server so that another prepare statement attempt should be done.
*
* @return
* {@code true} if enough executions have been done since last time a prepared statement failed to be prepared
*/
public boolean
readyForPreparingStatements() {
return ((
XProtocol) this.
protocol).
readyForPreparingStatements();
}
/**
* Return an id to be used as a client-managed prepared statement id.
*
* @param preparableStatement
* {@link PreparableStatement}
* @return a new identifier to be used as prepared statement id
*/
public int
getNewPreparedStatementId(
PreparableStatement<?>
preparableStatement) {
return ((
XProtocol) this.
protocol).
getNewPreparedStatementId(
preparableStatement);
}
/**
* Free a prepared statement id so that it can be reused.
*
* @param preparedStatementId
* the prepared statement id to release
*/
public void
freePreparedStatementId(int
preparedStatementId) {
((
XProtocol) this.
protocol).
freePreparedStatementId(
preparedStatementId);
}
/**
* Propagate to the underlying protocol instance that preparing a statement on the connected server failed.
*
* @param preparedStatementId
* the id of the prepared statement that failed to be prepared
* @param e
* {@link XProtocolError}
* @return
* {@code true} if the exception was properly handled
*/
public boolean
failedPreparingStatement(int
preparedStatementId,
XProtocolError e) {
return ((
XProtocol) this.
protocol).
failedPreparingStatement(
preparedStatementId,
e);
}
public <T extends
ResultStreamer> T
find(
FilterParams filterParams,
Function<
ColumnDefinition,
BiFunction<
RowList,
Supplier<
StatementExecuteOk>, T>>
resultCtor) {
this.
protocol.
send(((
XMessageBuilder) this.
messageBuilder).
buildFind(
filterParams), 0);
ColumnDefinition metadata = this.
protocol.
readMetadata();
T
res =
resultCtor.
apply(
metadata).
apply(((
XProtocol) this.
protocol).
getRowInputStream(
metadata), this.
protocol::readQueryResult);
this.
protocol.
setCurrentResultStreamer(
res);
return
res;
}
/**
* Execute a previously prepared find statement using the given arguments.
*
* @param preparedStatementId
* the prepared statement id to execute. This statement must be previously prepared
* @param filterParams
* the {@link FilterableStatement} params that contain the arguments for the previously-defined placeholders
* @param resultCtor
* a constructor that builds the results.
* @param <T>
* result type
* @return
* the result from the given constructor
*/
public <T extends
ResultStreamer> T
executePreparedFind(int
preparedStatementId,
FilterParams filterParams,
Function<
ColumnDefinition,
BiFunction<
RowList,
Supplier<
StatementExecuteOk>, T>>
resultCtor) {
this.
protocol.
send(((
XMessageBuilder) this.
messageBuilder).
buildPrepareExecute(
preparedStatementId,
filterParams), 0);
ColumnDefinition metadata = this.
protocol.
readMetadata();
T
res =
resultCtor.
apply(
metadata).
apply(((
XProtocol) this.
protocol).
getRowInputStream(
metadata), this.
protocol::readQueryResult);
this.
protocol.
setCurrentResultStreamer(
res);
return
res;
}
public <RES_T>
CompletableFuture<RES_T>
asyncFind(
FilterParams filterParams,
Function<
ColumnDefinition,
BiFunction<
RowList,
Supplier<
StatementExecuteOk>, RES_T>>
resultCtor) {
CompletableFuture<RES_T>
f = new
CompletableFuture<>();
ResultListener<
StatementExecuteOk>
l = new
ResultCreatingResultListener<>(
resultCtor,
f);
((
XProtocol) this.
protocol).
asyncFind(
filterParams,
l,
f);
return
f;
}
public
SqlResult executeSql(
String sql,
List<
Object>
args) {
this.
protocol.
send(this.
messageBuilder.
buildSqlStatement(
sql,
args), 0);
return
executeSqlProcessResult();
}
/**
* Process the response messages from a <i>StmtExecute</i> request.
*
* @return
* an {@link SqlResult} with the returned rows.
*/
private
SqlResult executeSqlProcessResult() {
boolean
readLastResult[] = new boolean[1];
Supplier<
StatementExecuteOk>
okReader = () -> {
if (
readLastResult[0]) {
throw new
CJCommunicationsException("Invalid state attempting to read ok packet");
}
if (((
XProtocol) this.
protocol).
hasMoreResults()) {
// empty/fabricated OK packet
return new
StatementExecuteOkBuilder().
build();
}
readLastResult[0] = true;
return this.
protocol.
readQueryResult();
};
Supplier<
SqlResult>
resultStream = () -> {
if (
readLastResult[0]) {
return null;
} else if (((
XProtocol) this.
protocol).
isSqlResultPending()) {
ColumnDefinition metadata = this.
protocol.
readMetadata();
return new
SqlDataResult(
metadata, this.
protocol.
getServerSession().
getDefaultTimeZone(), this.
protocol.
getRowInputStream(
metadata),
okReader,
this.
propertySet);
} else {
readLastResult[0] = true;
return new
SqlUpdateResult(this.
protocol.
readQueryResult());
}
};
SqlResultImpl res = new
SqlResultImpl(
resultStream);
this.
protocol.
setCurrentResultStreamer(
res);
return
res;
}
public
CompletableFuture<
SqlResult>
asyncExecuteSql(
String sql,
List<
Object>
args) {
return ((
XProtocol) this.
protocol).
asyncExecuteSql(
sql,
args);
}
public boolean
isClosed() {
return !((
XProtocol) this.
protocol).
isOpen();
}
}