xdoclet.modules.hibernate
Class JBossServiceSubTask

java.lang.Object
  extended by xdoclet.DocletSupport
      extended by xdoclet.SubTask
          extended by xdoclet.TemplateSubTask
              extended by xdoclet.XmlSubTask
                  extended by xdoclet.modules.hibernate.JBossServiceSubTask
All Implemented Interfaces:
java.io.Serializable, xdoclet.modules.hibernate.HibernateProperties

public class JBossServiceSubTask
extends XmlSubTask
implements xdoclet.modules.hibernate.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)
See Also:
Serialized Form
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
 java.lang.String getAutoCreate()
           
 java.lang.String getCacheProvider()
           
 java.lang.String getDataSource()
           
 java.lang.String getDefaultSchema()
           
 java.lang.String getDepends()
           
 java.lang.String getDialect()
           
 java.lang.String getDriver()
           
 java.lang.String getJdbcFetchSize()
           
 java.lang.String getJdbcUrl()
           
 java.lang.String getJndiName()
           
 java.util.Collection getJndiProperties()
           
 java.lang.String getMaxFetchDepth()
           
 java.util.Collection getOtherMappings()
           
 java.util.Collection getOtherProperties()
           
 java.lang.String getPassword()
           
 java.lang.String getPoolSize()
           
 java.lang.String getQuerySubstitutions()
           
 java.lang.String getServiceName()
          return configured service name
 boolean getShowSql()
           
 java.lang.String getTransactionManagerStrategy()
           
 java.lang.String getTransactionStrategy()
           
 boolean getUseOuterJoin()
           
 java.lang.String getUseQueryCache()
           
 java.lang.String getUserName()
           
 java.lang.String getUserTransactionName()
           
 java.lang.String getVersion()
           
 void setAutoCreate(java.lang.String autoCreate)
          Parameter for hibernate.hbm2ddl.auto property.
 void setCacheProvider(java.lang.String cacheProvider)
          The fully qualified class name of the Hibernate CacheProvider implementation.
 void setDataSource(java.lang.String dataSource)
          JNDI name of data source to use in the session factory.
 void setDefaultSchema(java.lang.String string)
          Only for Hibernate 2.1+
 void setDepends(java.lang.String depends)
          The complete name of the data source service name that this service depends on.
 void setDialect(java.lang.String dialect)
          SQL dialect of the database.
 void setJdbcFetchSize(java.lang.String string)
          Only for Hibernate 2.1+
 void setJndiName(java.lang.String jndiName)
          JNDI name to bind to the SessionFactory
 void setMaxFetchDepth(java.lang.String string)
          Only for Hibernate 2.1+
 void setPassword(java.lang.String password)
          Use this password to login to the database
 void setQuerySubstitutions(java.lang.String string)
          Only for Hibernate 2.1+
 void setServiceName(java.lang.String serviceName)
           
 void setShowSql(boolean showSql)
          Log sql statements.
 void setTransactionManagerStrategy(java.lang.String transactionManagerStrategy)
          Strategy for obtaining the JTA TransactionManager
 void setTransactionStrategy(java.lang.String transactionStrategy)
          The fully qualified class name of the Hibernate TransactionFactory implementation.
 void setUseOuterJoin(boolean useOuterJoin)
          Whether to use outer join
 void setUseQueryCache(java.lang.String string)
          Only for Hibernate 2.1+
 void setUserName(java.lang.String userName)
          Use this user name to login to the database
 void setUserTransactionName(java.lang.String userTransactionName)
          The JNDI name of the JTA UserTransaction object
 void setVersion(java.lang.String version)
          Set the Hibernate version that the jboss service should be generated for.
 void validateOptions()
          Called to validate configuration parameters.
 
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, 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, startProcessForAll, startProcessPerClass
 
Methods inherited from class xdoclet.SubTask
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JBossServiceSubTask

public JBossServiceSubTask()
Constructor for the HibernateSubTask object

Method Detail

getTransactionManagerStrategy

public java.lang.String getTransactionManagerStrategy()
Specified by:
getTransactionManagerStrategy in interface xdoclet.modules.hibernate.HibernateProperties

getUserTransactionName

public java.lang.String getUserTransactionName()
Specified by:
getUserTransactionName in interface xdoclet.modules.hibernate.HibernateProperties

getTransactionStrategy

public java.lang.String getTransactionStrategy()

