Oracle® TopLink

API Modifications

10g (10.1.3.1.0)

 

September 2006

This document describes the API modifications in Oracle TopLink as of 10g Release 3 (10.1.3.0.0).

This document provides information on:

API Replaced in this Release

The following tables list the API replaced as of 10g Release 3 (10.1.3.0.0):

Core Code (oracle.toplink.*)

Class Name Method Name Replacement API

.ejb.bmp.BMPEntityBase.java

ejbCreateImpl()

tlCreateImpl()

.mappings.ForeignReferenceMapping.java

useIndirection()

useBasicIndirection()

.publicinterface.Descriptor.java

setIsAggregateDescriptor()

descriptorIsAggregate()

.publicinterface.Descriptor.java

setIsDescriptorForInterface()

descriptorIsInterface()

.publicinterface.Descriptor.java

setWriteLockFieldName()

useVersionLocking()

.publicinterface.Descriptor.java

useConstructorCopyPolicy()

useInstantiationCopyPolicy()

.publicinterface.Descriptor.java

usesCacheIdentityMap()

shouldUseCacheIdentityMap()

.publicinterface.Descriptor.java

usesFulIdentityMap()

shouldUseFullIdentityMap()

.publicinterface.Descriptor.java

usesHardCacheWeakdentityMap()

shouldUseHardCacheWeakIdentityMap()

.publicinterface.Descriptor.java

usesNoIdentityMap()

shouldUseNoIdentityMap()

.publicinterface.Descriptor.java

usesSoftCacheWeakdentityMap()

shouldUseSoftCacheWeakIdentityMap()

.publicinterface.Descriptor.java

usesWeakIdentityMap()

shouldUseWeakIdentityMap()

.publicinterface.Session.java

dontLogSQL()

dontLogMessages()

.publicinterface.Session.java

getLoggingStream()

getLog()

.publicinterface.Session.java

logSQL()

logMessages()

.publicinterface.Session.java

setLoggingStream()

setLog()

.publicinterface.Session.java

setShouldLogSQL()

setShouldLogMessages()

.publicinterface.Session.java

shouldLogSQL()

shouldLogMessages()

.queryframework.ReadAllQuery.java

dontUseCursoredStream()

useCursoredStream(int, int)

.queryframework.ReadAllQuery.java

getCursorPageAmount()

useCursoredStream(int, int)

.queryframework.ReadAllQuery.java

getCursorThreshold()

useCursoredStream(int, int)

.queryframework.ReadAllQuery.java

setCursorPageAmount()

useCursoredStream(int, int)

.queryframework.ReadAllQuery.java

setCursorThreshold()

useCursoredStream(int, int)

.queryframework.ReadAllQuery.java

setUsesCursoredStream()

useCursoredStream(int, int)

.queryframework.ReportQueryResult.java

getPrimaryKeys()

getPrimaryKeyValues()

Database Login (oracle.toplink.*)

Class Name Method Name Replacement API

.sessions.DatabaseLogin.java

addProperty(String propertyName, Object propertyValue)

setProperty(String propertyName, Object propertyValue)

.sessions.DatabaseLogin.java

dontUseBinding()

dontUseByteArrayBinding()

.sessions.DatabaseLogin.java

useBinding()

useByteArrayBinding()

.sessions.DatabaseLogin.java

usesBinding()

shouldUseByteArrayBinding()

.sessions.DatabaseLogin.java

shouldUseBinding()

shouldUseByteArrayBinding()

.sessions.DatabaseLogin.java

usesByteArrayBinding()

shouldUseByteArrayBinding()

.sessions.DatabaseLogin.java

usesBatchWriting()

shouldUseBatchWriting()

.sessions.DatabaseLogin.java

forAccess()

useAccess()

.sessions.DatabaseLogin.java

forDB2()

useDB2()

.sessions.DatabaseLogin.java

forDBase()

useDBase()

.sessions.DatabaseLogin.java

forInformix()

useInformix()

.sessions.DatabaseLogin.java

forJDBC()

useJDBC()

