Package org.firebirdsql.gds

This package contains classes defining Firebird API for Java language that applications can use to access databases directly without JDBC interfaces.

See: Description

Interface Summary

Interface	Description
BlobParameterBuffer	Instance of this interface represents a BLOB Parameter Buffer from the Firebird API documentation and specifies attributes for GDS.iscCreateBlob2(IscDbHandle, IscTrHandle, IscBlobHandle, BlobParameterBuffer) or GDS.iscOpenBlob2(IscDbHandle, IscTrHandle, IscBlobHandle, BlobParameterBuffer) operations.
DatabaseParameterBuffer	Instance of this interface represents a Database Parameter Buffer from the Firebird API documentation and specifies the attributes for the current connection.
EventHandle	Handle to internal event-handling structures.
EventHandler	A callback handler interface for GDS-based event handling.
GDS	The interface GDS has most of the C client interface functions lightly mapped to java, as well as the constants returned from the server.
IscBlobHandle	The interface IscBlobHandle is a java mapping for a blob handle..
ISCConstants	The interface GDS has most of the C client interface functions lightly mapped to java, as well as the constants returned from the server..
IscDbHandle	The interface isc_db_handle represents a socket connection to the database server.
IscStmtHandle	isc_stmt_handle describes a handle to a database statement.
IscSvcHandle	The interface isc_svc_handle is a java mapping for a isc_svc_handle handle.
IscTrHandle	The interface IscTrHandle represents a transaction handle.
ServiceParameterBuffer	Instance of this interface represents a Service Parameter Buffer from the Firebird API documentation and specifies the attributes for the Services API connection.
ServiceRequestBuffer	Instance of this interface represents a Service Request Buffer from the Firebird API documentation and specifies the attributes for the Services API operation.
TransactionParameterBuffer	Instances of this interface represent Transaction Parameter Buffer from the Firebird API.

Class Summary

Class	Description
ClassFactory	Returns classes either by the Class.forName method or by using an already cached instance.
GDSExceptionHelper	This class is supposed to return messages for the specified error code.
GDSExceptionHelper.GDSMessage	This class wraps message template obtained from isc_error_msg.properties file and allows to set parameters to the message.
GDSObjectFactory	Creates gds objects.
XSQLDA	The class XSQLDA is a java mapping of the XSQLDA server data structure used to represent one row for input and output.
XSQLVAR	The class XSQLDA is a java mapping of the XSQLVAR server data structure used to represent one column for input and output.

Exception Summary

Exception	Description
GDSException	A GDS-specific exception
GDSWarning	Subclass of GDSException to represent internal Jaybird warnings.

Package org.firebirdsql.gds Description

This package contains classes defining Firebird API for Java language that applications can use to access databases directly without JDBC interfaces. This is probably most efficient way to access the database, however also it is the most complicated one and requires deep knowledge of the Firebird API. For better understanding please refer to the "InterBase 6 API Guide" published by Borland and released together with the open-sourcing the InterBase code, a predecessor of Firebird.

All database related operations are performed by an instance of the org.firebirdsql.gds.GDS interface, which simultaneously acts as a factory for all needed data structures.

Each database operation defined in the org.firebirdsql.gds.GDS interface throws an instance of org.firebirdsql.gds.GDSException if database server returned an error for that operation. All constants needed by those operations are defined in a org.firebirdsql.gds.ISCConstants class and are duplicated in corresponding data structures.

Please refer to the documentation in the javadoc comments as well as to the source code for more information.