org.apache.calcite.avatica.remote.Service Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.calcite.avatica.remote;
import org.apache.calcite.avatica.AvaticaConnection;
import org.apache.calcite.avatica.Meta;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import java.util.List;
import java.util.Map;
/**
* API for request-response calls to an Avatica server.
*/
public interface Service {
ResultSetResponse apply(CatalogsRequest request);
ResultSetResponse apply(SchemasRequest request);
ResultSetResponse apply(TablesRequest request);
ResultSetResponse apply(TableTypesRequest request);
ResultSetResponse apply(TypeInfoRequest request);
ResultSetResponse apply(ColumnsRequest request);
PrepareResponse apply(PrepareRequest request);
ExecuteResponse apply(PrepareAndExecuteRequest request);
FetchResponse apply(FetchRequest request);
CreateStatementResponse apply(CreateStatementRequest request);
CloseStatementResponse apply(CloseStatementRequest request);
CloseConnectionResponse apply(CloseConnectionRequest request);
ConnectionSyncResponse apply(ConnectionSyncRequest request);
DatabasePropertyResponse apply(DatabasePropertyRequest request);
/** Factory that creates a {@code Service}. */
interface Factory {
Service create(AvaticaConnection connection);
}
/** Base class for all service request messages. */
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
property = "request",
defaultImpl = SchemasRequest.class)
@JsonSubTypes({
@JsonSubTypes.Type(value = CatalogsRequest.class, name = "getCatalogs"),
@JsonSubTypes.Type(value = SchemasRequest.class, name = "getSchemas"),
@JsonSubTypes.Type(value = TablesRequest.class, name = "getTables"),
@JsonSubTypes.Type(value = TableTypesRequest.class, name = "getTableTypes"),
@JsonSubTypes.Type(value = TypeInfoRequest.class, name = "getTypeInfo"),
@JsonSubTypes.Type(value = ColumnsRequest.class, name = "getColumns"),
@JsonSubTypes.Type(value = PrepareRequest.class, name = "prepare"),
@JsonSubTypes.Type(value = PrepareAndExecuteRequest.class,
name = "prepareAndExecute"),
@JsonSubTypes.Type(value = FetchRequest.class, name = "fetch"),
@JsonSubTypes.Type(value = CreateStatementRequest.class,
name = "createStatement"),
@JsonSubTypes.Type(value = CloseStatementRequest.class,
name = "closeStatement"),
@JsonSubTypes.Type(value = CloseConnectionRequest.class,
name = "closeConnection"),
@JsonSubTypes.Type(value = ConnectionSyncRequest.class, name = "connectionSync"),
@JsonSubTypes.Type(value = DatabasePropertyRequest.class, name = "databaseProperties") })
abstract class Request {
abstract Response accept(Service service);
}
/** Base class for all service response messages. */
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
property = "response",
defaultImpl = ResultSetResponse.class)
@JsonSubTypes({
@JsonSubTypes.Type(value = ResultSetResponse.class, name = "resultSet"),
@JsonSubTypes.Type(value = PrepareResponse.class, name = "prepare"),
@JsonSubTypes.Type(value = FetchResponse.class, name = "fetch"),
@JsonSubTypes.Type(value = CreateStatementResponse.class,
name = "createStatement"),
@JsonSubTypes.Type(value = CloseStatementResponse.class,
name = "closeStatement"),
@JsonSubTypes.Type(value = CloseConnectionResponse.class,
name = "closeConnection"),
@JsonSubTypes.Type(value = ConnectionSyncResponse.class, name = "connectionSync"),
@JsonSubTypes.Type(value = DatabasePropertyResponse.class, name = "databaseProperties") })
abstract class Response {
}
/** Request for
* {@link org.apache.calcite.avatica.Meta#getCatalogs()}. */
class CatalogsRequest extends Request {
ResultSetResponse accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link org.apache.calcite.avatica.Meta#getDatabaseProperties()}. */
class DatabasePropertyRequest extends Request {
@JsonCreator
public DatabasePropertyRequest() {
}
DatabasePropertyResponse accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link Meta#getSchemas(String, org.apache.calcite.avatica.Meta.Pat)}. */
class SchemasRequest extends Request {
public final String catalog;
public final String schemaPattern;
@JsonCreator
public SchemasRequest(@JsonProperty("catalog") String catalog,
@JsonProperty("schemaPattern") String schemaPattern) {
this.catalog = catalog;
this.schemaPattern = schemaPattern;
}
ResultSetResponse accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link Meta#getTables(String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, java.util.List)}
*/
class TablesRequest extends Request {
public final String catalog;
public final String schemaPattern;
public final String tableNamePattern;
public final List typeList;
@JsonCreator
public TablesRequest(@JsonProperty("catalog") String catalog,
@JsonProperty("schemaPattern") String schemaPattern,
@JsonProperty("tableNamePattern") String tableNamePattern,
@JsonProperty("typeList") List typeList) {
this.catalog = catalog;
this.schemaPattern = schemaPattern;
this.tableNamePattern = tableNamePattern;
this.typeList = typeList;
}
@Override Response accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link Meta#getTableTypes()}. */
class TableTypesRequest extends Request {
@Override ResultSetResponse accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link Meta#getColumns(String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat)}.
*/
class ColumnsRequest extends Request {
public final String catalog;
public final String schemaPattern;
public final String tableNamePattern;
public final String columnNamePattern;
@JsonCreator
public ColumnsRequest(@JsonProperty("catalog") String catalog,
@JsonProperty("schemaPattern") String schemaPattern,
@JsonProperty("tableNamePattern") String tableNamePattern,
@JsonProperty("columnNamePattern") String columnNamePattern) {
this.catalog = catalog;
this.schemaPattern = schemaPattern;
this.tableNamePattern = tableNamePattern;
this.columnNamePattern = columnNamePattern;
}
ResultSetResponse accept(Service service) {
return service.apply(this);
}
}
/** Request for
* {@link Meta#getTypeInfo()}. */
class TypeInfoRequest extends Request {
@Override ResultSetResponse accept(Service service) {
return service.apply(this);
}
}
/** Response that contains a result set.
*
* Regular result sets have {@code updateCount} -1;
* any other value means a dummy result set that is just a count, and has
* no signature and no other data.
*
*
Several types of request, including
* {@link org.apache.calcite.avatica.Meta#getCatalogs()} and
* {@link org.apache.calcite.avatica.Meta#getSchemas(String, org.apache.calcite.avatica.Meta.Pat)}
* {@link Meta#getTables(String, Meta.Pat, Meta.Pat, List)}
* {@link Meta#getTableTypes()}
* return this response. */
class ResultSetResponse extends Response {
public final String connectionId;
public final int statementId;
public final boolean ownStatement;
public final Meta.Signature signature;
public final Meta.Frame firstFrame;
public final long updateCount;
@JsonCreator
public ResultSetResponse(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("statementId") int statementId,
@JsonProperty("ownStatement") boolean ownStatement,
@JsonProperty("signature") Meta.Signature signature,
@JsonProperty("firstFrame") Meta.Frame firstFrame,
@JsonProperty("updateCount") long updateCount) {
this.connectionId = connectionId;
this.statementId = statementId;
this.ownStatement = ownStatement;
this.signature = signature;
this.firstFrame = firstFrame;
this.updateCount = updateCount;
}
}
/** Request for
* {@link Meta#prepareAndExecute(Meta.StatementHandle, String, long, Meta.PrepareCallback)}. */
class PrepareAndExecuteRequest extends Request {
public final String connectionId;
public final String sql;
public final long maxRowCount;
public final int statementId;
@JsonCreator
public PrepareAndExecuteRequest(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("statementId") int statementId,
@JsonProperty("sql") String sql,
@JsonProperty("maxRowCount") long maxRowCount) {
this.connectionId = connectionId;
this.statementId = statementId;
this.sql = sql;
this.maxRowCount = maxRowCount;
}
@Override ExecuteResponse accept(Service service) {
return service.apply(this);
}
}
/** Response to a
* {@link org.apache.calcite.avatica.remote.Service.PrepareAndExecuteRequest}. */
class ExecuteResponse extends Response {
public final List results;
@JsonCreator
public ExecuteResponse(
@JsonProperty("resultSets") List results) {
this.results = results;
}
}
/** Request for
* {@link Meta#prepare(Meta.ConnectionHandle, String, long)}. */
class PrepareRequest extends Request {
public final String connectionId;
public final String sql;
public final long maxRowCount;
@JsonCreator
public PrepareRequest(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("sql") String sql,
@JsonProperty("maxRowCount") long maxRowCount) {
this.connectionId = connectionId;
this.sql = sql;
this.maxRowCount = maxRowCount;
}
@Override PrepareResponse accept(Service service) {
return service.apply(this);
}
}
/** Response from
* {@link org.apache.calcite.avatica.remote.Service.PrepareRequest}. */
class PrepareResponse extends Response {
public final Meta.StatementHandle statement;
@JsonCreator
public PrepareResponse(
@JsonProperty("statement") Meta.StatementHandle statement) {
this.statement = statement;
}
}
/** Request for
* {@link Meta#fetch(Meta.StatementHandle, List, long, int)}. */
class FetchRequest extends Request {
public final String connectionId;
public final int statementId;
public final long offset;
/** Maximum number of rows to be returned in the frame. Negative means no
* limit. */
public final int fetchMaxRowCount;
/** A list of parameter values, if statement is to be executed; otherwise
* null. */
public final List parameterValues;
@JsonCreator
public FetchRequest(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("statementId") int statementId,
@JsonProperty("parameterValues") List parameterValues,
@JsonProperty("offset") long offset,
@JsonProperty("fetchMaxRowCount") int fetchMaxRowCount) {
this.connectionId = connectionId;
this.statementId = statementId;
this.parameterValues = parameterValues;
this.offset = offset;
this.fetchMaxRowCount = fetchMaxRowCount;
}
@Override FetchResponse accept(Service service) {
return service.apply(this);
}
}
/** Response from
* {@link org.apache.calcite.avatica.remote.Service.FetchRequest}. */
class FetchResponse extends Response {
public final Meta.Frame frame;
@JsonCreator
public FetchResponse(@JsonProperty("frame") Meta.Frame frame) {
this.frame = frame;
}
}
/** Request for
* {@link org.apache.calcite.avatica.Meta#createStatement(org.apache.calcite.avatica.Meta.ConnectionHandle)}. */
class CreateStatementRequest extends Request {
public final String connectionId;
@JsonCreator
public CreateStatementRequest(
@JsonProperty("signature") String connectionId) {
this.connectionId = connectionId;
}
@Override CreateStatementResponse accept(Service service) {
return service.apply(this);
}
}
/** Response from
* {@link org.apache.calcite.avatica.remote.Service.CreateStatementRequest}. */
class CreateStatementResponse extends Response {
public final String connectionId;
public final int statementId;
@JsonCreator
public CreateStatementResponse(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("statementId") int statementId) {
this.connectionId = connectionId;
this.statementId = statementId;
}
}
/** Request for
* {@link org.apache.calcite.avatica.Meta#closeStatement(org.apache.calcite.avatica.Meta.StatementHandle)}. */
class CloseStatementRequest extends Request {
public final String connectionId;
public final int statementId;
@JsonCreator
public CloseStatementRequest(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("statementId") int statementId) {
this.connectionId = connectionId;
this.statementId = statementId;
}
@Override CloseStatementResponse accept(Service service) {
return service.apply(this);
}
}
/** Response from
* {@link org.apache.calcite.avatica.remote.Service.CloseStatementRequest}. */
class CloseStatementResponse extends Response {
@JsonCreator
public CloseStatementResponse() {}
}
/** Request for
* {@link Meta#closeConnection(org.apache.calcite.avatica.Meta.ConnectionHandle)}. */
class CloseConnectionRequest extends Request {
public final String connectionId;
@JsonCreator
public CloseConnectionRequest(
@JsonProperty("connectionId") String connectionId) {
this.connectionId = connectionId;
}
@Override CloseConnectionResponse accept(Service service) {
return service.apply(this);
}
}
/** Response from
* {@link org.apache.calcite.avatica.remote.Service.CloseConnectionRequest}. */
class CloseConnectionResponse extends Response {
@JsonCreator
public CloseConnectionResponse() {}
}
/** Request for {@link Meta#connectionSync(Meta.ConnectionHandle, Meta.ConnectionProperties)}. */
class ConnectionSyncRequest extends Request {
public final String connectionId;
public final Meta.ConnectionProperties connProps;
@JsonCreator
public ConnectionSyncRequest(
@JsonProperty("connectionId") String connectionId,
@JsonProperty("connProps") Meta.ConnectionProperties connProps) {
this.connectionId = connectionId;
this.connProps = connProps;
}
@Override ConnectionSyncResponse accept(Service service) {
return service.apply(this);
}
}
/** Response for
* {@link Meta#connectionSync(Meta.ConnectionHandle, Meta.ConnectionProperties)}. */
class ConnectionSyncResponse extends Response {
public final Meta.ConnectionProperties connProps;
@JsonCreator
public ConnectionSyncResponse(@JsonProperty("connProps") Meta.ConnectionProperties connProps) {
this.connProps = connProps;
}
}
/** Response for
* {@link Meta#getDatabaseProperties()}. */
class DatabasePropertyResponse extends Response {
public final Map map;
@JsonCreator
public DatabasePropertyResponse(@JsonProperty("map") Map map) {
this.map = map;
}
}
}
// End Service.java