xdoclet.modules.hibernate

Class JBossServiceSubTask

public class JBossServiceSubTask extends XmlSubTask implements HibernateProperties

Generate jboss mbean descriptor for hibernated classes

Version: $Revision: 1.18 $

Author: Konstantin Pribluda (kpribluda@j-tec-team.de) Heiko W. Rupp (pilhuhn at users dot sf dot net)

UNKNOWN: December 11, 2002 name = "jbossservice" display-name = "JBoss service configuration" parent = "xdoclet.modules.hibernate.HibernateDocletTask" file = "jboss-service-custom.xdt" relates-to = "jboss-service.xml" description = "An XML unparsed * entity or XDoclet template file, for custom elements to be included in the generated jboss-service.xml" file = "jboss-service-custom-attributes.ent" relates-to = "jboss-service.xml" description = "An XML * unparsed entity for custom attributes to be included within the <mbean/> block of the generated * jboss-service.xml"

Constructor Summary
JBossServiceSubTask()
Constructor for the HibernateSubTask object
Method Summary
protected voidengineStarted()
Called when the engine is started
StringgetAutoCreate()
StringgetCacheProvider()
StringgetDataSource()
StringgetDefaultSchema()
StringgetDepends()
StringgetDialect()
StringgetDriver()
StringgetJdbcFetchSize()
StringgetJdbcUrl()
StringgetJndiName()
CollectiongetJndiProperties()
StringgetMaxFetchDepth()
CollectiongetOtherMappings()
CollectiongetOtherProperties()
StringgetPassword()
StringgetPoolSize()
StringgetQuerySubstitutions()
StringgetServiceName()
return configured service name
booleangetShowSql()
StringgetTransactionManagerStrategy()
StringgetTransactionStrategy()
booleangetUseOuterJoin()
StringgetUseQueryCache()
StringgetUserName()
StringgetUserTransactionName()
StringgetVersion()
voidsetAutoCreate(String autoCreate)
Parameter for hibernate.hbm2ddl.auto property.
voidsetCacheProvider(String cacheProvider)
The fully qualified class name of the Hibernate CacheProvider implementation.
voidsetDataSource(String dataSource)
JNDI name of data source to use in the session factory.
voidsetDefaultSchema(String string)
Only for Hibernate 2.1+
voidsetDepends(String depends)
The complete name of the data source service name that this service depends on.
voidsetDialect(String dialect)
SQL dialect of the database.
voidsetJdbcFetchSize(String string)
Only for Hibernate 2.1+
voidsetJndiName(String jndiName)
JNDI name to bind to the SessionFactory
voidsetMaxFetchDepth(String string)
Only for Hibernate 2.1+
voidsetPassword(String password)
Use this password to login to the database
voidsetQuerySubstitutions(String string)
Only for Hibernate 2.1+
voidsetServiceName(String serviceName)
voidsetShowSql(boolean showSql)
Log sql statements.
voidsetTransactionManagerStrategy(String transactionManagerStrategy)
Strategy for obtaining the JTA TransactionManager
voidsetTransactionStrategy(String transactionStrategy)
The fully qualified class name of the Hibernate TransactionFactory implementation.
voidsetUseOuterJoin(boolean useOuterJoin)
Whether to use outer join
voidsetUseQueryCache(String string)
Only for Hibernate 2.1+
voidsetUserName(String userName)
Use this user name to login to the database
voidsetUserTransactionName(String userTransactionName)
The JNDI name of the JTA UserTransaction object
voidsetVersion(String version)
Set the Hibernate version that the jboss service should be generated for.
voidvalidateOptions()

Constructor Detail

JBossServiceSubTask

public JBossServiceSubTask()
Constructor for the HibernateSubTask object

Method Detail

engineStarted

protected void engineStarted()
Called when the engine is started

Throws: XDocletException Thrown in case of problem

getAutoCreate

public String getAutoCreate()

getCacheProvider

public String getCacheProvider()

getDataSource

public String getDataSource()

getDefaultSchema

public String getDefaultSchema()

Returns:

getDepends

public String getDepends()

getDialect

public String getDialect()

getDriver

public String getDriver()

getJdbcFetchSize

public String getJdbcFetchSize()

Returns:

getJdbcUrl

public String getJdbcUrl()

getJndiName

public String getJndiName()

getJndiProperties

