oracle.toplink.tools.ejb11
Class DDProjectDefinition

java.lang.Object
oracle.toplink.tools.ejb11.DDProjectDefinition

public class DDProjectDefinition

extends java.lang.Object

Defines the project-specific deployment descriptor properties for the toplink-cmp-bean XML file.

See Also:

DDDefinition, DDGenerator

Constructor Summary

DDProjectDefinition()
DDProjectDefinition constructor

Method Summary

void	setCustomizationClassName(java.lang.String customizationClassName) Set the name of the customization class.
void	setJdbcLevel(java.lang.String jdbcLevel) Deprecated.
void	setLogDestination(java.lang.String logDestination) Set the database platform class of the project.
void	setLogMessages(boolean logMsgsFlag) Set whether the SQL code and other messages that are sent to the database by TopLink are displayed in the console.
void	setProjectClassName(java.lang.String projectClassName) Set the name of the class that contains all of the TopLink mapping information.
void	setProjectDataSource(java.lang.String projectDataSource) Set the name of the JDBC DataSource to be used by the project.
void	setProjectFileName(java.lang.String projectFileName) Set the name of the project file that contains/references the TopLink mapping information for this project.
void	setProjectIdentifier(java.lang.String projectIdentifier) Set the identifier of the project as a key within the EJB server.
void	setProjectPlatform(java.lang.String projectPlatform) Set the database platform class of the project.
void	setProjectPoolName(java.lang.String projectPoolName) Set the name of the JDBC connection pool to be used by the project.
void	setProjectReadOnlyDataSource(java.lang.String projectReadOnlyDataSource) Set the name of the JDBC DataSource to be used by the project for reading only.
void	setTransactionIsolation(java.lang.String transactionIsolation) Set the transaction isolation level for the project.
void	setUpdatePropagation(java.lang.String updatePropagationMode) Enable update propagation for the project.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DDProjectDefinition

public DDProjectDefinition()

DDProjectDefinition constructor

Method Detail

setCustomizationClassName

public void setCustomizationClassName(java.lang.String customizationClassName)

Set the name of the customization class. If set, this class will be invoked before and after TopLink logs into the database.

This attribute is optional.

Parameters:

customizationClassName - the name of the class. This class must implement the oracle.toplink.ejb.cmp.wls11.DeploymentCustomization interface.

See Also:

DeploymentCustomization

setJdbcLevel

public void setJdbcLevel(java.lang.String jdbcLevel)

Deprecated.

Set JDBC level for the JTS driver for the project. If set to 1.0, then the regular JTS driver will be used If set to 2.0, then the JDBC2.0 version of the JTS driver will be used

This attribute is optional.

Parameters:

jdbcLevel - the level of the available jdbc driver which must be on the classpath

setLogDestination

public void setLogDestination(java.lang.String logDestination)

Set the database platform class of the project. If set, this platform will override the platform specified in the project file/class.

This attribute is optional.

See Also:

DatabasePlatform

setLogMessages

public void setLogMessages(boolean logMsgsFlag)

Set whether the SQL code and other messages that are sent to the database by TopLink are displayed in the console.

This attribute is optional.

Parameters:

logMsgsFlag - set to true to enable logging, or false to disable it

setProjectClassName

public void setProjectClassName(java.lang.String projectClassName)

Set the name of the class that contains all of the TopLink mapping information. This class must have been generated or manually written to incorporate all of the object and table mapping instructions that apply to this project.

This attribute is required if no ProjectFileName was set. This attribute may not be specified if a ProjectFileName was set.

Parameters:

projectClassName - the fully-qualified name of the project class (without its .class extension)

setProjectDataSource

public void setProjectDataSource(java.lang.String projectDataSource)

Set the name of the JDBC DataSource to be used by the project. This DataSource will be the one that is used to get JDBC connections from and issue SQL to the database. For CMP this should be a JTS compatible data source.

This attribute is required if no ProjectPoolName was set. This attribute may not be specified if a ProjectPoolName was set.

Parameters:

projectDataSource - the name of data source

setProjectFileName

public void setProjectFileName(java.lang.String projectFileName)

Set the name of the project file that contains/references the TopLink mapping information for this project.

This attribute is required if no ProjectClassName was set. This attribute may not be specified if a ProjectClassName was set.

Parameters:

projectFileName - the absolute filepath of the project file

setProjectIdentifier

public void setProjectIdentifier(java.lang.String projectIdentifier)

Set the identifier of the project as a key within the EJB server. This identifier must be unique within the scope of all projects deployed in the server.

This attribute is required.

Parameters:

projectIdentifier - a unique alpha-numeric identifier representing this project in the server

setProjectPlatform

public void setProjectPlatform(java.lang.String projectPlatform)

Set the database platform class of the project. If set, this platform will override the platform specified in the project file/class.

This attribute is optional.

Parameters:

projectPlatform - the name of the supported platform implementation class to use

See Also:

DatabasePlatform

setProjectPoolName

public void setProjectPoolName(java.lang.String projectPoolName)

Set the name of the JDBC connection pool to be used by the project. This pool will be the one that is used to get JDBC connections from and issue SQL to the database. For CMP this should be a JTS driver pool.

This attribute is required if no ProjectDataSource was set. This attribute may not be specified if a ProjectDataSource was set.

Parameters:

projectPoolName - the name of JTS driver connection pool

setProjectReadOnlyDataSource

public void setProjectReadOnlyDataSource(java.lang.String projectReadOnlyDataSource)

Set the name of the JDBC DataSource to be used by the project for reading only. This is necessary since TopLink must perform some reads outside the context of a transaction. Because data sources are defined as JTS or not, we need to have two data sources defined (one JTS, one not). This DataSource will be the one that is used to get JDBC connections from and issue SQL to the database. This should be a non-JTS data source.

This attribute is required if no ProjectPoolName was set. This attribute may not be specified if a ProjectPoolName was set.

Parameters:

projectReadOnlyDataSource - the name of the read-only data source

setTransactionIsolation

public void setTransactionIsolation(java.lang.String transactionIsolation)

Set the transaction isolation level for the project. If set, this isolation level will override the default one for the database.

This attribute is optional.

Parameters:

transactionIsolation - the name of the supported transaction isolation level

setUpdatePropagation

public void setUpdatePropagation(java.lang.String updatePropagationMode)

Enable update propagation for the project. If set, this will cause updates to be propagated to other participating servers.

This attribute is optional.

Parameters:

updatePropagationMode - the mode of propagation (synchronous or asynchronous)