Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface and Description
org.apache.cayenne.access.DataPortDelegate since 4.0
org.apache.cayenne.map.EntityListenerFactory since 4.0, as EntityResolver no longer loads listeners from its DataMaps.
org.apache.cayenne.reflect.Property since 4.0 renamed to PropertyDescriptor.

Deprecated Classes

Class and Description
org.apache.cayenne.access.DataPort since 4.0
org.apache.cayenne.map.EntityListener since 4.0, as EntityResolver no longer loads listeners from its DataMaps.
org.apache.cayenne.access.Transaction since 4.0. For manual transaction management use BaseTransaction static methods or better - ServerRuntime.performInTransaction(org.apache.cayenne.tx.TransactionalOperation) . Also note that since 4.0 an actual Transaction is an interface located in a different package: Transaction

Deprecated Fields

Field and Description
org.apache.cayenne.dba.JdbcAdapter.batchQueryBuilderFactory since 4.0 BatchQueryBuilderfactory is attached to the DataNode.
org.apache.cayenne.map.ObjEntity.entityListeners
org.apache.cayenne.map.ObjEntity.excludingDefaultListeners
org.apache.cayenne.map.ObjEntity.excludingSuperclassListeners
org.apache.cayenne.map.EntityResolver.indexedByClass
org.apache.cayenne.access.DataContext.transactionFactory since 4.0 used in a method that itself should be deprecated, so this is a temp code
org.apache.cayenne.access.DataDomain.USING_EXTERNAL_TRANSACTIONS_DEFAULT since 4.0 See Constants.SERVER_EXTERNAL_TX_PROPERTY.
org.apache.cayenne.access.DataDomain.USING_EXTERNAL_TRANSACTIONS_PROPERTY since 4.0 See Constants.SERVER_EXTERNAL_TX_PROPERTY.

Deprecated Methods

