xdoclet.modules.hibernate

Class JBossServiceSubTask

Implemented Interfaces:
HibernateProperties, Serializable

public class JBossServiceSubTask
extends xdoclet.XmlSubTask
implements HibernateProperties

Generate jboss mbean descriptor for hibernated classes
Version:
$Revision: 1.18 $
Authors:
Konstantin Pribluda (kpribluda@j-tec-team.de)
Heiko W. Rupp (pilhuhn at users dot sf dot net)
ant.element
name = "jbossservice" display-name = "JBoss service configuration" parent = "xdoclet.modules.hibernate.HibernateDocletTask"
created
December 11, 2002

Nested Class Summary

Nested classes/interfaces inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

JBossServiceSubTask()
Constructor for the HibernateSubTask object

Method Summary

protected void
engineStarted()
Called when the engine is started
String
getAutoCreate()
String
getCacheProvider()
String
getDataSource()
String
getDefaultSchema()
String
getDepends()
String
getDialect()
String
getDriver()
String
getJdbcFetchSize()
String
getJdbcUrl()
String
getJndiName()
Collection
getJndiProperties()
String
getMaxFetchDepth()
Collection
getOtherMappings()
Collection
getOtherProperties()
String
getPassword()
String
getPoolSize()
String
getQuerySubstitutions()
String
getServiceName()
return configured service name
boolean
getShowSql()
String
getTransactionManagerStrategy()
String
getTransactionStrategy()
boolean
getUseOuterJoin()
String
getUseQueryCache()
String
getUserName()
String
getUserTransactionName()
String
getVersion()
void
setAutoCreate(String autoCreate)
Parameter for hibernate.hbm2ddl.auto property.
void
setCacheProvider(String cacheProvider)
The fully qualified class name of the Hibernate CacheProvider implementation.
void
setDataSource(String dataSource)
JNDI name of data source to use in the session factory.
void
setDefaultSchema(String string)
Only for Hibernate 2.1+
void
setDepends(String depends)
The complete name of the data source service name that this service depends on.
void
setDialect(String dialect)
SQL dialect of the database.
void
setJdbcFetchSize(String string)
Only for Hibernate 2.1+
void
setJndiName(String jndiName)
JNDI name to bind to the SessionFactory
void
setMaxFetchDepth(String string)
Only for Hibernate 2.1+
void
setPassword(String password)
Use this password to login to the database
void
setQuerySubstitutions(String string)
Only for Hibernate 2.1+
void
setServiceName(String serviceName)
void
setShowSql(boolean showSql)
Log sql statements.
void
setTransactionManagerStrategy(String transactionManagerStrategy)
Strategy for obtaining the JTA TransactionManager
void
setTransactionStrategy(String transactionStrategy)
The fully qualified class name of the Hibernate TransactionFactory implementation.
void
setUseOuterJoin(boolean useOuterJoin)
Whether to use outer join
void
setUseQueryCache(String string)
Only for Hibernate 2.1+
void
setUserName(String userName)
Use this user name to login to the database
void
setUserTransactionName(String userTransactionName)
The JNDI name of the JTA UserTransaction object
void
setVersion(String version)
Set the Hibernate version that the jboss service should be generated for.
void
validateOptions()

Methods inherited from class xdoclet.XmlSubTask

copyAttributesFrom, engineFinished, getDtdURL, getPublicId, getSchema, getSchemaURL, getSystemId, getUseIds, getXmlencoding, isValidateXML, setDtdURL, setPublicId, setSchema, setSchemaURL, setSystemId, setUseIds, setValidateXML, setXmlencoding, startProcess

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Constructor Details

JBossServiceSubTask

public JBossServiceSubTask()
Constructor for the HibernateSubTask object

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Called when the engine is started
Overrides:
engineStarted in interface xdoclet.TemplateSubTask
Throws:
xdoclet.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 -
ant.not-required

setCacheProvider

public void setCacheProvider(String cacheProvider)
The fully qualified class name of the Hibernate CacheProvider implementation. For Hibernate 2.1+ only.
Parameters:
cacheProvider -
ant.not-required

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 -
ant.not-required

setDefaultSchema

public void setDefaultSchema(String string)
Only for Hibernate 2.1+
Parameters:
string -
ant.not-required

setDepends

public void setDepends(String depends)
The complete name of the data source service name that this service depends on.
Parameters:
depends -
ant.not-required

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 -
ant.not-required

setJdbcFetchSize

public void setJdbcFetchSize(String string)
Only for Hibernate 2.1+
Parameters:
string -
ant.not-required

setJndiName

public void setJndiName(String jndiName)
JNDI name to bind to the SessionFactory
Parameters:
jndiName -
ant.required

setMaxFetchDepth

public void setMaxFetchDepth(String string)
Only for Hibernate 2.1+
Parameters:
string -
ant.not-required

setPassword

public void setPassword(String password)
Use this password to login to the database
Parameters:
password -
ant.not-required

setQuerySubstitutions

public void setQuerySubstitutions(String string)
Only for Hibernate 2.1+
Parameters:
string -
ant.not-required

setServiceName

public void setServiceName(String serviceName)
Parameters:
serviceName -
ant.required

setShowSql

public void setShowSql(boolean showSql)
Log sql statements.
Parameters:
showSql -
ant.not-required
No.Defaultsto false.

setTransactionManagerStrategy

public void setTransactionManagerStrategy(String transactionManagerStrategy)
Strategy for obtaining the JTA TransactionManager
Parameters:
transactionManagerStrategy -
ant.required

setTransactionStrategy

public void setTransactionStrategy(String transactionStrategy)
The fully qualified class name of the Hibernate TransactionFactory implementation.
Parameters:
transactionStrategy -
ant.not-required

setUseOuterJoin

public void setUseOuterJoin(boolean useOuterJoin)
Whether to use outer join
Parameters:
useOuterJoin -
ant.not-required
No.Defaultsto false.

setUseQueryCache

public void setUseQueryCache(String string)
Only for Hibernate 2.1+
Parameters:
string -
ant.not-required

setUserName

public void setUserName(String userName)
Use this user name to login to the database
Parameters:
userName -
ant.not-required

setUserTransactionName

public void setUserTransactionName(String userTransactionName)
The JNDI name of the JTA UserTransaction object
Parameters:
userTransactionName -
ant.not-required

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 -
ant.not-required

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.TemplateSubTask