# Deprecated API

## Contents

- Deprecated Interfaces
- Deprecated Classes
- Deprecated Fields
- Deprecated Methods
- Deprecated Constructors

- Deprecated Interfaces
  Interface and Description
  org.firebirdsql.gds.ExceptionListener Use `ExceptionListener`, interface will be removed in Jaybird 4

- Deprecated Classes
  Class and Description
  org.firebirdsql.encodings.CharacterTranslator To be removed in Jaybird 4

- Deprecated Fields
  Field and Description
  org.firebirdsql.gds.ISCConstants.isc_dpb_octets_as_bytes
  org.firebirdsql.gds.impl.DatabaseParameterBufferExtension.OCTETS_AS_BYTES
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_COMM_LINK_FAILURE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_CONNECTION_CLOSED Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_CONNECTION_ERROR Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_CONNECTION_FAILURE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_CONNECTION_FAILURE_IN_TX Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBDriverNotCapableException.SQL_STATE_FEATURE_NOT_SUPPORTED Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jca.FBResourceException.SQL_STATE_GENERAL_ERROR Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_GENERAL_ERROR Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_ARG_VALUE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_COLUMN Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_CONN_ATTR Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_CONVERSION Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_OPTION_IDENTIFIER Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_PARAM_TYPE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_STATEMENT_ID Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jca.FBResourceTransactionException.SQL_STATE_INVALID_TRANSACTION_STATE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_INVALID_TX_STATE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_NO_RESULT_SET Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_NO_ROW_AVAIL Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_SYNTAX_ERROR Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jca.FBResourceTransactionException.SQL_STATE_TRANSACTION_ACTIVE Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jca.FBResourceTransactionException.SQL_STATE_TRANSACTION_ROLLED_BACK Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.FBSQLException.SQL_STATE_WRONG_PARAM_NUM Use constants from `SQLStateConstants`. To be removed in Jaybird 4.
  org.firebirdsql.jdbc.parser.JaybirdSqlParser.tokenNames Use `JaybirdSqlParser.VOCABULARY` instead.
  org.firebirdsql.jdbc.parser.JaybirdSqlLexer.tokenNames Use `JaybirdSqlLexer.VOCABULARY` instead.