.sessions.DatabaseLogin.java

forOracle()

useOracle()

.sessions.DatabaseLogin.java

forSQLServer()

useSQLServer()

.sessions.DatabaseLogin.java

forSybase()

useSybase()

.sessions.DatabaseLogin.java

getSequenceCounterName()

getSequenceCounterFieldName()

.sessions.DatabaseLogin.java

setSequenceCounterName()

setSequenceCounterFieldName()

.sessions.DatabaseLogin.java

getSequenceFieldName()

getSequenceNameFieldName()

.sessions.DatabaseLogin.java

setSequenceFieldName()

setSequenceNameFieldName()

.sessions.DatabaseLogin.java

isAnyOracleJDBCBridge()

isAnyOracleJDBCDriver()

.sessions.DatabaseLogin.java

isDB2JDBCBridge()

isDB2JDBCDriver()

.sessions.DatabaseLogin.java

isIntersolvSequeLinkBridge()

isIntersolvSequeLinkDriver()

.sessions.DatabaseLogin.java

isJConnectBridge()

isJConnectDriver()

.sessions.DatabaseLogin.java

isJDBCConnectBridge()

isJDBCConnectDriver()

.sessions.DatabaseLogin.java

isJDBCConnectRemoteBridge()

isJDBCConnectRemoteDriver()

.sessions.DatabaseLogin.java

isOracle7JDBCBridge()

isOracle7JDBCDriver()

.sessions.DatabaseLogin.java

isOracleJDBCBridge()

isOracleJDBCDriver()

.sessions.DatabaseLogin.java

isOracleServerJDBCBridge()

isOracleServerJDBCDriver()

.sessions.DatabaseLogin.java

isOracleThinJDBCBridge()

isOracleThinJDBCDriver()

.sessions.DatabaseLogin.java

isWebLogicOracleOCIBridge()

isWebLogicOracleOCIDriver()

.sessions.DatabaseLogin.java

isWebLogicSQLServerBridge()

isWebLogicSQLServerDriver()

.sessions.DatabaseLogin.java

isWebLogicSQLServerDBLibBridge()

isWebLogicSQLServerDBLibDriver()

.sessions.DatabaseLogin.java

isWebLogicSybaseDBLibBridge()

isWebLogicSybaseDBLibDriver()

.sessions.DatabaseLogin.java

isWebLogicThinBridge()

isWebLogicThinDriver()

.sessions.DatabaseLogin.java

isWebLogicThinClientBridge()

isWebLogicThinClientDriver()

.sessions.DatabaseLogin.java

usesExternalConnectionPooling()

shouldUseExternalConnectionPooling()

.sessions.DatabaseLogin.java

usesExternalTransactionController()

shouldUseExternalTransactionController()

.sessions.DatabaseLogin.java

usesJDBCBatchWriting()

shouldUseJDBCBatchWriting()

.sessions.DatabaseLogin.java

usesNativeSequencing()

shouldUseNativeSequencing()

.sessions.DatabaseLogin.java

usesNativeSQL()

shouldUseNativeSQL()

.sessions.DatabaseLogin.java

usesStreamsForBinding()

shouldUseStreamsForBinding()

.sessions.DatabaseLogin.java

usesStringBinding()

shouldUseStringBinding()

.sessions.DatabaseLogin.java

useDB2JDBCBridge()

useDB2JDBCDriver()

.sessions.DatabaseLogin.java

useDB2NetJDBCBridge()

useDB2NetJDBCDriver()

.sessions.DatabaseLogin.java

useIntersolvSequeLinkBridge()

useIntersolvSequeLinkDriver()

.sessions.DatabaseLogin.java

useJConnect50Bridge()

useJConnect50Driver()

.sessions.DatabaseLogin.java

useJConnectBridge()

useJConnectDriver()

.sessions.DatabaseLogin.java

useJDBCConnectBridge()

useJDBCConnectDriver()

.sessions.DatabaseLogin.java

useJDBCConnectRemoteBridge()

useJDBCConnectRemoteDriver()

.sessions.DatabaseLogin.java

