Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.xml
Class XMLLogin

java.lang.Object
  extended byoracle.toplink.sessions.DatabaseLogin
      extended byoracle.toplink.sdk.SDKLogin
          extended byoracle.toplink.xml.XMLLogin

All Implemented Interfaces:
java.lang.Cloneable, Login, java.io.Serializable
Direct Known Subclasses:
XMLFileLogin, XMLStreamLogin

public class XMLLogin
extends SDKLogin

XMLLogin adds a little protocol to make it look like we are dealing with XML documents and elements instead of database rows and fields.

Since:
TOPLink/Java 3.0
See Also:
XMLPlatform, XMLAccessor, Serialized Form

Field Summary

Fields inherited from class oracle.toplink.sessions.DatabaseLogin
CONCURRENT_READ_WRITE, licenseFile, licensePath, studioLicenseFile, SYNCHRONIZED_READ_ON_WRITE, SYNCHRONIZED_WRITE, TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE, versionString, xmlParserJARFileNames

Constructor Summary
XMLLogin()
Default constructor.
XMLLogin(DatabasePlatform platform)
Construct a login for the specifed platform

Method Summary
java.lang.String getSequenceCounterElementName()
PUBLIC: Return the name of the element in the TopLink sequence documents that holds the current value for a given sequence (e.g.
java.lang.String getSequenceNameElementName()
PUBLIC: Return the name of the element in the TopLink sequence documents that holds the name for a given sequence (e.g.
java.lang.String getSequenceRootElementName()
PUBLIC: Return the name of the root element in the TopLink sequence documents.
void setAccessorClass(java.lang.Class accessorClass)
Set the class of the accessor to be built.
void setSequenceCounterElementName(java.lang.String name)
PUBLIC: Set the name of the element in the TopLink sequence documents that holds the current value for a given sequence (e.g.
void setSequenceNameElementName(java.lang.String name)
PUBLIC: Set the name of the element in the TopLink sequence documents that holds the name for a given sequence (e.g.
void setSequenceRootElementName(java.lang.String name)
PUBLIC: Set the name of the root element in the TopLink sequence documents.

Methods inherited from class oracle.toplink.sdk.SDKLogin
buildAccessor, getAccessorClass, invalidAccessClass, toString

Methods inherited from class oracle.toplink.sessions.DatabaseLogin
addProperty, bindAllParameters, cacheAllStatements, dontBindAllParameters, dontCacheAllStatements, dontOptimizeDataConversion, dontUseBatchWriting, dontUseBinding, dontUseByteArrayBinding, dontUseExternalConnectionPooling, dontUseExternalTransactionController, dontUseJDBCBatchWriting, dontUseNativeSequencing, dontUseNativeSQL, dontUseStreamsForBinding, dontUseStringBinding, forAccess, forDB2, forDBase, forInformix, forJDBC, forOracle, forSQLServer, forSybase, getCacheTransactionIsolation, getConnectionString, getConnector, getCursorCode, getDatabaseName, getDatabaseURL, getDataSourceName, getDriverClassName, getDriverURLHeader, getKey, getLicenseFile, getLicensePath, getMaxBatchWritingSize, getPassword, getProperty, getQualifiedSequenceTableName, getSequenceCounterFieldName, getSequenceCounterName, getSequenceFieldName, getSequenceNameFieldName, getSequencePreallocationSize, getSequenceTableName, getServerName, getShouldBindAllParameters, getShouldCacheAllStatements, getShouldOptimizeDataConversion, getShouldTrimStrings, getStatementCacheSize, getStringBindingSize, getStudioLicenseFile, getTableQualifier, getTransactionIsolation, getUserName, getUsesBinding, getUsesNativeSequencing, getUsesNativeSQL, getUsesStreamsForBinding, getUsesStringBinding, getVersion, getXMLParserJARFileNames, handleTransactionsManuallyForSybaseJConnect, isAnyOracleJDBCBridge, isAnyOracleJDBCDriver, isCloudscapeJDBCDriver, isDB2JDBCBridge, isDB2JDBCDriver, isIntersolvSequeLinkBridge, isIntersolvSequeLinkDriver, isJConnectBridge, isJConnectDriver, isJDBCConnectBridge, isJDBCConnectDriver, isJDBCConnectRemoteBridge, isJDBCConnectRemoteDriver, isJDBCODBCBridge, isOracle7JDBCBridge, isOracle7JDBCDriver, isOracleJDBCBridge, isOracleJDBCDriver, isOracleServerJDBCBridge, isOracleServerJDBCDriver, isOracleThinJDBCBridge, isOracleThinJDBCDriver, isWebLogicOracleOCIBridge, isWebLogicOracleOCIDriver, isWebLogicSQLServerBridge, isWebLogicSQLServerDBLibBridge, isWebLogicSQLServerDBLibDriver, isWebLogicSQLServerDriver, isWebLogicSybaseDBLibBridge, isWebLogicSybaseDBLibDriver, isWebLogicThinBridge, isWebLogicThinClientBridge, isWebLogicThinClientDriver, isWebLogicThinDriver, optimizeDataConversion, removeProperty, setCacheTransactionIsolation, setConnectionString, setConnector, setCursorCode, setDatabaseName, setDatabaseURL, setDataSourceName, setDefaultNullValue, setDriverClass, setDriverClassName, setDriverURLHeader, setEncryptedPassword, setEncryptionClassName, setKey, setKey, setLicensePath, setMaxBatchWritingSize, setPassword, setProperties, setProperty, setSelectSequenceNumberQuery, setSequenceCounterFieldName, setSequenceCounterName, setSequenceFieldName, setSequenceNameFieldName, setSequencePreallocationSize, setSequenceTableName, setServerName, setShouldBindAllParameters, setShouldCacheAllStatements, setShouldForceFieldNamesToUpperCase, setShouldIgnoreCaseOnFieldComparisons, setShouldOptimizeDataConversion, setShouldTrimStrings, setStatementCacheSize, setStringBindingSize, setTableQualifier, setTimestampQuery, setTransactionIsolation, setUpdateSequenceQuery, setUserName, setUsesBatchWriting, setUsesBinding, setUsesByteArrayBinding, setUsesDirectDriverConnect, setUsesExternalConnectionPooling, setUsesExternalTransactionController, setUsesJDBCBatchWriting, setUsesNativeSequencing, setUsesNativeSQL, setUsesStreamsForBinding, setUsesStringBinding, setXMLParserJARFileNames, shouldBindAllParameters, shouldCacheAllStatements, shouldForceFieldNamesToUpperCase, shouldIgnoreCaseOnFieldComparisons, shouldOptimizeDataConversion, shouldTrimStrings, shouldUseBatchWriting, shouldUseBinding, shouldUseByteArrayBinding, shouldUseExternalConnectionPooling, shouldUseExternalTransactionController, shouldUseJDBCBatchWriting, shouldUseNativeSequencing, shouldUseNativeSQL, shouldUseStreamsForBinding, shouldUseStringBinding, useAccess, useBatchWriting, useBinding, useByteArrayBinding, useCloudscape, useCloudscapeDriver, useDB2, useDB2JDBCBridge, useDB2JDBCDriver, useDB2NetJDBCBridge, useDB2NetJDBCDriver, useDBase, useDefaultDriverConnect, useDefaultDriverConnect, useDirectDriverConnect, useDirectDriverConnect, useExternalConnectionPooling, useExternalTransactionController, useHSQL, useHSQLDriver, useINetSQLServerDriver, useInformix, useIntersolvSequeLinkBridge, useIntersolvSequeLinkDriver, useJConnect50Bridge, useJConnect50Driver, useJConnectBridge, useJConnectDriver, useJDBC, useJDBCBatchWriting, useJDBCConnectBridge, useJDBCConnectDriver, useJDBCConnectRemoteBridge, useJDBCConnectRemoteDriver, useJDBCODBCBridge, useNativeSequencing, useNativeSQL, useOracle, useOracle7JDBCBridge, useOracle7JDBCDriver, useOracleJDBCBridge, useOracleJDBCDriver, useOracleServerJDBCBridge, useOracleServerJDBCDriver, useOracleThinJDBCBridge, useOracleThinJDBCDriver, usePlatform, usePointBase, usePointBaseDriver, usesBatchWriting, usesBinding, usesByteArrayBinding, usesDirectDriverConnect, usesExternalConnectionPooling, usesExternalTransactionController, usesJDBCBatchWriting, usesNativeSequencing, usesNativeSQL, useSQLServer, usesStreamsForBinding, usesStringBinding, useStreamsForBinding, useStringBinding, useStringBinding, useSybase, useWebLogicDriverCursoredOutputCode, useWebLogicJDBCConnectionPool, useWebLogicOracleOCIBridge, useWebLogicOracleOCIDriver, useWebLogicSQLServerBridge, useWebLogicSQLServerDBLibBridge, useWebLogicSQLServerDBLibDriver, useWebLogicSQLServerDriver, useWebLogicSybaseDBLibBridge, useWebLogicSybaseDBLibDriver, useWebLogicThinBridge, useWebLogicThinClientBridge, useWebLogicThinClientDriver, useWebLogicThinDriver

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLLogin

public XMLLogin()
Default constructor.

XMLLogin

public XMLLogin(DatabasePlatform platform)
Construct a login for the specifed platform

Method Detail

getSequenceCounterElementName

public java.lang.String getSequenceCounterElementName()
PUBLIC: Return the name of the element in the TopLink sequence documents that holds the current value for a given sequence (e.g. "SEQ_COUNT"). TopLink uses the sequence documents to generate unique object IDs.

getSequenceNameElementName

public java.lang.String getSequenceNameElementName()
PUBLIC: Return the name of the element in the TopLink sequence documents that holds the name for a given sequence (e.g. "SEQ_NAME"). TopLink uses the sequence documents to generate unique object IDs.

getSequenceRootElementName

public java.lang.String getSequenceRootElementName()
PUBLIC: Return the name of the root element in the TopLink sequence documents. TopLink uses a sequence documents to generate unique object IDs.

setAccessorClass

public void setAccessorClass(java.lang.Class accessorClass)
Set the class of the accessor to be built.
Overrides:
setAccessorClass in class SDKLogin

setSequenceCounterElementName

public void setSequenceCounterElementName(java.lang.String name)
PUBLIC: Set the name of the element in the TopLink sequence documents that holds the current value for a given sequence (e.g. "SEQ_COUNT"). TopLink uses the sequence documents to generate unique object IDs.

setSequenceNameElementName

public void setSequenceNameElementName(java.lang.String name)
PUBLIC: Set the name of the element in the TopLink sequence documents that holds the name for a given sequence (e.g. "SEQ_NAME"). TopLink uses the sequence documents to generate unique object IDs.

setSequenceRootElementName

public void setSequenceRootElementName(java.lang.String name)
PUBLIC: Set the name of the root element in the TopLink sequence documents. TopLink uses a sequence documents to generate unique object IDs.

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.