xdoclet.modules.sun.sunone.ejb
Class SunONESubTask
AbstractEjbDeploymentDescriptorSubTask
xdoclet.modules.sun.sunone.ejb.SunONESubTask
public class SunONESubTask
extends AbstractEjbDeploymentDescriptorSubTask
Generates configuration files for EJB jars in iPlanet/SunONE
- display-name = "SunONE"
name = "sunone"
parent = "xdoclet.modules.ejb.EjbDocletTask"
- allow for overriding the CMP templates etc.
- secondary-table element is not currently supported in the cmp mappings file
SunONESubTask
public SunONESubTask()
execute
public void execute()
throws xdoclet.XDocletException
getCmpDestinationFile
public String getCmpDestinationFile()
Gets the destination filename of the CMP mappings file.
getCmpResourceJndiName
public String getCmpResourceJndiName()
Return the CMP Resource JNDI name.
- The CMP Resource JNDI name
getCmpResourcePrincipalName
public String getCmpResourcePrincipalName()
Return the CMP Resource Principal name.
- The CMP Resource Principal name
getCmpResourcePrincipalPassword
public String getCmpResourcePrincipalPassword()
Return the CMP Resource Principal password.
- The CMP Resource Principal password
getCmpSchema
public String getCmpSchema()
Return the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
getCmpTemplateFile
public String getCmpTemplateFile()
Gets the name of the sun-cmp-mappings.xml template file.
getTransactionManagerType
public String getTransactionManagerType()
Return the default transaction manager type.
- The transaction manager type
getVersion
public String getVersion()
Return the iPlanet/SunONE version.
- The iPlanet/SunONE version
setCmpDestinationFile
public void setCmpDestinationFile(String cmpDestinationFile)
Sets the destination filename of the CMP mappings file.
cmpDestinationFile
- the destination filename
setCmpResourceJndiName
public void setCmpResourceJndiName(String cmpResourceJndiName)
Specifies the absolute jndi-name of the database to be used for storing CMP beans in the EJB JAR file.
cmpResourceJndiName
- String containing the JNDI name
- "Only used for version = 7.0, and optional even then."
setCmpResourcePrincipalName
public void setCmpResourcePrincipalName(String cmpResourcePrincipalName)
Specifies the default sign-on name to the resource manager.
cmpResourcePrincipalName
- String containing the name
- Onlyusedif
cmpResourceJndiNameparameteris
specified,andoptional
eventhen.
setCmpResourcePrincipalPassword
public void setCmpResourcePrincipalPassword(String cmpResourcePrincipalPassword)
Specifies the default password to the resource manager.
cmpResourcePrincipalPassword
- String containing the password
- Onlyusedif
thecmpResourcePrincipalNameparameter
isspecified.
setCmpSchema
public void setCmpSchema(String cmpSchema)
Specifies the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
cmpSchema
- String containing the schema name
- Onlyusedwith
CMPentitybeans.
setCmpTemplateFile
public void setCmpTemplateFile(String cmpTemplateFile)
Sets the name of the sun-cmp-mappings.xml template file.
cmpTemplateFile
- the name of the custom template file
setTransactionManagerType
public void setTransactionManagerType(String transactionManagerType)
Optional default transaction manager type for all components. Allowed values are 'local' and 'global'.
transactionManagerType
- "local" or "global"
- "Only used for version = 6.5, and optional even then."
setVersion
public void setVersion(SunONESubTask.SunONEVersionTypes version)
The SunONE/iPlanet version. Supported versions are 6.0, 6.5 and 7.0.
version
- The new Version value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
- Description of Exception