useOracle7JDBCBridge()

useOracle7JDBCDriver()

.sessions.DatabaseLogin.java

useOracleJDBCBridge()

useOracleJDBCDriver()

.sessions.DatabaseLogin.java

useOracleServerJDBCBridge()

useOracleServerJDBCDriver()

.sessions.DatabaseLogin.java

useOracleThinJDBCBridge()

useOracleThinJDBCDriver()

.sessions.DatabaseLogin.java

useWebLogicOracleOCIBridge()

useWebLogicOracleOCIDriver()

.sessions.DatabaseLogin.java

useWebLogicSQLServerBridge()

useWebLogicSQLServerDriver()

.sessions.DatabaseLogin.java

useWebLogicSQLServerDBLibBridge()

useWebLogicSQLServerDBLibDriver()

.sessions.DatabaseLogin.java

useWebLogicSybaseDBLibBridge()

useWebLogicSybaseDBLibDriver()

.sessions.DatabaseLogin.java

useWebLogicThinBridge()

useWebLogicThinDriver()

.sessions.DatabaseLogin.java

useWebLogicThinClientBridge()

useWebLogicThinClientDriver()

.sessions.DatabaseLogin.java

getKey()

getLicensePath()

.sessions.DatabaseLogin.java

setKey()

setLicensePath()

.sessions.DatabaseLogin.java

setUsesDirectDriverConnect()

useDirectDriverConnect() and useDefaultDriverConnect()

.sessions.DatabaseLogin.java

usesDirectDriverConnect()

getConnector()

EJB (oracle.toplink.*)

Class Name Method Name Replacement API

.ejb.cmp.wls11.DeploymentCustomization.java

The whole class

ejb.cmp.DeploymentCustomization.java

.ejb.SessionManager

The whole class

tools.sessionmanagement.SessionManager

JDK 1.1 wasDataSourceConnector (oracle.toplink.*)

Class Name Method Name Replacement API

.ejb.cmp.was.WSDataStore

Reference to DataSourceConnector

Reference to jndi.JNDIConnecter

TopLink 2.5 Project Reading (oracle.toplink.*)

Class Name Method Name Replacement API

.tools.schemaframework.TableCreator.java

dropPre25Constraints()

createTables()

API Removed in this Release

The following tables list the API removed as of 10g Release 3 (10.1.3.0.0):

Flex LM Licensing

Class Name Method Name

./ejb/DeploymentException.java

NO_LICENSE_IN_WL_PROPERTIES

./ejb/DeploymentException.java

ERROR_VALIDATING_LICENSE

./ejb/DeploymentException.java

errorValidatingLicense()

./ejb/DeploymentException.java

noLicenseInWLPropertiesFile()

./exceptions//i18n/DeploymentExceptionResource.java

14002, 14009

./exceptions/ValidationException.java

EJB_MUST_SET_LICENSE_KEY

./exceptions/ValidationException.java

SESSION_LIMIT_IS_EXCEEDED

./exceptions/ValidationException.java

ERROR_WHILE_READING_LICENSE

./exceptions/ValidationException.java

LICENSE_FILE_NOT_FOUND

./exceptions/ValidationException.java

licenseFileNotFound()

./exceptions/ValidationException.java

sessionLimitExceeded()

./exceptions/ValidationException.java

errorWhileReadingLicenseFile()

./exceptions/i18n/ValidationExceptionResource.java

7090, 7098

./sessions/DatabaseLogin.java

licensePath

./sessions/DatabaseLogin.java

studioLicenseFile

./sessions/DatabaseLogin.java

licenseFile

./sessions/DatabaseLogin.java

getLicenseFileFromClasspath()

EJB (oracle.toplink.*)

Class Name Method Name

.tools.sessionmanagement.SessionManager

Reference to ejb.SessionManager with TopLink.properties support.

ProxySession

Class Name Method Name

./remote/ProxySession.java

The whole class

./internal/sessions/ProxySessionIdentityMapAccessor

The whole class

./Internal/remote/RemoteConnection

createProxySession()

