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

UNKNOWN: October 01, 2002 display-name = "SunONE" name = "sunone" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "ejb-env-entries-{0}.xml" relates-to = "ias-ejb-jar.xml" description = "Same as for * <deploymentdescriptor> subtask (only used for MDBs)." file = "mdb-ejbrefs-{0}.xml" relates-to = "ias-ejb-jar.xml" description = "Same as for * <deploymentdescriptor> subtask, except root element name is mdb-ejb-ref rather than ejb-ref (only used for * MDBs)." file = "mdb-resourcerefs-{0}.xml" relates-to = "ias-ejb-jar.xml" description = "Same as for * <deploymentdescriptor> subtask, except root element name is mdb-resource-ref rather than resource-ref * (only used for MDBs)." file = "ejb-resource-env-refs-{0}.xml" relates-to = "ias-ejb-jar.xml" description = "Same as for * <deploymentdescriptor> subtask (only used for MDBs)." file = "sunone-role-mappings.ent" relates-to = "ias-ejb-jar.xml, sun-ejb-jar.xml" description = "An * Unparsed XML Entity file that contains the <role-mapping> elements." file = "sunone-pm-descriptors.xml" relates-to = "sun-ejb-jar.xml" description = "An XML Document * containing the <pm-descriptors> element." file = "sunone-ior-security-config-{0}.xml" relates-to = "sun-ejb-jar.xml" description = "An XML * Document containing the <ior-security-config> element for a bean." allow for overriding the CMP templates etc. secondary-table element is not currently supported in the cmp mappings file

Nested Class Summary
static classSunONESubTask.SunONEVersionTypes
Constructor Summary
SunONESubTask()
Method Summary
voidexecute()
StringgetCmpDestinationFile()
Gets the destination filename of the CMP mappings file.
StringgetCmpResourceJndiName()
Return the CMP Resource JNDI name.
StringgetCmpResourcePrincipalName()
Return the CMP Resource Principal name.
StringgetCmpResourcePrincipalPassword()
Return the CMP Resource Principal password.
StringgetCmpSchema()
Return the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
StringgetCmpTemplateFile()
Gets the name of the sun-cmp-mappings.xml template file.
StringgetTransactionManagerType()
Return the default transaction manager type.
StringgetVersion()
Return the iPlanet/SunONE version.
voidsetCmpDestinationFile(String cmpDestinationFile)
Sets the destination filename of the CMP mappings file.
voidsetCmpResourceJndiName(String cmpResourceJndiName)
Specifies the absolute jndi-name of the database to be used for storing CMP beans in the EJB JAR file.
voidsetCmpResourcePrincipalName(String cmpResourcePrincipalName)
Specifies the default sign-on name to the resource manager.
voidsetCmpResourcePrincipalPassword(String cmpResourcePrincipalPassword)
Specifies the default password to the resource manager.
voidsetCmpSchema(String cmpSchema)
Specifies the database schema filename (minus .dbschema extension), as captured using Sun's utilities.
voidsetCmpTemplateFile(String cmpTemplateFile)
Sets the name of the sun-cmp-mappings.xml template file.
voidsetTransactionManagerType(String transactionManagerType)
Optional default transaction manager type for all components.
voidsetVersion(SunONESubTask.SunONEVersionTypes version)
The SunONE/iPlanet version.
voidvalidateOptions()
Called to validate configuration parameters.

Constructor Detail

SunONESubTask

public SunONESubTask()

Method Detail

execute

public void execute()

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

UNKNOWN:

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

UNKNOWN: "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

UNKNOWN: 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

UNKNOWN: 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

UNKNOWN: 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

UNKNOWN:

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"

UNKNOWN: "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

UNKNOWN: "No, default is '7.0'."

validateOptions

public void validateOptions()
Called to validate configuration parameters.

Throws: XDocletException Description of Exception