xdoclet.modules.sun.sunone.ejb

Class SunONESubTask


public class SunONESubTask
extends AbstractEjbDeploymentDescriptorSubTask

Generates configuration files for EJB jars in iPlanet/SunONE
Version:
$Revision: 1.3 $
Author:
Andrew Stevens
ant.element
display-name = "SunONE" name = "sunone" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
October 01, 2002
To do:
allow for overriding the CMP templates etc.
secondary-table element is not currently supported in the cmp mappings file

Nested Class Summary

static class
SunONESubTask.SunONEVersionTypes

Constructor Summary

SunONESubTask()

Method Summary

void
execute()
String
getCmpDestinationFile()
Gets the destination filename of the CMP mappings file.
String
getCmpResourceJndiName()
Return the CMP Resource JNDI name.
String
getCmpResourcePrincipalName()
Return the CMP Resource Principal name.
String
getCmpResourcePrincipalPassword()
Return the CMP Resource Principal password.
String
getCmpSchema()
Return the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
String
getCmpTemplateFile()
Gets the name of the sun-cmp-mappings.xml template file.
String
getTransactionManagerType()
Return the default transaction manager type.
String
getVersion()
Return the iPlanet/SunONE version.
void
setCmpDestinationFile(String cmpDestinationFile)
Sets the destination filename of the CMP mappings file.
void
setCmpResourceJndiName(String cmpResourceJndiName)
Specifies the absolute jndi-name of the database to be used for storing CMP beans in the EJB JAR file.
void
setCmpResourcePrincipalName(String cmpResourcePrincipalName)
Specifies the default sign-on name to the resource manager.
void
setCmpResourcePrincipalPassword(String cmpResourcePrincipalPassword)
Specifies the default password to the resource manager.
void
setCmpSchema(String cmpSchema)
Specifies the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
void
setCmpTemplateFile(String cmpTemplateFile)
Sets the name of the sun-cmp-mappings.xml template file.
void
setTransactionManagerType(String transactionManagerType)
Optional default transaction manager type for all components.
void
setVersion(SunONESubTask.SunONEVersionTypes version)
The SunONE/iPlanet version.
void
validateOptions()
Called to validate configuration parameters.

Constructor Details

SunONESubTask

public SunONESubTask()

Method Details

execute

public void execute()
            throws xdoclet.XDocletException

getCmpDestinationFile

public String getCmpDestinationFile()
Gets the destination filename of the CMP mappings file.
Returns:
the destination filename

getCmpResourceJndiName

public String getCmpResourceJndiName()
Return the CMP Resource JNDI name.
Returns:
The CMP Resource JNDI name

getCmpResourcePrincipalName

public String getCmpResourcePrincipalName()
Return the CMP Resource Principal name.
Returns:
The CMP Resource Principal name

getCmpResourcePrincipalPassword

public String getCmpResourcePrincipalPassword()
Return the CMP Resource Principal password.
Returns:
The CMP Resource Principal password

getCmpSchema

public String getCmpSchema()
Return the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
Returns:
The schema filename

getCmpTemplateFile

public String getCmpTemplateFile()
Gets the name of the sun-cmp-mappings.xml template file.
Returns:
the custom template file

getTransactionManagerType

public String getTransactionManagerType()
Return the default transaction manager type.
Returns:
The transaction manager type

getVersion

public String getVersion()
Return the iPlanet/SunONE version.
Returns:
The iPlanet/SunONE version

setCmpDestinationFile

public void setCmpDestinationFile(String cmpDestinationFile)
Sets the destination filename of the CMP mappings file.
Parameters:
cmpDestinationFile - the destination filename
ant.not-required

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.
Parameters:
cmpResourceJndiName - String containing the JNDI name
ant.not-required
"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.
Parameters:
cmpResourcePrincipalName - String containing the name
ant.not-required
Onlyusedif cmpResourceJndiNameparameteris specified,andoptional eventhen.

setCmpResourcePrincipalPassword

public void setCmpResourcePrincipalPassword(String cmpResourcePrincipalPassword)
Specifies the default password to the resource manager.
Parameters:
cmpResourcePrincipalPassword - String containing the password
ant.not-required
Onlyusedif thecmpResourcePrincipalNameparameter isspecified.

setCmpSchema

public void setCmpSchema(String cmpSchema)
Specifies the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
Parameters:
cmpSchema - String containing the schema name
ant.not-required
Onlyusedwith CMPentitybeans.

setCmpTemplateFile

public void setCmpTemplateFile(String cmpTemplateFile)
Sets the name of the sun-cmp-mappings.xml template file.
Parameters:
cmpTemplateFile - the name of the custom template file
ant.not-required

setTransactionManagerType

public void setTransactionManagerType(String transactionManagerType)
Optional default transaction manager type for all components. Allowed values are 'local' and 'global'.
Parameters:
transactionManagerType - "local" or "global"
ant.not-required
"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.
Parameters:
version - The new Version value
ant.not-required
"No, default is '7.0'."

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Called to validate configuration parameters.
Throws:
xdoclet.XDocletException - Description of Exception