./publicinterface/Session

isProxySession()

./remote/DistributedSession

isProxySession()

./sessions/Session

isProxySession()

JDK 1.1 wasDataSourceConnector

Class Name Method Name

./jndi/was/DataSourceConnector

The whole class

MessageDialog

Class Name Method Name

./tools/beans

The whole class

ProfileBrowser

Class Name Method Name

./tools/sessionconsole

The whole class

XMLTransformer

Class Name Method Name

./internal/transformxml/XMLTransformer

The whole class

TopLink 2.5 Project Reading

Class Name Method Name

./tools/builderreader

The whole package

./tools/builderreader/parser

The whole package

./tools/schemaframework/TableDefinition.java

buildPre25FieldTypes()

./tools/schemaframework/SchemaManager.java

buildPre25ForeignKeyConstraint()

API Deprecated in this Release

The following tables list the API deprecated as of 10g Release 3 (10.1.3.0.0):


Note:

Because deprecated classes and moved classes have the same name, you may get compile errors if you use import * to import classes from both the old package and the new package.

To avoid these errors, use import with a fully qualified package name.

publicinterface (oracle.toplink.*)

Class Name Method Name Replacement API

.publicinterface.DatabaseRow

Whole class

.sessions.DatabaseRecord

.publicinterface.DatabaseSession Foot 1 

Whole class

.sessions.DatabaseSession

.publicinterface.Session Foot 2 

Whole class

.sessions.Session

.publicinterface.UnitOfWork Foot 3 

Whole class

.sessions.UnitOfWork

.publicinterface.Descriptor

Whole class

.descriptors - ClassDescriptor, RelationalDescriptor

.publicinterface.DescriptorEvent

Whole class

.descriptors.DescriptorEvent

.publicinterface.DescriptorEventListener

Whole class

.descriptors - new interface will not extend old interface.

.publicinterface.DescriptorEventManager

Whole class

.descriptors

.publicinterface.DescriptorQueryManager

Whole class

.descriptors

.publicinterface.InheritancePolicy

Whole class

.descriptors

Footnote 1 oracle.toplink.publicinterface.DatabaseSession was moved to an internal package and renamed to oracle.toplink.internal.sessions.DatabaseSessionImpl. The replacement public API for oracle.toplink.publicinterface.DatabaseSession is oracle.toplink.sessions.DatabaseSession.

Footnote 2 oracle.toplink.publicinterface.Session was moved to an internal package and renamed to oracle.toplink.internal.sessions.AbstractSessionImpl. The replacement public API for oracle.toplink.publicinterface.Session is oracle.toplink.sessions.Session. Note however, that two methods from oracle.toplink.publicinterface.Session (executeNonSelectingSQL and executeSQL) have been undeprecated in the current release (see Table: SQL Execution Methods on Session (oracle.toplink.*)).

Footnote 3 oracle.toplink.publicinterface.UnitOfWork was moved to an internal package and renamed to oracle.toplink.internal.sessionl.UnitOfWorkImpl. The replacement public API for oracle.toplink.publicinterface.UnitOfWork is oracle.toplink.sessions.UnitOfWork.

oraclespecific (oracle.toplink.*)

Class Name Method Name Replacement API

.oraclespecific.NCharacter

Whole class

.platform.database.oracle.NCharacter

.oraclespecific.NClob

Whole class

.platform.database.oracle.NClob

.oraclespecific.NClob

Whole class

.platform.database.oracle.NClob

.oraclespecific.Oracle8Platform

Whole class

.platform.database.oracle.Oracle8Platform

.oraclespecific.Oracle9Specific Foot 1 

Whole class

.platform.database.oracle.Oracle9Specific

.oraclespecific.TopLinkXMLType Foot 2 

Whole class

None

Footnote 1 oracle.toplink.oraclespecific.Oracle9Specific was moved to an internal package and renamed to oracle.toplink.internal.platform.database.oracle.Oracle9Specific. The replacement public API for oracle.toplink.oraclespecific.Oracle9Specific is oracle.toplink.platform.database.oracle.Oracle9Specific.