- Deprecated Methods
  Method and Description
  org.firebirdsql.management.MaintenanceManager.commitTransaction(int) Use `MaintenanceManager.commitTransaction(long)`. This method wil be removed in Jaybird 4.
  org.firebirdsql.management.FBMaintenanceManager.commitTransaction(int)
  org.firebirdsql.jdbc.FBBlob.copyCharacterStream(Reader, long, String) Method signature will change incompatibly in Jaybird 4
  org.firebirdsql.jdbc.FBBlob.copyCharacterStream(Reader, String) Method signature will change incompatibly in Jaybird 4
  org.firebirdsql.gds.ng.DatatypeCoder.decodeString(byte[], Encoding, String) To be removed in Jaybird 4
  org.firebirdsql.gds.ng.DatatypeCoder.decodeString(byte[], String, String) To be removed in Jaybird 4
  org.firebirdsql.gds.ng.DatatypeCoder.encodeString(String, Encoding, String) To be removed in Jaybird 4
  org.firebirdsql.gds.ng.DatatypeCoder.encodeString(String, String, String) To be removed in Jaybird 4
  org.firebirdsql.gds.ExceptionListener.errorOccurred(GDSException) this method is never called
  org.firebirdsql.management.FBServiceManager.executeServicesOperation(ServiceRequestBuffer) Use `FBServiceManager.executeServicesOperation(FbService, ServiceRequestBuffer)`.
  org.firebirdsql.gds.ng.FbConnectionProperties.fromDpb(DatabaseParameterBuffer) TODO: This method is only intended to simplify migration of the protocol implementation and needs to be removed.
  org.firebirdsql.jdbc.AbstractResultSet.getBigDecimal(int, int)
  org.firebirdsql.jdbc.AbstractCallableStatement.getBigDecimal(int, int)
  org.firebirdsql.jdbc.AbstractResultSet.getBigDecimal(String, int)
  org.firebirdsql.jca.FBManagedConnectionFactory.getBlobBufferLength() use `FBManagedConnectionFactory.getBlobBufferSize()`
  org.firebirdsql.encodings.EncodingFactory.getCharacterSetSize(int) Use the information provided by the `EncodingDefinition` returned by `EncodingFactory.getEncodingDefinitionByCharacterSetId(int)`
  org.firebirdsql.encodings.IEncodingFactory.getCharacterTranslator(String) To be removed in Jaybird 4
  org.firebirdsql.ds.FBAbstractCommonDataSource.getDatabase()
  org.firebirdsql.ds.FBSimpleDataSource.getDatabaseName() use `FBSimpleDataSource.getDatabase()` instead for the sake of naming compatibility.
  org.firebirdsql.jdbc.FBConnectionProperties.getDatabaseParameterBuffer() TODO Usage of this method should be removed or revised as current use of default encoding is not correct.
  org.firebirdsql.encodings.EncodingFactory.getEncoding(Charset) Use `EncodingFactory.getEncodingForCharset(java.nio.charset.Charset, Encoding)` or `EncodingFactory.getOrCreateEncodingForCharset(java.nio.charset.Charset)`
  org.firebirdsql.encodings.EncodingFactory.getEncoding(Charset, String) To be removed in Jaybird 4, use `EncodingFactory.getEncodingForCharset(Charset)`
  org.firebirdsql.encodings.EncodingFactory.getEncoding(String) Use `EncodingFactory.getEncodingForCharsetAlias(String, Encoding)`
  org.firebirdsql.encodings.EncodingFactory.getEncoding(String, String) To be removed in Jaybird 4, use `EncodingFactory.getEncodingForCharsetAlias(String)`
  org.firebirdsql.jdbc.FBSQLException.getInternalException() use `Throwable.getCause()` instead.
  org.firebirdsql.encodings.EncodingFactory.getIscEncoding(Charset) Use `EncodingFactory.getEncodingDefinitionByCharset(java.nio.charset.Charset)`
  org.firebirdsql.encodings.EncodingFactory.getIscEncoding(String) Use `EncodingFactory.getEncodingDefinitionByCharsetAlias(String)`
  org.firebirdsql.encodings.EncodingFactory.getIscEncodingSize(String) Use `EncodingFactory.getEncodingDefinitionByFirebirdName(String)` and `EncodingDefinition.getMaxBytesPerChar()`
  org.firebirdsql.encodings.EncodingFactory.getJavaEncoding(String)
  org.firebirdsql.encodings.EncodingFactory.getJavaEncodingForAlias(String) Use `EncodingFactory.getEncodingDefinitionByCharsetAlias(String)` and `EncodingDefinition.getJavaEncodingName()`
  org.firebirdsql.jca.FBManagedConnectionFactory.getLocalEncoding() use `FBManagedConnectionFactory.getCharSet()` instead.
  org.firebirdsql.jdbc.parser.JaybirdSqlParser.getTokenNames()
  org.firebirdsql.jdbc.parser.JaybirdSqlLexer.getTokenNames()
  org.firebirdsql.jca.FBManagedConnectionFactory.getTransactionIsolation() use `FBManagedConnectionFactory.getDefaultTransactionIsolation()`
  org.firebirdsql.jca.FBManagedConnectionFactory.getTransactionIsolationName() use `FBManagedConnectionFactory.getDefaultIsolation()`
  org.firebirdsql.jdbc.AbstractResultSet.getUnicodeStream(int)
  org.firebirdsql.jdbc.AbstractResultSet.getUnicodeStream(String)
  org.firebirdsql.ds.FBSimpleDataSource.getUser() use `FBSimpleDataSource.getUserName()` instead for the sake of naming compatibility.
  org.firebirdsql.ds.FBAbstractCommonDataSource.getUserName()
  org.firebirdsql.jdbc.FirebirdConnectionProperties.getUseTranslation() To be removed in Jaybird 4
  org.firebirdsql.gds.impl.GDSHelper.iscVaxInteger(byte[], int, int) Use `VaxEncoding.iscVaxInteger(byte[], int, int)`. This method will be removed in Jaybird 4
  org.firebirdsql.gds.impl.GDSHelper.iscVaxLong(byte[], int, int) Use `VaxEncoding.iscVaxLong(byte[], int, int)`. This method will be removed in Jaybird 4
  org.firebirdsql.management.MaintenanceManager.listLimboTransactions() Use `MaintenanceManager.limboTransactionsAsList()` or `MaintenanceManager.getLimboTransactions()` instead
  org.firebirdsql.management.FBMaintenanceManager.listLimboTransactions()
  org.firebirdsql.management.TraceManager.loadConfigurationFromFile(String) We suggest you use standard Java functionality instead (eg `new String(Files.readAllBytes(Paths.get(fileName)), Charset.defaultCharset())`. This method will be removed in Jaybird 4.
  org.firebirdsql.management.FBTraceManager.loadConfigurationFromFile(String)
  org.firebirdsql.management.MaintenanceManager.rollbackTransaction(int) Use `MaintenanceManager.rollbackTransaction(long)`. This method wil be removed in Jaybird 4.
  org.firebirdsql.management.FBMaintenanceManager.rollbackTransaction(int)
  org.firebirdsql.jca.FBManagedConnectionFactory.setBlobBufferLength(int) use `FBManagedConnectionFactory.setBlobBufferSize(int)`
  org.firebirdsql.ds.FBAbstractCommonDataSource.setDatabase(String)
  org.firebirdsql.ds.FBSimpleDataSource.setDatabaseName(String) use `FBSimpleDataSource.setDatabase(String)` instead for the sake of naming compatibility.
  org.firebirdsql.jca.FBManagedConnectionFactory.setLocalEncoding(String) use `FBManagedConnectionFactory.setCharSet(String)` instead.
  org.firebirdsql.jca.FBManagedConnectionFactory.setTransactionIsolation(Integer) use `FBManagedConnectionFactory.setDefaultTransactionIsolation(int)`
  org.firebirdsql.jca.FBManagedConnectionFactory.setTransactionIsolationName(String) use `FBManagedConnectionFactory.setDefaultIsolation(String)`
  org.firebirdsql.jdbc.FirebirdConnection.setTransactionParameters(int, int[]) use `FirebirdConnection.setTransactionParameters(int, TransactionParameterBuffer)` instead.
  org.firebirdsql.jdbc.FBConnection.setTransactionParameters(int, int[])
  org.firebirdsql.jdbc.AbstractPreparedStatement.setUnicodeStream(int, InputStream, int)
  org.firebirdsql.ds.FBSimpleDataSource.setUser(String) use `FBSimpleDataSource.setUserName(String)` instead for the sake of naming compatibility.
  org.firebirdsql.ds.FBAbstractCommonDataSource.setUserName(String)
  org.firebirdsql.jdbc.FirebirdConnectionProperties.setUseTranslation(String) To be removed in Jaybird 4
  org.firebirdsql.encodings.Encoding.withTranslation(CharacterTranslator) To be removed in Jaybird 4

- Deprecated Constructors
  Constructor and Description
  org.firebirdsql.jdbc.FBSQLException(String, SQLException) In all most all cases use `FBSQLException.FBSQLException(String, String)` in combination with `SQLException.setNextException(SQLException)`.
  org.firebirdsql.gds.impl.ServiceRequestBufferImp() Use `ServiceRequestBufferImp.ServiceRequestBufferImp(SrbMetaData, Encoding)`, will be removed in Jaybird 4
  org.firebirdsql.gds.impl.ServiceRequestBufferImp(int) Use `ServiceRequestBufferImp.ServiceRequestBufferImp(SrbMetaData, Encoding)`, will be removed in Jaybird 4
  org.firebirdsql.gds.impl.argument.StringArgument(int, ArgumentType, String)

Copyright © 2001-2021 Jaybird (Firebird JDBC/JCA) team. All rights reserved.