oracle.toplink.xml
Class XMLFileLogin

java.lang.Object
  |
  +--oracle.toplink.sessions.DatabaseLogin
        |
        +--oracle.toplink.sdk.SDKLogin
              |
              +--oracle.toplink.xml.XMLLogin
                    |
                    +--oracle.toplink.xml.XMLFileLogin

All Implemented Interfaces:

java.lang.Cloneable, Login, java.io.Serializable

public class XMLFileLogin

extends XMLLogin

XMLFileLogin holds the information required to log in to a file-based XML data store, using an XMLFileAccessor.

Since:

TOPLink/Java 3.0

See Also:

XMLFileAccessor, XMLPlatform, 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

XMLFileLogin()
Default constructor.

XMLFileLogin(DatabasePlatform platform)
Constructor.

XMLFileLogin(java.lang.String baseDirectoryName)
Constructor.

Method Summary

oracle.toplink.internal.databaseaccess.Accessor	buildAccessor() Build and return an appropriate Accessor.
void	createDirectoriesAsNeeded() Set whether directories will be created as needed, if they do not exist already.
boolean	createsDirectoriesAsNeeded() Return whether directories will be created as needed, if they do not exist already.
void	dontCreateDirectoriesAsNeeded() Set whether directories will be created as needed, if they do not exist already.
java.lang.String	getBaseDirectoryName() Return the name of the base directory for the tree of XML subdirectories/files.
java.lang.String	getFileNameExtension() Return the extension to be used for the XML files.
void	setBaseDirectoryName(java.lang.String baseDirectoryName) Set the name of the base directory for the tree of XML subdirectories/files.
void	setCreatesDirectoriesAsNeeded(boolean createsDirectoriesAsNeeded) Set whether directories will be created as needed, if they do not exist already.
void	setFileNameExtension(java.lang.String fileNameExtension) Set the extension to be used for the XML files.

Methods inherited from class oracle.toplink.xml.XMLLogin

getSequenceCounterElementName, getSequenceNameElementName, getSequenceRootElementName, setAccessorClass, setSequenceCounterElementName, setSequenceNameElementName, setSequenceRootElementName

Methods inherited from class oracle.toplink.sdk.SDKLogin

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

XMLFileLogin

public XMLFileLogin()

Default constructor.

XMLFileLogin

public XMLFileLogin(java.lang.String baseDirectoryName)

Constructor. Specify the name of the directory holding all the subdirectories with the XML documents.

XMLFileLogin

public XMLFileLogin(DatabasePlatform platform)

Constructor.

Method Detail

buildAccessor

public oracle.toplink.internal.databaseaccess.Accessor buildAccessor()

Build and return an appropriate Accessor.

Overrides:

buildAccessor in class SDKLogin

createDirectoriesAsNeeded

public void createDirectoriesAsNeeded()

Set whether directories will be created as needed, if they do not exist already.

createsDirectoriesAsNeeded

public boolean createsDirectoriesAsNeeded()

Return whether directories will be created as needed, if they do not exist already.

dontCreateDirectoriesAsNeeded

public void dontCreateDirectoriesAsNeeded()

Set whether directories will be created as needed, if they do not exist already.

getBaseDirectoryName

public java.lang.String getBaseDirectoryName()

Return the name of the base directory for the tree of XML subdirectories/files.

getFileNameExtension

public java.lang.String getFileNameExtension()

Return the extension to be used for the XML files.

setBaseDirectoryName

public void setBaseDirectoryName(java.lang.String baseDirectoryName)

Set the name of the base directory for the tree of XML subdirectories/files.

setCreatesDirectoriesAsNeeded

public void setCreatesDirectoriesAsNeeded(boolean createsDirectoriesAsNeeded)

Set whether directories will be created as needed, if they do not exist already.

setFileNameExtension

public void setFileNameExtension(java.lang.String fileNameExtension)

Set the extension to be used for the XML files.