getCacheProvider

public java.lang.String getCacheProvider()

getDepends

public java.lang.String getDepends()

getUserName

public java.lang.String getUserName()
Specified by:
getUserName in interface xdoclet.modules.hibernate.HibernateProperties

getPassword

public java.lang.String getPassword()
Specified by:
getPassword in interface xdoclet.modules.hibernate.HibernateProperties

getUseOuterJoin

public boolean getUseOuterJoin()
Specified by:
getUseOuterJoin in interface xdoclet.modules.hibernate.HibernateProperties

getShowSql

public boolean getShowSql()
Specified by:
getShowSql in interface xdoclet.modules.hibernate.HibernateProperties

getServiceName

public java.lang.String getServiceName()
return configured service name

Returns:

getJndiName

public java.lang.String getJndiName()
Specified by:
getJndiName in interface xdoclet.modules.hibernate.HibernateProperties

getDataSource

public java.lang.String getDataSource()
Specified by:
getDataSource in interface xdoclet.modules.hibernate.HibernateProperties

getDialect

public java.lang.String getDialect()
Specified by:
getDialect in interface xdoclet.modules.hibernate.HibernateProperties

getAutoCreate

public java.lang.String getAutoCreate()

getDriver

public java.lang.String getDriver()
Specified by:
getDriver in interface xdoclet.modules.hibernate.HibernateProperties

getJdbcUrl

public java.lang.String getJdbcUrl()
Specified by:
getJdbcUrl in interface xdoclet.modules.hibernate.HibernateProperties

getPoolSize

public java.lang.String getPoolSize()
Specified by:
getPoolSize in interface xdoclet.modules.hibernate.HibernateProperties

getJndiProperties

public java.util.Collection getJndiProperties()
Specified by:
getJndiProperties in interface xdoclet.modules.hibernate.HibernateProperties

getOtherProperties

public java.util.Collection getOtherProperties()
Specified by:
getOtherProperties in interface xdoclet.modules.hibernate.HibernateProperties

getOtherMappings

public java.util.Collection getOtherMappings()
Specified by:
getOtherMappings in interface xdoclet.modules.hibernate.HibernateProperties

getDefaultSchema

public java.lang.String getDefaultSchema()
Returns:

getJdbcFetchSize

public java.lang.String getJdbcFetchSize()
Returns:

getMaxFetchDepth

public java.lang.String getMaxFetchDepth()
Returns:

getQuerySubstitutions

public java.lang.String getQuerySubstitutions()
Returns:

getUseQueryCache

public java.lang.String getUseQueryCache()
Returns:

getVersion

public java.lang.String getVersion()

setAutoCreate

public void setAutoCreate(java.lang.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

setTransactionManagerStrategy

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

Parameters:
transactionManagerStrategy -
ant.required

setUserTransactionName

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

Parameters:
userTransactionName -
ant.not-required

setTransactionStrategy

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

Parameters:
transactionStrategy -
ant.not-required

setCacheProvider

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

Parameters:
cacheProvider -
ant.not-required

setDepends

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

Parameters:
depends -
ant.not-required

setUserName

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

Parameters:
userName -
ant.not-required

setPassword

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

Parameters:
password -
ant.not-required

setUseOuterJoin

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

Parameters:
useOuterJoin -
ant.not-required
No.Defaultsto false.

setShowSql

public void setShowSql(boolean showSql)
Log sql statements.

Parameters:
showSql -
ant.not-required
No.Defaultsto false.

setServiceName

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

setJndiName

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

Parameters:
jndiName -
ant.required

setDataSource

public void setDataSource(java.lang.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

setDialect

public void setDialect(java.lang.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

setDefaultSchema

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

Parameters:
string -
ant.not-required

setJdbcFetchSize

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

Parameters:
string -
ant.not-required

setMaxFetchDepth

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

Parameters:
string -
ant.not-required

setQuerySubstitutions

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

Parameters:
string -
ant.not-required

setUseQueryCache

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

Parameters:
string -
ant.not-required

setVersion

public void setVersion(java.lang.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 XDocletException
Description copied from class: TemplateSubTask
Called to validate configuration parameters.

Overrides:
validateOptions in class TemplateSubTask
Throws:
XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException
Called when the engine is started

Overrides:
engineStarted in class TemplateSubTask
Throws:
XDocletException - Thrown in case of problem

http://xdoclet.sourceforge.net/