All Classes and Interfaces
Class
Description
Abstract mutable implementation of
IAttachProperties
.Property update listener.
Abstract class with common logic for connections.
Abstract implementation of
FirebirdConnectionProperties
to ensure subclasses can be introspected as beans.Abstract implementation for event handle.
AbstractFbAttachment<T extends AbstractConnection<? extends IAttachProperties<?>,? extends FbAttachment>>
Common behavior for
AbstractFbService
and AbstractFbDatabase
.Base class for low-level blob operations.
State of the blob.
Abstract implementation of
FbDatabase
with behavior common to the various
implementations.Abstract service implementation.
Operation codes to open an input or output blob.
Abstract class for operations common to all version of the wire protocol implementation.
Abstract service implementation for the wire protocol.
Base class for
FBResultSetMetaData
and
FBParameterMetaData
for methods common to both implementations.Stores additional information about fields in a database.
A composite key for internal field mapping structures.
Abstract immutable implementation of
IAttachProperties
.Dispatcher to maintain a list of listeners of type
L
.AbstractParameterConverter<D extends AbstractConnection<IConnectionProperties,?>,S extends AbstractConnection<IServiceProperties,?>>
Abstract class for behavior common to
ParameterConverter
implementations.Abstract class to simplify implementation of
ProtocolDescriptor
Base class for SRP authentication plugin providers.
Common abstract base class for statement implementations.
ARC4 encryption plugin (the wire encryption provided out-of-the-box in Firebird 3).
ARC4 encryption plugin provider.
Base class for arguments to the parameter buffer.
Argument metadata type.
Asynchronous fetch status.
Signals an async fetch which completed with an exception.
Signals no async fetch pending.
Signals an async fetch pending.
Listener interface for events on the asynchronous channel.
Event count notification
Dispatcher for
AsynchronousChannelListener
.Process asynchronous channels for notification of events.
Attachment properties shared by database and service connections.
Plugin for Firebird authentication.
Status of authentication.
Registry of authentication plugins.
Service provider interface for authentication plugins.
Implements the backup and restore functionality of Firebird Services API.
Base class for
GDSFactoryPlugin
implementations.Base of the properties hierarchy; provides common API for setting properties by name.
Completion data from a batch execute.
Data from the
WireProtocolConstants.op_batch_cs
response.Constants for batch items and values (batch config, blob policy and information items).
Represents a batch parameter buffer, for Firebird 4 and higher batch configuration.
Batch parameter buffer implementation.
Argument
implementation for bigint (long) values.Firebird configuration for a blob.
Blob information processor for retrieving blob length.
Field which expects a blob listener.
Instance of this interface represents a BLOB Parameter Buffer from the
Firebird API documentation and specifies attributes for
FbDatabase.createBlobForOutput(org.firebirdsql.gds.ng.FbTransaction, BlobParameterBuffer)
or
FbDatabase.createBlobForInput(org.firebirdsql.gds.ng.FbTransaction, BlobParameterBuffer, long)
operations.Implementation of BlobParameterBuffer.
Interface for calculating the blr (binary language representation) of a row.
Constants for the blr.
Constants for BPB (blob parameter buffer) items.
Constants for values of
BpbItems.isc_bpb_type
.Argument
implementation for byte values.Argument
implementation for byte arrays.Helper methods for byte arrays.
Metadata information related to catalogs.
ChaCha (ChaCha-20) encryption plugin (introduced in Firebird 4.0).
ChaCha (ChaCha-20) encryption plugin provider.
Condition clause for constructing metadata query conditions.
Factory for
Cleaner
for use within Jaybird.Manages client authentication with multiple pluginProviders.
Reader for clumplets, similar to the implementation of
ClumpletReader.cpp
in Firebird.Helper class for collections
Reasons for statement (or other resources) completion.
Helpers for conditional behaviour and conditional expressions.
A Jaybird connection property.
Service provider interface to define connection properties in Jaybird.
Registry of connection properties available to Jaybird.
Basic connection property types supported by Jaybird.
Details of the connection, which the SPI can use to decide if they can work.
Interface for the encryption/decryption session config for wire protocol encryption for a specific plugin.
Cursor flags.
Properties for database connections.
An interface for retrieving information about events that have occurred
Listener for database events.
Dispatcher to maintain and notify other
DatabaseListener
.Instance of this interface represents a Database Parameter Buffer from the
Firebird API documentation and specifies the attributes for the
current connection.
Implementation for DatabaseParameterBuffer.
ObjectFactory for the DataSources in org.firebirdsql.ds.
Interface defining the encoding and decoding for Firebird (numerical) data types.
Container for attachment information (i.e.
Plugin for Firebird database encryption callback.
Service provider interface for database encryption callback plugins.
Data of a database encryption key callback (or reply).
Provides access to the database connection for executing database metadata queries.
Holder class for query text and parameters.
Abstract base class for IEEE-754 decimals.
An IEEE-754 Decimal128.
An IEEE-754 Decimal32.
An IEEE-754 Decimal64.
Thrown to indicate a decimal value could not be converted to a target type (usually
BigDecimal
).Exception thrown to indicate a coefficient or exponent overflow or underflow.
Type of decimal.
Default BLR calculator for the wire protocol.
The default datatype coder.
Definition of a Firebird encoding.
The default encoding set for Jaybird.
Interface for processing deferred responses from the server.
Interface for receiving deferred/async responses.
Provides conversion between Densely Packed Decimal encoding and
BigInteger
.Constants for DPB (database parameter buffer) items.
Identifies the database (or service attach) parameter buffer type of a connection property.
Encoding translates between a Java string and a byte array for a specific (Firebird) encoding.
Definition of a Firebird encoding.
Factory for
EncodingDefinition
and Encoding
.EncodingSet
is an interface for the purpose of loading EncodingDefinition
mappings into Jaybird.Datatype coder wrapping another datatype coder and applying a specific encoding definition, while delegating other
methods to the wrapped datatype coder.
Identifier of an encryption type + plugin.
The initial initialization information of an encryption plugin.
Plugin for Firebird wire encryption.
Registry of encryption plugins.
Service provider interface for wire encryption plugins.
Handle to internal event-handling structures.
A callback handler interface for event handling.
An interface for callbacks in response to Firebird events
An interface for registering
EventListener
instances to listen for database events.Helpers for exception handling
Provides notification of exceptions to
ExceptionListener
instance.Listener for notifications of SQL Exceptions that occurred in the object listened on.
Listener dispatcher for
ExceptionListener
.InfoProcessor to retrieve the (normal) execution plan of a statement.
Helper class for the exception handling in XCA framework.
Abstract class for properties and behaviour common to DataSources, XADataSources and ConnectionPoolDataSources
Connection to a Firebird server (to a database or service).
Implements the backup and restore functionality of Firebird Services API.
Implements the common functionality between regular and streaming backup/restore
Structure that holds path to the database and corresponding size of the file (in case of backup - that is
size of the file in megabytes, in case of restore - size of the database file in pages).
Configuration for a Firebird 4+ batch.
Class to provide an immutable copy of a batch config.
Interface for blob operations.
Firebird implementation of
Blob
.Standard configuration for blobs.
Seek mode for
FbBlob.seek(int, org.firebirdsql.gds.ng.FbBlob.SeekMode)
.An input stream for reading directly from a FBBlob instance.
OutputStream
for writing Firebird blobs.This class represents a cached blob field.
Clob implementation that is cached client-side.
Implementation of
CallableStatement
.Implementation of
Clob
.Instances of this field have open resources and must be cleaned up.
FBCommandLine
Bare-bones implementation of
ConnectionPoolDataSource
.Mutable implementation of
IConnectionProperties
The class
FBConnectionRequestInfo
holds connection-specific information such as user, password, and other
information.Connection handle to a database.
Factory for
FbDatabase
instances.Comprehensive information about the database as a whole.
The class
FBDataSource
is a ConnectionFactory for jdbc Connection objects.Helpers and classes for Firebird/Jaybird datetime handling.
The Jaybird JDBC Driver implementation for the Firebird database.
Tell that driver is not able to serve the request due to missing capabilities.
Parser for escaped procedure call.
Helper class for escaped functions.
The class
FBEscapedParser
parses the SQL and converts escaped syntax to native form.An
EventManager
implementation to listen for database events.Builder for exceptions received from Firebird.
Instances of this interface fetch records from the server.
Base class for fields (for use by prepared statement and result set to represent columns and parameters).
Instances of this field cache data in auto-commit case if no transaction is
yet available and must be flushed before transaction is committed.
Immutable implementation of
IConnectionProperties
.Immutable implementation of
IServiceProperties
.This error is thrown when message read from the RDB$TRANSACTIONS table does not represent a serialized Xid.
The class
FBLocalTransaction
represent a local, not distributed, transaction.This is Blob-based implementation of
FBStringField
.The
FBMaintenanceManager
class is responsible for replicating the functionality provided by
the gfix
command-line tool.A physical connection handle to a Firebird database, providing a
XAResource
.FBManagedConnectionFactory is a factory for
FBManagedConnection
, and implements many of the internal
functions of FBManagedConnection.A tool for creating and dropping databases.
API for
FBManager
, for creating and dropping databases.Constants for metadata as used in the Firebird metadata tables
DatabaseMetaData
implementation.Implements the incremental backup and restore functionality of NBackup via the Firebird Services API.
Defines a set of listeners that will be called in different situations.
Listener for the events generated by BLOBs.
Implementation of
FBObjectListener.BlobListener
that does nothing.Implementation of
FBObjectListener.FetcherListener
that does nothing.Implementation of
FBObjectListener.ResultSetListener
that does nothing.Listener for the events generated by the result set.
Listener for the events generated by statements.
An object that can be used to get information about the types and properties for each parameter marker in a
PreparedStatement
object.Implementation of
PreparedStatement
.Represents procedure call.
Represents procedure call parameter.
Implementation of
ResultSet
.Information about the types and properties of the columns in a
ResultSet
object.Exception is thrown when trying to modify the non-updatable result set.
Firebird row-id.
Savepoint implementation.
Connection handle to a service.
An implementation of the basic Firebird Service API functionality.
Mutable implementation of
IServiceProperties
.This is a simple implementation of
DataSource
interface.Exception that indicates encryption could not be initialized.
Deprecated, for removal: This API element is subject to removal in a future version.
Unused, will be removed in Jaybird 7
Subclass of SQLException whose only purpose is to preserve the information provided by the status vector when an
exception is created using
FbExceptionBuilder.toFlatSQLException()
.This exception is thrown by FBEscapedParser when it cannot parse the
escaped syntax.
API for statement handles.
Implementation of
Statement
.The current result of a statement.
The
FBStatisticsManager
class is responsible for replicating the functionality of
the gstat
command-line tool.Implements the streaming version of the backup and restore functionality of
Firebird Services API.
Provides access to the table statistics of a
Connection
.This class provides mapping capabilities between standard JDBC transaction isolation level and Firebird Transaction
Parameters Blocks (TPBs).
Implements the Trace/Audit API available new in Firebird 2.5
Handle for a transaction.
Deprecated.
Use the SQL user management statements instead, we currently do not plan to remove this API
Deprecated.
Use the SQL user management statements instead, we currently do not plan to remove this API
Interface for the asynchronous channel used for event notification.
Struct-like class, reduced equivalent of Firebird p_acpd to store data for handling op_cond_accept.
Implementation of
FbDatabaseFactory
for the wire protocol implementation.Common connection operations shared by database and service handles
Interface for Statements created for the wire protocol implementation.
Interface for transactions created for the wire protocol implementation.
XAConnection implementation for
FBXADataSource
Bare-bones implementation of
XADataSource
.Convenience exception that adds constructor taking message and error code together.
Fetch configuration values.
Direction of fetch.
Type of fetch.
Provider of the row data.
The class
FieldDescriptor
contains the column metadata of the XSQLVAR server
data structure used to describe one column for input or output.Firebird Blob abstraction.
Blob input stream.
Blob output stream.
Firebird extension to the
CallableStatement
interface.Firebird Clob abstraction.
Extension of
Connection
interface providing access to Firebird specific features.Connection properties for the Firebird connection.
Extension of
DatabaseMetaData
interface providing access to Firebird
specific features.Extension of
Driver
for Jaybird.Firebird extension to the
ParameterMetaData
interface.Firebird extensions to the
PreparedStatement
interface.All reserved words per Firebird version.
Firebird-specific extensions to the
ResultSet
interface.Firebird-specific extensions to the
ResultSetMetaData
interface.Firebird-specific extensions to the
RowId
interface.Interface for the clean separation of the classes between result set and corresponding row updater.
Firebird-specific extensions to the
Savepoint
interface.Firebird-specific extensions to the
Statement
interface.Helper class that reports if a Firebird version supports a specific feature.
Deprecated, for removal: This API element is subject to removal in a future version.
Use a normal SQLException or subclass, this class may be removed in Jaybird 7 or later
The class
GDSFactory
exists to provide a way to obtain objects
implementing GDS and Clumplet.SPI interface to define JDBC protocol implementations for Jaybird.
Helper class for all GDS-related operations.
Object representing a Firebird server version.
Exception is thrown when server returns a version string in a format that this driver does not understand.
Type-safe "enumeration" of the GDS types registered in the system.
Provides the implementation of
DatabaseMetaData.getAttributes(String, String, String, String)
.Provides the implementation of
DatabaseMetaData.getBestRowIdentifier(String, String, String, int, boolean)
.Provides the implementation of
DatabaseMetaData.getCatalogs()
.Provides the implementation of
DatabaseMetaData.getClientInfoProperties()
.Provides the implementation of
DatabaseMetaData.getColumnPrivileges(String, String, String, String)
.Provides the implementation of
DatabaseMetaData.getColumns(String, String, String, String)
.Provides the implementation for
DatabaseMetaData.getCrossReference(String, String, String, String, String, String)
.Provides the implementation for
DatabaseMetaData.getExportedKeys(String, String, String)
.Provides the implementation for
DatabaseMetaData.getFunctionColumns(String, String, String, String)
.Provides the implementation for
DatabaseMetaData.getFunctions(String, String, String)
.Provides the implementation for
DatabaseMetaData.getImportedKeys(String, String, String)
.Provides the implementation of
DatabaseMetaData.getIndexInfo(String, String, String, boolean, boolean)
.Provides the implementation for
DatabaseMetaData.getPrimaryKeys(String, String, String)
.Provides the implementation for
DatabaseMetaData.getProcedureColumns(String, String, String, String)
.Provides the implementation of
DatabaseMetaData.getProcedures(String, String, String)
.Provides the implementation of
DatabaseMetaData.getPseudoColumns(String, String, String, String)
.Provides the implementation of
DatabaseMetaData.getSchemas(String, String)
.Provides the implementation of
DatabaseMetaData.getSuperTables(String, String, String)
.Provides the implementation of
DatabaseMetaData.getSuperTypes(String, String, String)
.Provides the implementation of
DatabaseMetaData.getTablePrivileges(String, String, String)
.Provides the implementation for
DatabaseMetaData.getTables(String, String, String, String[])
,
DatabaseMetaData.getTableTypes()
and
FirebirdDatabaseMetaData.getTableTypeNames()
Provides the implementation for
DatabaseMetaData.getTypeInfo()
.Provides the implementation of
DatabaseMetaData.getUDTs(String, String, String, int[])
.Common properties for database and service attach.
Connection properties for the Firebird connection.
Interface for the EncodingFactory.
Functional interface to process an information buffer (responses to p_info_* requests) returning an object of type T.
Interface for information on a statement.
Thrown to indicate that an info request buffer was truncated (
isc_info_truncated
).Indicates that the annotated package, class, method or value is for internal use only.
Transaction coordinator for the
FBConnection
class.Transaction coordinator base implementation.
Exception thrown when a connection property has an invalid value.
Utility methods for stream and byte array conversions.
Constants for Firebird features, parameter blocks and errors.
Connection properties for a Firebird service attachment.
String constants of the Java type names used in metadata and field access.
Constants for Jaybird specific error codes.
Class to access Jaybird-specific system properties from a single place.
SQLType
definitions specific to Jaybird.Type codes specific for Jaybird.
Helper class to convert from Firebird and metadata type information to JDBC type information.
Class to hold server keys known to the client.
Class to hold plugin specific data.
Legacy authentication plugin service provider.
Implements the one way password hash used by the legacy authentication of Firebird.
Class of
LocalStatementType
.Statement types.
Unlocks the lock on
LockCloseable.close()
, intended for use with try-with-resources.A
MaintenanceManager
is responsible for replicating the
functionality provided by the gfix
command-line tool.Message template for Firebird and Jaybird parameterized error messages.
Holder of a database metadata pattern.
Emulates behavior of a database metadata pattern.
Implements the incremental backup and restore functionality of NBackup
via the Firebird Services API.
Argument
implementation for numeric (integer) valuesHelper for numeric values.
Value class representing the Firebird On-Disk Structure (ODS) version.
An operation of the driver.
Type of operation.
Allows monitoring of driver operations like the execution of statements.
Close handle for
Operation
implementations.The statement operation monitor allows monitoring of statement execution and fetching of all statements.
How to handle overflows when rounding (converting) to a target decimal type.
Constants for page size supported by Firebird.
Interface for parameters stored in a
ParameterBuffer
.Instance of this interface represents a Parameter Buffer it is extended by various parameter buffer interfaces.
Base class for parameter buffers
Additional metadata for parameter buffer behavior.
ParameterConverter<D extends AbstractConnection<IConnectionProperties,?>,S extends AbstractConnection<IServiceProperties,?>>
Provides conversion of parameters (e.g.
Mapping of connection parameter buffer item tags.
Helper methods for loading plugins using
ServiceLoader
.Sources for loading classes (determines which class loaders to use)
Helper methods for conversion to or from primitive values.
Maps Firebird privilege codes (from
RDB$USER_PRIVILEGES.RDB$PRIVILEGE
) to a privilege name.Property constants.
Property names and aliases used by Jaybird.
Collection of protocols for a connect request.
Descriptor of protocol information.
Strategy for quoting object names and literals (or no quoting of object names in the case of dialect 1).
Class containing static helper methods for reflective access.
Interface for reserved words checks.
Aggregate type for result set behavior and logic for deriving supported combinations of type, concurrency and
holdability.
Root superclass for the datasources in Firebird.
The class
RowDescriptor
is a java mapping of the XSQLDA server data structure used to describe the row
metadata of one row for input or output.Builder to construct an immutable
RowDescriptor
.Collection of values of fields.
Properties for services.
Listener for service events.
The base Firebird Service API functionality.
Instance of this interface represents a Service Parameter Buffer from the
Firebird API documentation and specifies the attributes for the Services API
connection.
Implementation of ServiceParameterBuffer.
Instance of this interface represents a Service Request Buffer from the
Firebird API documentation and specifies the attributes for the Services API
operation.
Implementation of ServiceRequestBufferImp.
Signum constants used in decimal-java
Argument
implementation for items without a value.Constants for SPB (service parameter buffer) items.
Class for holding the SQL counts (update, delete, select, insert) for a statement execution.
Info processor for retrieving affected record count.
Helper class for building
SQLException
chains.Function that can throw a
SQLException
.Simple visiting SQL parser.
Constants with common SQLState values.
Converts a SQL statement into tokens.
Srp224 authentication plugin service provider.
Srp256 authentication plugin service provider.
Srp384 authentication plugin service provider.
Srp512 authentication plugin service provider.
Srp (Srp using SHA-1) authentication plugin service provider.
SRP client handshake implementation.
Constants for standard Firebird blob subtypes.
Detects the type of statement, and - optionally - whether a DML statement has a
RETURNING
clause.Statement type identification.
InfoProcessor to retrieve the statement information associated with
AbstractFbStatement.getStatementInfoRequestItems()
and AbstractFbStatement.getParameterDescriptionInfoRequestItems()
.Listener interface for receiving rows and related information as retrieved by
an
FbStatement.fetchRows(int)
, or
FbStatement.execute(RowValue)
with a singleton result.Dispatcher to maintain and notify other
StatementListener
.Statement states for
FbStatement
implementationsFirebird statement types.
Simple database encryption callback, provides a static value response to the callback
Provider for a static value response database encryption callback.
A
StatisticsManager
is responsible for replicating the functionality of the gstat
command-line tool.Meta-information on stored procedures in a Firebird database.
Argument
implementation for String valuesHelper class for string operations
Snapshot of the table statistics of a connection (of the table reported by
tableName
).Datatype coder for
TIME WITH TIME ZONE
and TIMESTAMP WITH TIME ZONE
.Simpler API for encoding or decoding
java.time
types.Mapping of Firebird time zone ids.
A token is an individual element of a SQL statement.
Visitor for tokens.
Constants for TPB (transaction parameter buffer) items.
Implements the Trace/Audit API available new in Firebird 2.5.
Class with static helper methods for use with transactions
Dispatcher to maintain and notify other
TransactionListener
.Mapping of transaction names to JDBC transaction code and vice versa.
Instances of this interface represent Transaction Parameter Buffer from the Firebird API.
Implementation of the
TransactionParameterBuffer
interface.Transactions states.
Trim behaviour of
getString
in string fields.This exception is thrown when the requested type conversion cannot be
performed.
Argument with an argument type.
Helper class to determine type metadata conforming to expectations of
DatabaseMetaData
.Wraps a
SQLException
with an unchecked exception.Thrown when the tokenizer required a character, but instead the end of input was reached.
Deprecated.
Use the SQL user management statements instead, we currently do not plan to remove this API
Deprecated.
Use the SQL user management statements instead, we currently do not plan to remove this API
Asynchronous channel implementation for the V10 wire protocol.
FbWireDatabase
implementation for the version 10 wire protocol.Input
FbWireBlob
implementation for the version 10 wire protocol.Output
FbWireBlob
implementation for the version 10 wire protocol.Implementation of
ParameterConverter
for the version 10 protocol.FbWireService
implementation for the V10 wire protocolFbWireStatement
implementation for the version 10 wire protocol.FbTransaction
implementation for the version 10 wire protocol.FbWireDatabase
implementation for the version 11 wire protocol.Input
FbWireBlob
implementation for the version 11 wire protocol.Output
FbWireBlob
implementation for the version 11 wire protocol.Implementation of
ParameterConverter
for the version 11 protocol.FbWireStatement
implementation for the version 11 wire protocol.FbWireDatabase
implementation for the version 12 wire protocol.Implementation of
ParameterConverter
for the version 12 protocol.FbWireDatabase
implementation for the version 13 wire protocol.Implementation of
ParameterConverter
for the version 13 protocol.FbWireDatabase
implementation for the version 15 wire protocol.FbWireDatabase
implementation for the version 16 wire protocol.FbWireDatabase
implementation for the version 18 wire protocol.Helper methods for decoding Vax style (little endian) integers as used by Firebird from byte arrays.
Class to access information from
org/firebirdsql/jaybird/version.properties
.The
ProtocolDescriptor
for the Firebird version 10 protocol.The
ProtocolDescriptor
for the Firebird version 11 protocol.The
ProtocolDescriptor
for the Firebird version 12 protocol.The
ProtocolDescriptor
for the Firebird version 13 protocol.The
ProtocolDescriptor
for the Firebird version 15 protocol.The
ProtocolDescriptor
for the Firebird version 16 protocol.The
ProtocolDescriptor
for the Firebird version 18 protocol.Registrar for visitors that allows runtime removal or addition of visitors.
Indicates that the annotated class, method or value is volatile, and may change in a next version.
Callback interface for passing warnings.
Class managing the TCP/IP connection and initial handshaking with the Firebird server.
Wire connection instance for connecting to a database
Event handle for the wire protocol.
Constants for wire protocol operations and messages.
Wire connection instance for connecting to a service.
The
XcaConnectionEvent
class provides information about the source of a connection related event.Listener to receives notification of events on a managed connection instance.
The
XcaConnectionManager
can be used to modify the configuration of a connection, provide pooling or other
behaviour when allocating a new connection.The interface
Xdrable
represents an object that can read
and write itself from a strean in the xdr format used by the firebird
engine.An input stream for reading in data that is in the XDR format.
An
XdrOutputStream
writes data in XDR format to an underlying java.io.OutputStream
.Provides access to the
XdrInputStream
and XdrOutputStream
.