Class AbstractFbWireDatabase
- java.lang.Object
-
- org.firebirdsql.gds.ng.AbstractFbAttachment<T>
-
- org.firebirdsql.gds.ng.AbstractFbDatabase<WireDatabaseConnection>
-
- org.firebirdsql.gds.ng.wire.AbstractFbWireDatabase
-
- All Implemented Interfaces:
java.lang.AutoCloseable,FbAttachment,FbDatabase,ExceptionListenable,TransactionListener,FbWireAttachment,FbWireDatabase
- Direct Known Subclasses:
V10Database
public abstract class AbstractFbWireDatabase extends AbstractFbDatabase<WireDatabaseConnection> implements FbWireDatabase
Abstract class for operations common to all version of the wire protocol implementation.- Since:
- 3.0
- Author:
- Mark Rotteveel
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.firebirdsql.gds.ng.wire.FbWireAttachment
FbWireAttachment.AcceptPacket
-
-
Field Summary
Fields Modifier and Type Field Description protected ProtocolDescriptorprotocolDescriptorprotected FbWireOperationswireOperations-
Fields inherited from class org.firebirdsql.gds.ng.AbstractFbDatabase
databaseListenerDispatcher
-
Fields inherited from class org.firebirdsql.gds.ng.AbstractFbAttachment
connection, exceptionListenerDispatcher
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractFbWireDatabase(WireDatabaseConnection connection, ProtocolDescriptor descriptor)Creates an AbstractFbWireDatabase instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidcancelEvent(EventHandle eventHandle)Cancels a registered event.protected voidcheckAttached()Checks if a physical connection to the server is established and if the connection is attached to a database.protected voidcheckConnected()Checks if a physical connection to the server is established.protected voidcloseConnection()Closes the WireConnection associated with this connection.voidconsumePackets(int numberOfResponses, WarningMessageCallback warningCallback)Consumes packets notifying for warnings, but ignoring exceptions thrown from the packet.voidcountEvents(EventHandle eventHandle)Counts the events occurred.FbBlobcreateBlobForInput(FbTransaction transaction, BlobParameterBuffer blobParameterBuffer, long blobId)Creates a blob for read access to an existing blob on the server.FbBlobcreateBlobForOutput(FbTransaction transaction, BlobParameterBuffer blobParameterBuffer)Creates a blob for write access to a new blob on the server.EventHandlecreateEventHandle(java.lang.String eventName, EventHandler eventHandler)Creates an event handle for this database type.voidenqueueDeferredAction(DeferredAction deferredAction)Enqueue a deferred action.protected voidfinalize()voidforceClose()Forces the connection to close without proper detach or cleanup.byte[]getDatabaseInfo(byte[] requestItems, int maxBufferLength)Performs a database info request.intgetHandle()byte[]getInfo(int operation, int handle, byte[] requestItems, int maxBufferLength, WarningMessageCallback warningMessageCallback)Generic info request.protected XdrInputStreamgetXdrIn()Gets the XdrInputStream.protected XdrOutputStreamgetXdrOut()Gets the XdrOutputStream.XdrStreamAccessgetXdrStreamAccess()abstract FbWireAsynchronousChannelinitAsynchronousChannel()Initializes the asynchronous channel (for event notification).booleanisAttached()Current attachment status.voidqueueEvent(EventHandle eventHandle)Queues a wait for an event.GenericResponsereadGenericResponse(WarningMessageCallback warningCallback)Convenience method to read a Response to a GenericResponseResponsereadResponse(WarningMessageCallback warningCallback)Reads the response from the server.SqlResponsereadSqlResponse(WarningMessageCallback warningCallback)Convenience method to read a Response to a SqlResponsevoidsetNetworkTimeout(int milliseconds)Sets the network timeout for this attachment.-
Methods inherited from class org.firebirdsql.gds.ng.AbstractFbDatabase
addDatabaseListener, addWeakDatabaseListener, close, createBlobParameterBuffer, createTransactionParameterBuffer, emptyRowDescriptor, getActiveTransactionCount, getConnectionDialect, getConnectionProperties, getDatabaseDialect, getDatabaseInfo, getDatabaseInformationProcessor, getDatabaseWarningCallback, getDescribeDatabaseInfoBlock, getOdsMajor, getOdsMinor, getParameterDescriptionInfoRequestItems, getStatementInfoRequestItems, internalDetach, removeDatabaseListener, setDatabaseDialect, setOdsMajor, setOdsMinor, transactionAdded, transactionStateChanged
-
Methods inherited from class org.firebirdsql.gds.ng.AbstractFbAttachment
addExceptionListener, getDatatypeCoder, getEncoding, getEncodingFactory, getNetworkTimeout, getServerVersion, getServerVersionInformation, isLockedByCurrentThread, removeExceptionListener, safelyDetach, setAttached, setDetached, setServerVersion, withLock
-
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.firebirdsql.gds.ng.listeners.ExceptionListenable
addExceptionListener, removeExceptionListener
-
Methods inherited from interface org.firebirdsql.gds.ng.FbAttachment
attach, close, getDatatypeCoder, getEncoding, getEncodingFactory, getNetworkTimeout, getServerVersion, isLockedByCurrentThread, withLock
-
Methods inherited from interface org.firebirdsql.gds.ng.FbDatabase
addDatabaseListener, addWeakDatabaseListener, cancelOperation, createBlobForInput, createBlobForInput, createBlobForOutput, createBlobForOutput, createBlobParameterBuffer, createDatabase, createStatement, createTransactionParameterBuffer, dropDatabase, emptyRowDescriptor, executeImmediate, getConnectionDialect, getConnectionProperties, getDatabaseDialect, getDatabaseInfo, getOdsMajor, getOdsMinor, reconnectTransaction, removeDatabaseListener, startTransaction
-
Methods inherited from interface org.firebirdsql.gds.ng.wire.FbWireAttachment
authReceiveResponse
-
Methods inherited from interface org.firebirdsql.gds.ng.wire.FbWireDatabase
getBlrCalculator, releaseObject
-
-
-
-
Field Detail
-
protocolDescriptor
protected final ProtocolDescriptor protocolDescriptor
-
wireOperations
protected final FbWireOperations wireOperations
-
-
Constructor Detail
-
AbstractFbWireDatabase
protected AbstractFbWireDatabase(WireDatabaseConnection connection, ProtocolDescriptor descriptor)
Creates an AbstractFbWireDatabase instance.- Parameters:
connection- A WireConnection with an established connection to the server.descriptor- The ProtocolDescriptor that created this connection (this is used for creating further dependent objects).
-
-
Method Detail
-
getHandle
public final int getHandle()
- Specified by:
getHandlein interfaceFbAttachment- Specified by:
getHandlein interfaceFbDatabase- Returns:
- The database handle value
-
forceClose
public void forceClose() throws java.sql.SQLExceptionDescription copied from class:AbstractFbAttachmentForces the connection to close without proper detach or cleanup.If a given implementation does not support this, then this method should call
FbAttachment.close().Default implementation, calls
FbAttachment.close()- Specified by:
forceClosein interfaceFbAttachment- Overrides:
forceClosein classAbstractFbAttachment<WireDatabaseConnection>- Throws:
java.sql.SQLException- For problems closing the connection.
-
getXdrIn
protected final XdrInputStream getXdrIn() throws java.sql.SQLException
Gets the XdrInputStream.- Returns:
- Instance of XdrInputStream
- Throws:
java.sql.SQLException- If no connection is opened or when exceptions occur retrieving the InputStream
-
getXdrOut
protected final XdrOutputStream getXdrOut() throws java.sql.SQLException
Gets the XdrOutputStream.- Returns:
- Instance of XdrOutputStream
- Throws:
java.sql.SQLException- If no connection is opened or when exceptions occur retrieving the OutputStream
-
getXdrStreamAccess
public final XdrStreamAccess getXdrStreamAccess()
- Specified by:
getXdrStreamAccessin interfaceFbWireAttachment- Returns:
- Instance of
XdrStreamAccessfor this attachment.
-
isAttached
public final boolean isAttached()
Description copied from interface:FbAttachmentCurrent attachment status.- Specified by:
isAttachedin interfaceFbAttachment- Overrides:
isAttachedin classAbstractFbAttachment<WireDatabaseConnection>- Returns:
trueif connected to the server and attached to a database or service,falseotherwise.
-
checkConnected
protected final void checkConnected() throws java.sql.SQLExceptionChecks if a physical connection to the server is established.- Specified by:
checkConnectedin classAbstractFbAttachment<WireDatabaseConnection>- Throws:
java.sql.SQLException- If not connected.
-
checkAttached
protected final void checkAttached() throws java.sql.SQLExceptionChecks if a physical connection to the server is established and if the connection is attached to a database.This method calls
checkConnected(), so it is not necessary to call both.- Throws:
java.sql.SQLException- If the database not connected or attached.
-
closeConnection
protected final void closeConnection() throws java.io.IOExceptionCloses the WireConnection associated with this connection.- Throws:
java.io.IOException- For errors closing the connection.
-
setNetworkTimeout
public void setNetworkTimeout(int milliseconds) throws java.sql.SQLExceptionDescription copied from interface:FbAttachmentSets the network timeout for this attachment.- Specified by:
setNetworkTimeoutin interfaceFbAttachment- Parameters:
milliseconds- Timeout in milliseconds; 0 means no timeout. If the attachment doesn't support milliseconds, it should round up to the nearest second.- Throws:
java.sql.SQLException- If this attachment is closed, the value ofmillisecondsis smaller than 0, or if setting the timeout fails.java.sql.SQLFeatureNotSupportedException- If this attachment doesn't support (changing) the network timeout.
-
createBlobForOutput
public final FbBlob createBlobForOutput(FbTransaction transaction, BlobParameterBuffer blobParameterBuffer)
Description copied from interface:FbDatabaseCreates a blob for write access to a new blob on the server.The blob is initially closed.
- Specified by:
createBlobForOutputin interfaceFbDatabase- Parameters:
transaction- transaction associated with the blobblobParameterBuffer- blob parameter buffer- Returns:
- instance of
FbBlob
-
createBlobForInput
public final FbBlob createBlobForInput(FbTransaction transaction, BlobParameterBuffer blobParameterBuffer, long blobId)
Description copied from interface:FbDatabaseCreates a blob for read access to an existing blob on the server.The blob is initially closed.
- Specified by:
createBlobForInputin interfaceFbDatabase- Parameters:
transaction- transaction associated with the blobblobParameterBuffer- blob parameter bufferblobId- id of the blob- Returns:
- instance of
FbBlob
-
consumePackets
public final void consumePackets(int numberOfResponses, WarningMessageCallback warningCallback)Description copied from interface:FbWireDatabaseConsumes packets notifying for warnings, but ignoring exceptions thrown from the packet.This method should only be used inside the implementation if either packets need to be ignored, or to ensure that there is no backlog of packets (eg when an exception occurs during processing of multiple package responses).
- Specified by:
consumePacketsin interfaceFbWireDatabase- Parameters:
numberOfResponses- Number of responses to consume.warningCallback- Callback for warnings
-
readGenericResponse
public final GenericResponse readGenericResponse(WarningMessageCallback warningCallback) throws java.sql.SQLException, java.io.IOException
Description copied from interface:FbWireAttachmentConvenience method to read a Response to a GenericResponse- Specified by:
readGenericResponsein interfaceFbWireAttachment- Parameters:
warningCallback- Callback object for warnings,nullfor default callback- Returns:
- GenericResponse
- Throws:
java.sql.SQLException- For errors returned from the server, or when attempting to read.java.io.IOException- For errors reading the response from the connection.
-
readSqlResponse
public final SqlResponse readSqlResponse(WarningMessageCallback warningCallback) throws java.sql.SQLException, java.io.IOException
Description copied from interface:FbWireDatabaseConvenience method to read a Response to a SqlResponse- Specified by:
readSqlResponsein interfaceFbWireDatabase- Parameters:
warningCallback- Callback object for warnings,nullfor default callback- Returns:
- SqlResponse
- Throws:
java.sql.SQLException- For errors returned from the server, or when attempting to read.java.io.IOException- For errors reading the response from the connection.
-
readResponse
public final Response readResponse(WarningMessageCallback warningCallback) throws java.sql.SQLException, java.io.IOException
Description copied from interface:FbWireDatabaseReads the response from the server.- Specified by:
readResponsein interfaceFbWireDatabase- Parameters:
warningCallback- Callback object for warnings,nullfor default callback- Returns:
Responseread.- Throws:
java.sql.SQLException- For errors returned from the server, or when attempting to readjava.io.IOException- For errors reading the response from the connection.
-
enqueueDeferredAction
public final void enqueueDeferredAction(DeferredAction deferredAction)
Description copied from interface:FbWireDatabaseEnqueue a deferred action.FbDatabase implementations that do not support deferred actions are allowed to throw an
UnsupportedOperationException- Specified by:
enqueueDeferredActionin interfaceFbWireDatabase- Parameters:
deferredAction- Deferred action
-
createEventHandle
public final EventHandle createEventHandle(java.lang.String eventName, EventHandler eventHandler)
Description copied from interface:FbDatabaseCreates an event handle for this database type.The returned event handle can be used with
FbDatabase.queueEvent(org.firebirdsql.gds.EventHandle).- Specified by:
createEventHandlein interfaceFbDatabase- Parameters:
eventName- Name of the eventeventHandler- The event handler to call when the event occurred- Returns:
- A suitable event handle instance
-
queueEvent
public final void queueEvent(EventHandle eventHandle) throws java.sql.SQLException
Description copied from interface:FbDatabaseQueues a wait for an event.- Specified by:
queueEventin interfaceFbDatabase- Parameters:
eventHandle- The event handle (created usingFbDatabase.createEventHandle(String, EventHandler)of this instance).- Throws:
java.sql.SQLException- For errors establishing the asynchronous channel, or for queuing the event.
-
cancelEvent
public final void cancelEvent(EventHandle eventHandle) throws java.sql.SQLException
Description copied from interface:FbDatabaseCancels a registered event.After cancellation, the event handle should be considered unusable. Before queueing a new event, an new handle needs to be created.
- Specified by:
cancelEventin interfaceFbDatabase- Parameters:
eventHandle- The event handle to cancel- Throws:
java.sql.SQLException- For errors cancelling the event
-
countEvents
public final void countEvents(EventHandle eventHandle) throws java.sql.SQLException
Description copied from interface:FbDatabaseCounts the events occurred.- Specified by:
countEventsin interfaceFbDatabase- Parameters:
eventHandle- The event handle- Throws:
java.sql.SQLException- When the count can not be done (as - for example - the event handle is of the wrong type)
-
getDatabaseInfo
public final byte[] getDatabaseInfo(byte[] requestItems, int maxBufferLength) throws java.sql.SQLExceptionDescription copied from interface:FbDatabasePerforms a database info request.- Specified by:
getDatabaseInfoin interfaceFbDatabase- Parameters:
requestItems- Information items to requestmaxBufferLength- Maximum response buffer length to use- Returns:
- The response buffer (note: length is the actual length of the response, not
maxBufferLength - Throws:
java.sql.SQLException- For errors retrieving the information.
-
getInfo
public byte[] getInfo(int operation, int handle, byte[] requestItems, int maxBufferLength, WarningMessageCallback warningMessageCallback) throws java.sql.SQLExceptionDescription copied from interface:FbWireDatabaseGeneric info request.The implementation does not perform handle validation nor notification of error dispatchers. Doing that is the responsibility of the caller.
- Specified by:
getInfoin interfaceFbWireDatabase- Parameters:
operation- Operation codehandle- Handle (db, transaction, statement, blob, etc)requestItems- Information items to requestmaxBufferLength- Maximum response buffer length to usewarningMessageCallback- Callback for warnings when reading the response (can benullto use database default)- Returns:
- The response buffer (note: length is the actual length of the response, not
maxBufferLength) - Throws:
java.sql.SQLException- For errors retrieving the information
-
initAsynchronousChannel
public abstract FbWireAsynchronousChannel initAsynchronousChannel() throws java.sql.SQLException
Initializes the asynchronous channel (for event notification).- Throws:
java.sql.SQLException- For errors establishing the channel, or if the channel already exists.
-
finalize
protected void finalize() throws java.lang.Throwable- Overrides:
finalizein classjava.lang.Object- Throws:
java.lang.Throwable
-
-