public Collection getJndiProperties()

getMaxFetchDepth

public String getMaxFetchDepth()

Returns:

getOtherMappings

public Collection getOtherMappings()

getOtherProperties

public Collection getOtherProperties()

getPassword

public String getPassword()

getPoolSize

public String getPoolSize()

getQuerySubstitutions

public String getQuerySubstitutions()

Returns:

getServiceName

public String getServiceName()
return configured service name

Returns:

getShowSql

public boolean getShowSql()

getTransactionManagerStrategy

public String getTransactionManagerStrategy()

getTransactionStrategy

public String getTransactionStrategy()

getUseOuterJoin

public boolean getUseOuterJoin()

getUseQueryCache

public String getUseQueryCache()

Returns:

getUserName

public String getUserName()

getUserTransactionName

public String getUserTransactionName()

getVersion

public String getVersion()

setAutoCreate

public void setAutoCreate(String autoCreate)
Parameter for hibernate.hbm2ddl.auto property. Available since hibernate 2.1.6. Allowed values are 'create', 'create-drop' and 'update'.

Parameters: autoCreate

UNKNOWN:

setCacheProvider

public void setCacheProvider(String cacheProvider)
The fully qualified class name of the Hibernate CacheProvider implementation. For Hibernate 2.1+ only.

Parameters: cacheProvider

UNKNOWN:

setDataSource

public void setDataSource(String dataSource)
JNDI name of data source to use in the session factory. Note, that if you don't supply it here, you have to have it in a hibernate.properties file in your classpath.

Parameters: dataSource

UNKNOWN:

setDefaultSchema

public void setDefaultSchema(String string)
Only for Hibernate 2.1+

Parameters: string

UNKNOWN:

setDepends

public void setDepends(String depends)
The complete name of the data source service name that this service depends on.

Parameters: depends

UNKNOWN:

setDialect

public void setDialect(String dialect)
SQL dialect of the database. Note, that if you don't supply it here, you have to have it in a hibernate.properties file in your classpath. Use the fully-qualified class name of the dialect here.

Parameters: dialect

UNKNOWN:

setJdbcFetchSize

public void setJdbcFetchSize(String string)
Only for Hibernate 2.1+

Parameters: string

UNKNOWN:

setJndiName

public void setJndiName(String jndiName)
JNDI name to bind to the SessionFactory

Parameters: jndiName

UNKNOWN:

setMaxFetchDepth

public void setMaxFetchDepth(String string)
Only for Hibernate 2.1+

Parameters: string

UNKNOWN:

setPassword

public void setPassword(String password)
Use this password to login to the database

Parameters: password

UNKNOWN:

setQuerySubstitutions

public void setQuerySubstitutions(String string)
Only for Hibernate 2.1+

Parameters: string

UNKNOWN:

setServiceName

public void setServiceName(String serviceName)

Parameters: serviceName

UNKNOWN:

setShowSql

public void setShowSql(boolean showSql)
Log sql statements.

Parameters: showSql

UNKNOWN: No.Defaultsto false.

setTransactionManagerStrategy

public void setTransactionManagerStrategy(String transactionManagerStrategy)
Strategy for obtaining the JTA TransactionManager

Parameters: transactionManagerStrategy

UNKNOWN:

setTransactionStrategy

public void setTransactionStrategy(String transactionStrategy)
The fully qualified class name of the Hibernate TransactionFactory implementation.

Parameters: transactionStrategy

UNKNOWN:

setUseOuterJoin

public void setUseOuterJoin(boolean useOuterJoin)
Whether to use outer join

Parameters: useOuterJoin

UNKNOWN: No.Defaultsto false.

setUseQueryCache

public void setUseQueryCache(String string)
Only for Hibernate 2.1+

Parameters: string

UNKNOWN:

setUserName

public void setUserName(String userName)
Use this user name to login to the database

Parameters: userName

UNKNOWN:

setUserTransactionName

public void setUserTransactionName(String userTransactionName)
The JNDI name of the JTA UserTransaction object

Parameters: userTransactionName

UNKNOWN:

setVersion

public void setVersion(String version)
Set the Hibernate version that the jboss service should be generated for. Values are "1.1", "2.0" and "2.1". This value normally corresponds to the setting of the hibernate subtask. Default is "2.1" !

Parameters: version

UNKNOWN:

validateOptions

public void validateOptions()