xdoclet.modules.jboss.ejb

Class JBossSubTask


public class JBossSubTask
extends AbstractEjbDeploymentDescriptorSubTask

Creates jboss.xml, jaws.xml and/or jbosscmp-jdbc.xml deployment descriptors for JBoss. The destinationFile attribute is ignored because this subtask creates multiple deployment descriptor files.
Version:
$Revision: 1.35 $
Authors:
Ara Abrahamian (ara_e@email.com)
Dmitri Colebatch (dim@bigpond.net.au)
ant.element
display-name = "JBoss" name = "jboss" parent = "xdoclet.modules.ejb.EjbDocletTask"
created
Oct 15, 2001

Nested Class Summary

static class
JBossSubTask.JBossVersionTypes

Method Summary

protected void
engineStarted()
void
execute()
String
getAlterTable()
Gets the alterTable attribute of the JBossSubTask object.
String
getCreateTable()
Gets the createTable attribute of the JBossSubTask object.
String
getDatasource()
Gets the Datasource attribute of the JBossSubTask object
String
getDatasourceMapping()
Gets the DatasourceMapping attribute of the JBossSubTask object
String
getDebug()
Gets the Debug attribute of the JBossSubTask object
String
getGenerateRelations()
Gets the GenerateRelations attribute of the JBossSubTask object
URL
getJawsTemplateURL()
Gets the template URL for jaws.xml .
URL
getJbossTemplateURL()
Gets the template URL for jboss.xml.
URL
getJbosscmpTemplateURL()
Gets the template URL for jbosscmp-jdbc.xml.
String
getPreferredRelationMapping()
Gets the preferredRelationMapping attribute of the JBossSubTask object.
String
getRemoveTable()
Gets the createTable attribute of the JBossSubTask object.
String
getSecurityDomain()
Gets the SecurityDomain attribute of the JBossSubTask object
String
getTypemapping()
Gets the Typemapping attribute of the JBossSubTask object
String
getUnauthenticatedPrincipal()
Gets the unauthenticated principal name to use.
String
getVersion()
Gets the Version attribute of the JBossSubTask object
String
getWebServiceContextRoot()
Get the web service context root.
void
setAlterTable(String alterTable)
void
setCreateTable(String createTable)
void
setDatasource(String datasource)
Sets the Datasource attribute of the JBossSubTask object
void
setDatasourceMapping(String datasourceMapping)
void
setDebug(String debug)
Debug flag for jaws.xml.
void
setGenerateRelations(String generateRelations)
void
setJawsTemplateFile(File jawsTemplateFile)
Sets the template file for jaws.xml.
void
setJbossTemplateFile(File jbossTemplateFile)
Sets the template file for jboss.xml.
void
setJbosscmpTemplateFile(File jbosscmpTemplateFile)
Sets the template file for jbosscmp-jdbc.xml.
void
setPreferredRelationMapping(String preferredRelationMapping)
void
setRemoveTable(String removeTable)
void
setSecurityDomain(String aSecurityDomain)
The security domain to use.
void
setTypemapping(String typemapping)
void
setUnauthenticatedPrincipal(String anUnauthenticatedPrincipal)
The unauthenticated principal name to use.
void
setVersion(JBossSubTask.JBossVersionTypes version)
The version of JBoss.
void
setWebServiceContextRoot(String webServiceContextRoot)
Set the web service context root.
void
validateOptions()
Called to validate configuration parameters.

Method Details

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException - Description of Exception

execute

public void execute()
            throws xdoclet.XDocletException
Throws:
xdoclet.XDocletException - Description of Exception

getAlterTable

public String getAlterTable()
Gets the alterTable attribute of the JBossSubTask object.
Returns:
The alterTable value

getCreateTable

public String getCreateTable()
Gets the createTable attribute of the JBossSubTask object.
Returns:
The createTable value

getDatasource

public String getDatasource()
Gets the Datasource attribute of the JBossSubTask object
Returns:
The Datasource value

getDatasourceMapping

public String getDatasourceMapping()
Gets the DatasourceMapping attribute of the JBossSubTask object
Returns:
The DatasourceMapping value

getDebug

public String getDebug()
Gets the Debug attribute of the JBossSubTask object
Returns:
The Debug value

getGenerateRelations

public String getGenerateRelations()
Gets the GenerateRelations attribute of the JBossSubTask object
Returns:
The GenerateRelations value

