Package org.firebirdsql.gds.ng
Interface FbAttachment
-
- All Superinterfaces:
java.lang.AutoCloseable,ExceptionListenable
- All Known Subinterfaces:
FbDatabase,FbService,FbWireAttachment,FbWireDatabase,FbWireService,JnaAttachment
- All Known Implementing Classes:
AbstractFbAttachment,AbstractFbDatabase,AbstractFbService,AbstractFbWireDatabase,AbstractFbWireService,JnaDatabase,JnaService,V10Database,V10Service,V11Database,V12Database,V13Database,V15Database,V16Database,V18Database
public interface FbAttachment extends java.lang.AutoCloseable, ExceptionListenable
Connection to a Firebird server (to a database or service).All methods defined in this interface and the direct descendants
FbDatabaseandFbServiceare required to notify allSQLExceptionthrown from the methods defined in this interface, and those exceptions notified by allExceptionListenableimplementations created from them.- Since:
- 3.0
- Author:
- Mark Rotteveel
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidattach()Attach to the attachment type.voidclose()Detaches and closes the connection.voidforceClose()Forces the connection to close without proper detach or cleanup.DatatypeCodergetDatatypeCoder()EncodinggetEncoding()IEncodingFactorygetEncodingFactory()intgetHandle()intgetNetworkTimeout()Gets the current network timeout for this attachment.GDSServerVersiongetServerVersion()booleanisAttached()Current attachment status.booleanisLockedByCurrentThread()Queries if the lock is held by the current thread.voidsetNetworkTimeout(int milliseconds)Sets the network timeout for this attachment.LockCloseablewithLock()Locks the lock withLock.lock()(or equivalent).-
Methods inherited from interface org.firebirdsql.gds.ng.listeners.ExceptionListenable
addExceptionListener, removeExceptionListener
-
-
-
-
Method Detail
-
attach
void attach() throws java.sql.SQLExceptionAttach to the attachment type.- Throws:
java.sql.SQLException
-
close
void close() throws java.sql.SQLExceptionDetaches and closes the connection.- Specified by:
closein interfacejava.lang.AutoCloseable- Throws:
java.sql.SQLException- If not currently connected, or another problem occurred detaching.
-
forceClose
void forceClose() throws java.sql.SQLExceptionForces the connection to close without proper detach or cleanup.If a given implementation does not support this, then this method should call
close().- Throws:
java.sql.SQLException- For problems closing the connection.
-
getHandle
int getHandle()
- Returns:
- The attachment handle value
-
getServerVersion
GDSServerVersion getServerVersion()
- Returns:
- Firebird version string
-
isAttached
boolean isAttached()
Current attachment status.- Returns:
trueif connected to the server and attached to a database or service,falseotherwise.
-
getEncodingFactory
IEncodingFactory getEncodingFactory()
- Returns:
- The
IEncodingFactoryfor this connection
-
getEncoding
Encoding getEncoding()
- Returns:
- The connection encoding (should be the same as returned from calling
IEncodingFactory.getDefaultEncoding()on the result ofgetEncodingFactory()).
-
getDatatypeCoder
DatatypeCoder getDatatypeCoder()
- Returns:
- The
DatatypeCoderfor this database implementation.
-
setNetworkTimeout
void setNetworkTimeout(int milliseconds) throws java.sql.SQLExceptionSets the network timeout for this attachment.- 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.
-
getNetworkTimeout
int getNetworkTimeout() throws java.sql.SQLExceptionGets the current network timeout for this attachment.- Returns:
- Timeout in milliseconds, 0 means no timeout
- Throws:
java.sql.SQLException- If this attachment is closedjava.sql.SQLFeatureNotSupportedException- If this attachment doesn't support network timeout
-
withLock
LockCloseable withLock()
Locks the lock withLock.lock()(or equivalent).The returned
LockClosablecan be used to unlock, preferably for use in a try-with-resources.- Returns:
- lock closeable which unlocks the lock on close
-
isLockedByCurrentThread
boolean isLockedByCurrentThread()
Queries if the lock is held by the current thread.- Returns:
trueif current thread holds this lock andfalseotherwise- See Also:
ReentrantLock.isHeldByCurrentThread()
-
-