Footnote 2 oracle.toplink.oraclespecific.TopLinkXMLType was a miscellaneous class, which does not have a replacement API.

databaseaccess (oracle.toplink.*)

Class Name Method Name Replacement API

.*Platform

Whole class

.platform.database

EJB Mapping for BEA WebLogic 6.1

Class Name Method Name Replacement API

toplink-cmp-bean_name.xml

None

A warning will be added at the beginning of: internal.ejb.cmp.wls11.CMPDeployer.readTypeSpecificData()

Converter Mappings (oracle.toplink.*)

Class Name Method Name Replacement API

.mapping.TypeConversionMapping

The whole class

.mapping.converters.TypeConversionConverter

.mapping.ObjectTypeMapping

The whole class

.mapping.converters.ObjectTypeConverter

.mapping.SerializedObjectMapping

The whole class

.mapping.converters.SerializedObjectConverter

XMLCommandConverter (oracle.toplink.*

Class Name Method Name

./remotecommand/XMLCommandConverter

The whole class

./transform/xml/XMLSource

The whole class

./transform/xml/XMLResult

The whole class

./internal/localization/i18n/ExceptionLocalizationResource

"error_loading_resources"

./internal/localization/i18n/ExceptionLocalizationResource

"error_parsing_resources"

./internal/localization/i18n/ExceptionLocalizationResource

"unexpect_argument"

Remote Protocols (oracle.toplink.*)

Class Name Method Name

./remote/corba/orbix

The whole package

./remote/corba/visibroker

The whole package

./remote/ejb

The whole package

./tools/sessionconfiguration/TopLinkSessionsFactory

References for any of JNDIClusteringService in orbix, visibroker and ejb packages.

./tools/sessionconfiguration/DTD2SessionConfigLoader

References for any of JNDIClusteringService in orbix, visibroker and ejb packages.

./tools/sessionconfiguration/model/clustering/VisibrokerCORBAJNDIClusteringConfig

The whole class

./tools/sessionconfiguration/model/clustering/OrbixCORBAJNDIClusteringConfig

The whole class

./tools/sessionconfiguration/model/clustering/EJBJNDIClusteringConfig

The whole class

./tools/sessionconfiguration/XMLSessionConfigProject

References for any of JNDIClusteringService in orbix, visibroker and ejb packages.

JDO (oracle.toplink.*)

Class Name Method Name

.jdo

The whole package

SDK (oracle.toplink.*)

Class Name Method Name Replacement API

.sdk

The whole package

.eis

XML (oracle.toplink.*)

Class Name Method Name Replacement API

.xml

The whole package

.ox

.xmlstream

The whole package

.ox

.xml.tools

The whole package

.ox

.xml.xerces

The whole package

.ox

.xml.zip

The whole package

.ox

API Un-Deprecated in this Release

The following table lists the API un-deprecated as of 10g Release 3 (10.1.3.0.0):

SQL Execution Methods on Session (oracle.toplink.*)

Class Name Method Name Replacement API

.publicinterface.Session

executeNonSelectingSQL()

executeNonSelectingCall()

.publicinterface.Session

executeSQL()

executeSelectingCall()

Vector and Hashtable Return Types

Any Session or ClassDescriptor method that returns Vector or Hashtable will eventually be changed to return List or Map, respectively. To future proof your application code, cast Vector and Hashtable return types to List or Map, respectively. For example, although the Javadoc for ClassDescriptor method getMappings is java.util.Vector, you should cast the returned value to List:

List mappings = (List) descriptor.getMappings();

Other changes that now return Map, include the following:

ClassDescriptor.getQueryKeys(); 
ClassDescriptor.getProperties();
DescriptorQueryManager.getQueries();
EISInteraction.getProperties();
Session.getProperties();
Session.getQueries();
getAttributesToAlwaysInclude(); 
getSpecialOperations();
getValuesToExclude();

Oracle TopLink API Modifications, 10g (10.1.3.1.0)

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle, JD Edwards, PeopleSoft and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.