getJawsTemplateURL

public URL getJawsTemplateURL()
Gets the template URL for jaws.xml .
Returns:
the jaws.xml template URL

getJbossTemplateURL

public URL getJbossTemplateURL()
Gets the template URL for jboss.xml.
Returns:
the jboss.xml template URL

getJbosscmpTemplateURL

public URL getJbosscmpTemplateURL()
Gets the template URL for jbosscmp-jdbc.xml.
Returns:
the jbosscmp-jdbc.xml template URL

getPreferredRelationMapping

public String getPreferredRelationMapping()
Gets the preferredRelationMapping attribute of the JBossSubTask object.
Returns:
The preferredRelationMapping value

getRemoveTable

public String getRemoveTable()
Gets the createTable attribute of the JBossSubTask object.
Returns:
The removeTable value

getSecurityDomain

public String getSecurityDomain()
Gets the SecurityDomain attribute of the JBossSubTask object
Returns:
The SecurityDomain value

getTypemapping

public String getTypemapping()
Gets the Typemapping attribute of the JBossSubTask object
Returns:
The Typemapping value

getUnauthenticatedPrincipal

public String getUnauthenticatedPrincipal()
Gets the unauthenticated principal name to use.
Returns:
The unauthenticated principal name

getVersion

public String getVersion()
Gets the Version attribute of the JBossSubTask object
Returns:
The Version value

getWebServiceContextRoot

public String getWebServiceContextRoot()
Get the web service context root.
Returns:
the web service context root

setAlterTable

public void setAlterTable(String alterTable)
Parameters:
alterTable -

setCreateTable

public void setCreateTable(String createTable)
Parameters:
createTable -

setDatasource

public void setDatasource(String datasource)
Sets the Datasource attribute of the JBossSubTask object
Parameters:
datasource - The new Datasource value

setDatasourceMapping

public void setDatasourceMapping(String datasourceMapping)
Parameters:
datasourceMapping -

setDebug

public void setDebug(String debug)
Debug flag for jaws.xml.
Parameters:
debug - No, default is "false"

setGenerateRelations

public void setGenerateRelations(String generateRelations)
Parameters:
generateRelations -

setJawsTemplateFile

public void setJawsTemplateFile(File jawsTemplateFile)
            throws xdoclet.XDocletException
Sets the template file for jaws.xml.
Parameters:
jawsTemplateFile - the jaws.xml file
Throws:
xdoclet.XDocletException -

setJbossTemplateFile

public void setJbossTemplateFile(File jbossTemplateFile)
            throws xdoclet.XDocletException
Sets the template file for jboss.xml.
Parameters:
jbossTemplateFile - the jboss.xml file
Throws:
xdoclet.XDocletException -

setJbosscmpTemplateFile

public void setJbosscmpTemplateFile(File jbosscmpTemplateFile)
            throws xdoclet.XDocletException
Sets the template file for jbosscmp-jdbc.xml.
Parameters:
jbosscmpTemplateFile - the jbosscmp-jdbc.xml file
Throws:
xdoclet.XDocletException -

setPreferredRelationMapping

public void setPreferredRelationMapping(String preferredRelationMapping)
Parameters:
preferredRelationMapping -

setRemoveTable

public void setRemoveTable(String removeTable)
Parameters:
removeTable -

setSecurityDomain

public void setSecurityDomain(String aSecurityDomain)
The security domain to use.
Parameters:
aSecurityDomain - The new SecurityDomain value

setTypemapping

public void setTypemapping(String typemapping)
Parameters:
typemapping -

setUnauthenticatedPrincipal

public void setUnauthenticatedPrincipal(String anUnauthenticatedPrincipal)
The unauthenticated principal name to use.
Parameters:
anUnauthenticatedPrincipal - The new unauthenticated principal name

setVersion

public void setVersion(JBossSubTask.JBossVersionTypes version)
The version of JBoss. Supported versions are 2.4, 3.0, 3.0.1, 3.0.2, 3.0.3, 3.2 and 4.0.
Parameters:
version - The new Version value
ant.not-required
No,defaultis "2.4".

setWebServiceContextRoot

public void setWebServiceContextRoot(String webServiceContextRoot)
Set the web service context root.
Parameters:
webServiceContextRoot - the web service context root

validateOptions

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