Package org.apache.calcite.avatica.remote
JDBC driver that uses remote procedure calls.
-
Interface Summary Interface Description AvaticaHttpClient An interface which defines how requests are sent to the Avatica server.AvaticaHttpClientFactory A factory for constructingAvaticaHttpClient's.Handler<T> API for text request-response calls to an Avatica server.HostnameVerificationConfigurable An interface to decorate anAvaticaHttpClientthat can support configuration on SSL hostname verification.KeyStoreConfigurable Allows a keystore (and keystorepassword, keypassword) to be provided to enable MTLS authenticationProtobufMeta An extension ofMetawhich allows for native processing of calls with the Protobuf API objects instead of the POJOS (to avoid object translation).ProtobufTranslation Generic interface to support parsing of serialized protocol buffers between client and server.Service API for request-response calls to an Avatica server.Service.Factory Factory that creates aService.TrustStoreConfigurable Allows a truststore (and password) to be provided to enable TLS authentication.UsernamePasswordAuthenticateable Interface that allows configuration of a username and password with some HTTP authentication. -
Class Summary Class Description AbstractHandler<T> Abstract base class forHandlers to extend to inherit functionality common across serialization strategies.AbstractService A common base class forServiceimplementations that implement modifications made to response objects.AvaticaCommonsHttpClientImpl A common class to invoke HTTP requests against the Avatica server agnostic of the data being sent and received across the wire.AvaticaCommonsHttpClientSpnegoImpl Implementation of an AvaticaHttpClient which uses SPNEGO.AvaticaCommonsHttpClientSpnegoImpl.EmptyCredentials A credentials implementation which returns null.AvaticaHttpClientFactoryImpl Default implementation ofAvaticaHttpClientFactorywhich chooses an implementation from a property.AvaticaHttpClientImpl A common class to invoke HTTP requests against the Avatica server agnostic of the data being sent and received across the wire.AvaticaRemoteConnectionConfigImpl Implementation ofConnectionConfigwith extra properties specific to Remote Driver.ClientKeytabJaasConf Javax Configuration class which always returns a configuration for our keytab-based login suitable for callers which are acting as initiators (e.g.DoAsAvaticaHttpClient HTTP client implementation which invokes the wrapped HTTP client in a doAs with the provided Subject.Driver Avatica Remote JDBC driver.Handler.HandlerResponse<T> Struct that encapsulates the context of the result of a request to Avatica.JsonHandler JsonService Implementation ofServicethat encodes requests and responses as JSON.KerberosConnection A utility to perform Kerberos logins and renewals.KerberosConnection.RenewalTask Runnable for performing Kerberos renewals.LocalJsonService Implementation ofServicethat goes to an in-process instance ofService.LocalProtobufService A Service implementation that performs protocol buffer serialization on request and responses on either side of computing a response from a request to mimic some transport to a server which would normally perform such computation.LocalService MetricsHelper A utility class to encapsulate common logic in use of metrics implementation.MockJsonService Mock implementation ofServicethat encodes its requests and responses as JSON and looks up responses from a pre-defined map.MockJsonService.Factory Factory that creates aMockJsonService.MockProtobufService A mock implementation of ProtobufService for testing.MockProtobufService.MockProtobufServiceFactory A factory that instantiates the mock protobuf service.ProtobufHandler Dispatches serialized protocol buffer messages to the providedServiceby converting them to the POJO Request.ProtobufService Service implementation that encodes requests and responses as protocol buffers.ProtobufTranslationImpl Implementation ofProtobufTranslationImplthat translates protobuf requests to POJO requests.ProtobufTranslationImpl.RequestTranslator Encapsulate the logic of transforming a protobuf Request message into the Avatica POJO request.ProtobufTranslationImpl.ResponseTranslator Encapsulate the logic of transforming a protobuf Response message into the Avatica POJO Response.RemoteMeta Implementation ofMetafor the remote driver.RemoteProtobufService ProtobufService implementation that queries against a remote implementation, using protocol buffers as the serialized form.RemoteService Implementation ofServicethat translates requests into JSON and sends them to a remote server, usually an HTTP server.Service.Base Base class for request and response.Service.CatalogsRequest Request forMeta.getCatalogs(Meta.ConnectionHandle).Service.CloseConnectionRequest Service.CloseConnectionResponse Response fromService.CloseConnectionRequest.Service.CloseStatementRequest Service.CloseStatementResponse Response fromService.CloseStatementRequest.Service.ColumnsRequest Service.CommitRequest An RPC request to invoke a commit on a Connection.Service.CommitResponse An RPC response from invoking commit on a Connection.Service.ConnectionSyncRequest Service.ConnectionSyncResponse Service.CreateStatementRequest Service.CreateStatementResponse Response fromService.CreateStatementRequest.Service.DatabasePropertyRequest Request forMeta.getDatabaseProperties(Meta.ConnectionHandle).Service.DatabasePropertyResponse Response forMeta.getDatabaseProperties(Meta.ConnectionHandle).Service.ErrorResponse Response for any request that the server failed to successfully perform.Service.ExecuteBatchRequest Request object to execute a batch of commands.Service.ExecuteBatchResponse Response object for executing a batch of commands.Service.ExecuteRequest Service.ExecuteResponse Response to aService.PrepareAndExecuteRequest.Service.FetchRequest Service.FetchResponse Response fromService.FetchRequest.Service.OpenConnectionRequest Service.OpenConnectionResponse Response fromService.OpenConnectionRequest.Service.PrepareAndExecuteBatchRequest Request to prepare a statement and execute a series of batch commands in one call.Service.PrepareAndExecuteRequest Service.PrepareRequest Request forMeta.prepare(Meta.ConnectionHandle, String, long).Service.PrepareResponse Response fromService.PrepareRequest.Service.Request Base class for all service request messages.Service.Response Base class for all service response messages.Service.ResultSetResponse Response that contains a result set.Service.RollbackRequest An RPC request to invoke a rollback on a Connection.Service.RollbackResponse An RPC response from invoking rollback on a Connection.Service.RpcMetadataResponse Response that includes information about the server that handled an RPC.Service.SchemasRequest Service.SyncResultsRequest Request forService.apply(SyncResultsRequest)Service.SyncResultsResponse Response forService.apply(SyncResultsRequest).Service.TablesRequest Service.TableTypesRequest Request forMeta.getTableTypes(Meta.ConnectionHandle).Service.TypeInfoRequest Request forMeta.getTypeInfo(Meta.ConnectionHandle).TypedValue Value and type. -
Enum Summary Enum Description AbstractService.SerializationType Represents the serialization of the data over a transport.AuthenticationType An enumeration for support types of authentication for the HttpServer.AvaticaRemoteConnectionProperty Enumeration of Avatica remote driver's built-in connection properties.Driver.Serialization Defines the method of message serialization used by the DriverHostnameVerificationConfigurable.HostnameVerification Describes the support hostname verification methods ofAvaticaHttpClient.MetaDataOperation Identifies an operation fromDatabaseMetaDatawhich returns aResultSet. -
Exception Summary Exception Description AvaticaRuntimeException ARuntimeExceptionthrown by Avatica with additional contextual information about what happened to cause the Exception.