Method and Description
org.apache.cayenne.map.DataMap.addDefaultEntityListener(EntityListener) since 4.0 unused as listeners are no longer tied to a DataMap.
org.apache.cayenne.map.ObjEntity.addEntityListener(EntityListener) since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.reflect.LifecycleCallbackRegistry.addListener(LifecycleEvent, Class, String)
org.apache.cayenne.map.EntityResolver.applyObjectLayerDefaults() since 4.0 does nothing. Previously it used to create runtime ObjRelationships, that broke a lot of things.
org.apache.cayenne.access.Transaction.bindThreadTransaction(Transaction)
org.apache.cayenne.map.EntityResolver.clearCache() since 4.0 in favor of EntityResolver.refreshMappingCache().
org.apache.cayenne.remote.RemoteSession.createServerEventBridge() since 4.0. Factory creation should is handled by the client connection.
org.apache.cayenne.exp.Expression.encodeAsEJBQL(PrintWriter, String) since 4.0 use Expression.appendAsEJBQL(Appendable, String)
org.apache.cayenne.exp.parser.SimpleNode.encodeAsEJBQL(PrintWriter, String) since 4.0 use SimpleNode.appendAsEJBQL(Appendable, String).
org.apache.cayenne.exp.Expression.encodeAsString(PrintWriter) since 4.0 use Expression.appendAsString(Appendable).
org.apache.cayenne.exp.parser.SimpleNode.encodeAsString(PrintWriter) since 4.0 use SimpleNode.appendAsString(Appendable).
org.apache.cayenne.exp.Expression.expWithParameters(Map) since 4.0 use Expression.params(Map)
org.apache.cayenne.exp.Expression.expWithParameters(Map, boolean) since 4.0 use Expression.params(Map, boolean) instead.
org.apache.cayenne.access.loader.NamePatternMatcher.filter(List) since 3.0 still used by AntDataPortDelegate, which itself should probably be deprecated
org.apache.cayenne.exp.Expression.fromString(String) since 4.0 use ExpressionFactory.exp(String, Object...)
org.apache.cayenne.dba.JdbcAdapter.getBatchQueryBuilderFactory() since 4.0 BatchQueryBuilderfactory is attached to the DataNode.
org.apache.cayenne.resource.ClassLoaderResourceLocator.getClassLoader() since 4.0 unused, as AdhocObjectFactory.getClassLoader() is used instead.
org.apache.cayenne.ejbql.parser.JavaCharStream.getColumn()
org.apache.cayenne.exp.parser.JavaCharStream.getColumn()
org.apache.cayenne.configuration.CayenneRuntime.getContext() since 3.1 use better named CayenneRuntime.newContext() instead.
org.apache.cayenne.configuration.CayenneRuntime.getContext(DataChannel) since 3.1 use better named CayenneRuntime.newContext(DataChannel) instead.
org.apache.cayenne.cache.EhCacheQueryCache.getDefaultCache() since 4.0 - this method is no longer in use. If you are overriding it, override EhCacheQueryCache.cacheName(String, String...) instead.
org.apache.cayenne.map.DataMap.getDefaultEntityListener(String) since 4.0 unused, as listeners are no longer tied to a DataMap.
org.apache.cayenne.map.DataMap.getDefaultEntityListeners() since 4.0 unused as listeners are no longer tied to a DataMap.
org.apache.cayenne.map.ObjEntity.getEntityListener(String) since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.map.ObjEntity.getEntityListeners() since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.map.ObjEntity.getJavaClass() since 4.0 this method based on statically defined class loading algorithm is not going to work in environments like OSGi. AdhocObjectFactory should be used as it can provide the environment-specific class loading policy.
org.apache.cayenne.map.Embeddable.getJavaClass() since 4.0 this method based on statically defined class loading algorithm is not going to work in environments like OSGi. AdhocObjectFactory should be used as it can provide the environment-specific class loading policy.
org.apache.cayenne.util.Util.getJavaClass(String) since 4.0 this method based on statically defined class loading algorithm is not going to work in environments like OSGi. AdhocObjectFactory should be used as it can provide the environment-specific class loading policy.
org.apache.cayenne.ejbql.parser.JavaCharStream.getLine()
org.apache.cayenne.exp.parser.JavaCharStream.getLine()
org.apache.cayenne.configuration.CayenneRuntime.getModules() since 4.0. We only keep one module now, so use CayenneRuntime.getModule().
org.apache.cayenne.query.SQLTemplate.getParameters() since 4.0 in favor of SQLTemplate.getParams(), as multiple batches of parameters are superseded by the use of QueryChain.
org.apache.cayenne.conn.DataSourceInfo.getPasswordEncoder() since 4.0 as class loading should not happen here.
org.apache.cayenne.dba.JdbcAdapter.getQuotingStrategy(boolean) since 4.0 use JdbcAdapter.getQuotingStrategy().
org.apache.cayenne.dba.DbAdapter.getQuotingStrategy(boolean) since 4.0 use DbAdapter.getQuotingStrategy().
org.apache.cayenne.dba.AutoAdapter.getQuotingStrategy(boolean) since 4.0
org.apache.cayenne.map.EntityResolver.getResultSets() since 4.0 use EntityResolver.getResults().
org.apache.cayenne.access.Transaction.getThreadTransaction()
org.apache.cayenne.access.DataDomain.initWithProperties(Map) since 4.0 properties are processed by the DI provider.
org.apache.cayenne.access.jdbc.JDBCResultIterator.isClosingConnection() since 4.0 always returns false. Connection closing is outside the scope of this iterator. See ConnectionAwareResultIterator for a replacement.
org.apache.cayenne.map.ObjEntity.isExcludingDefaultListeners() since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.map.ObjEntity.isExcludingSuperclassListeners() since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.map.EntityResolver.isIndexedByClass() since 4.0. There's no replacement. This property is meaningless and is no longer respected by the code.
org.apache.cayenne.access.DbLoader.loadDataMapFromDB(String, String, DataMap) since 4.0 use DbLoader.load(org.apache.cayenne.map.DataMap, DbLoaderConfiguration) method that supports catalogs.
org.apache.cayenne.access.DbLoader.loadDataMapFromDB(String, String, String[], DataMap) since 4.0 use DbLoader.load(org.apache.cayenne.map.DataMap, DbLoaderConfiguration) method that supports catalogs.
org.apache.cayenne.access.DbLoader.loadProceduresFromDB(String, String, DataMap) since 4.0 use loadProcedures(DataMap, String, String, String) that supports "catalog" pattern.
org.apache.cayenne.log.NoopJdbcEventLogger.logQueryParameters(String, List, List
org.apache.cayenne.log.JdbcEventLogger.logQueryParameters(String, List, List
org.apache.cayenne.log.CommonsJdbcEventLogger.logQueryParameters(String, List, List
org.apache.cayenne.map.EntityResolver.lookupInheritanceTree(String) since 4.0 use EntityResolver.getInheritanceTree(String).
org.apache.cayenne.map.EntityResolver.lookupObjEntity(Class) since 4.0, use EntityResolver.getObjEntity(Class).
org.apache.cayenne.map.EntityResolver.lookupObjEntity(Object)
org.apache.cayenne.map.EntityResolver.lookupProcedure(Query) since 4.0. Use q.getMetaData(resolver).getProcedure()
org.apache.cayenne.map.EntityResolver.lookupProcedure(String) since 4.0 use EntityResolver.getProcedure(String).
org.apache.cayenne.map.EntityResolver.lookupQuery(String) since 4.0 use EntityResolver.getQuery(String).
org.apache.cayenne.query.SQLTemplate.parametersIterator() since 4.0 as multiple batches of parameters are superseded by the use of QueryChain.
org.apache.cayenne.query.SQLTemplate.parametersSize() since 4.0 as multiple batches of parameters are superseded by the use of QueryChain.
org.apache.cayenne.query.SQLTemplate.queryWithParameters(Map...) since 4.0 as multiple batches of parameters are superseded by the use of QueryChain. For an alternative use SQLTemplate.createQuery(Map).
org.apache.cayenne.dba.QuotingStrategy.quoteFullyQualifiedName(DbEntity) since 4.0 renamed to QuotingStrategy.quotedFullyQualifiedName(DbEntity).
org.apache.cayenne.dba.DefaultQuotingStrategy.quoteFullyQualifiedName(DbEntity)
org.apache.cayenne.dba.QuotingStrategy.quoteString(String) since 4.0
org.apache.cayenne.dba.DefaultQuotingStrategy.quoteString(String) since 4.0
org.apache.cayenne.map.DataMap.removeDefaultEntityListener(String) since 4.0 unused as listeners are no longer tied to a DataMap.
org.apache.cayenne.map.ObjEntity.removeEntityListener(String) since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.dba.JdbcAdapter.setBatchQueryBuilderFactory(BatchTranslatorFactory) since 4.0 BatchQueryBuilderfactory is attached to the DataNode.
org.apache.cayenne.access.jdbc.JDBCResultIterator.setClosingConnection(boolean) since 4.0 does nothing. Connection closing is outside the scope of this iterator. See ConnectionAwareResultIterator for a replacement.
org.apache.cayenne.map.EntityResolver.setEntityListenerFactory(EntityListenerFactory) since 4.0 this method does nothing, as EntityResolver no longer loads listeners from its DataMaps.
org.apache.cayenne.map.ObjEntity.setExcludingDefaultListeners(boolean) since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.map.ObjEntity.setExcludingSuperclassListeners(boolean) since 4.0 unused, as listeners are no longer mapped in a DataMap.
org.apache.cayenne.query.SelectQuery.setFetchingDataRows(boolean) since 4.0, use SelectQuery.dataRowQuery(Class, Expression) to create DataRow query instead.
org.apache.cayenne.map.EntityResolver.setIndexedByClass(boolean) since 4.0. There's no replacement. This property is meaningless.
org.apache.cayenne.query.SQLTemplate.setParameters(Map...) since 4.0 in favor of SQLTemplate.setParams(Map), as multiple batches of parameters are superseded by the use of QueryChain.
org.apache.cayenne.access.DataContext.setTransactionFactory(TransactionFactory) since 4.0 avoid using thsi directly. Transaction management at this level will be eventually removed
org.apache.cayenne.query.BatchQuery.size() since 4.0 use getRows().size().
org.apache.cayenne.dba.TypesMapping.supportsLength(int) Returns true if supplied type can have a length attribute as a part of column definition.

Deprecated Constructors

Constructor and Description
org.apache.cayenne.access.DataDomain(String, Map) since 4.0 unused
org.apache.cayenne.conn.PoolManager(ConnectionPoolDataSource, int, int, String, String) since 4.0 use PoolManager.PoolManager(ConnectionPoolDataSource, int, int, String, String, long)
org.apache.cayenne.conn.PoolManager(String, String, int, int, String, String) since 4.0 This constructor causes implicit class loading that should avoided.
org.apache.cayenne.conn.PoolManager(String, String, int, int, String, String, JdbcEventLogger, long) since 4.0 This constructor causes implicit class loading that should avoided.