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 $

Author: Ara Abrahamian (ara_e@email.com) Dmitri Colebatch (dim@bigpond.net.au)

UNKNOWN: Oct 15, 2001 display-name = "JBoss" name = "jboss" parent = "xdoclet.modules.ejb.EjbDocletTask" file = "jboss-security.xml" relates-to = "jboss.xml" description = "An XML unparsed entity containing * the optional enforce-ejb-restrictions, security-domain and/or unauthenticated-principal elements for jboss.xml" file = "jboss-beans.xml" relates-to = "jboss.xml" description = "An XML unparsed entity containing * the session, entity and message-driven elements for beans you wish to include which aren't processed by * XDoclet." file = "jboss-{0}.xml" relates-to = "jboss.xml" description = "An XML document containing the * session, entity or message-driven element for a bean, to be used instead of generating it from the bean's tags." file = "jboss-resource-managers.xml" relates-to = "jboss.xml" description = "An XML document * containing the resource-managers element, to use instead of generating it from jboss.resource-manager tags." file = "jboss-container.xml" relates-to = "jboss.xml" description = "An XML document containing the * optional container-configurations element for jboss.xml" file = "jbosscmp-jdbc-defaults.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML document * containing the defaults element for jbosscmp-jdbc.xml" file = "jbosscmp-jdbc-beans.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML unparsed * entity containing entity elements for any beans you wish to include which aren't processed by XDoclet." file = "jbosscmp-jdbc-db-settings-{0}.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML * unparsed entity containing various database settings for a bean. The contents should consist of (ejb-name, * (datasource, datasource-mapping)?, create-table?, alter-table?, remove-table?, read-only?, read-time-out?, * row-locking?, pk-constraint?, read-ahead?, list-cache-max?, fetch-size?, table-name?) elements." file = "jbosscmp-jdbc-{0}.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML unparsed entity * containing various other settings for a bean. Should consist of the (cmp-field*, load-groups?, * eager-load-group?, lazy-load-groups?, query*) elements." file = "jbosscmp-jdbc-dvc.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML unparsed entity * containing any additional dependent-value-class elements not generated from jboss.dvc tags." file = "jbosscmp-jdbc-typemappings.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML * document containing the optional type-mappings element." file = "jbosscmp-jdbc-entity-commands.xml" relates-to = "jbosscmp-jdbc.xml" description = "An XML * document containing the optional entity-commands element." file = "jaws-db-settings-{0}.xml" relates-to = "jboss-jaws.xml" description = "An XML unparsed entity * containing various database settings for a bean. The contents should consist of (ejb-name , datasource?) * elements." file = "jaws-{0}.xml" relates-to = "jboss-jaws.xml" description = "An XML unparsed entity containing * (cmp-field* , finder*) elements for a bean." file = "jaws-db-more-settings-{0}.xml" relates-to = "jboss-jaws.xml" description = "An XML unparsed * entity containing various database settings for a bean. The contents should consist of (read-only? , table-name? * , tuned-updates? , create-table? , remove-table? , row-locking? , time-out? , pk-constraint?) elements." file = "jboss-webservices.ent" relates-to = "jboss.xml" description = "An XML unparsed entity * containing markup for webservices-description and webservice-context-root elements. This is a Jboss 4 feature * and might work with patched >=3.2.6 version."

Nested Class Summary
static classJBossSubTask.JBossVersionTypes
Method Summary
protected voidengineStarted()
voidexecute()
StringgetAlterTable()
Gets the alterTable attribute of the JBossSubTask object.
StringgetCreateTable()
Gets the createTable attribute of the JBossSubTask object.
StringgetDatasource()
Gets the Datasource attribute of the JBossSubTask object
StringgetDatasourceMapping()
Gets the DatasourceMapping attribute of the JBossSubTask object
StringgetDebug()
Gets the Debug attribute of the JBossSubTask object
StringgetGenerateRelations()
Gets the GenerateRelations attribute of the JBossSubTask object
URLgetJawsTemplateURL()
Gets the template URL for jaws.xml .
URLgetJbosscmpTemplateURL()
Gets the template URL for jbosscmp-jdbc.xml.
URLgetJbossTemplateURL()
Gets the template URL for jboss.xml.
StringgetPreferredRelationMapping()
Gets the preferredRelationMapping attribute of the JBossSubTask object.
StringgetRemoveTable()
Gets the createTable attribute of the JBossSubTask object.
StringgetSecurityDomain()
Gets the SecurityDomain attribute of the JBossSubTask object
StringgetTypemapping()
Gets the Typemapping attribute of the JBossSubTask object
StringgetUnauthenticatedPrincipal()
Gets the unauthenticated principal name to use.
StringgetVersion()
Gets the Version attribute of the JBossSubTask object
StringgetWebServiceContextRoot()
Get the web service context root.
voidsetAlterTable(String alterTable)
voidsetCreateTable(String createTable)
voidsetDatasource(String datasource)
Sets the Datasource attribute of the JBossSubTask object
voidsetDatasourceMapping(String datasourceMapping)
voidsetDebug(String debug)
Debug flag for jaws.xml.
voidsetGenerateRelations(String generateRelations)
voidsetJawsTemplateFile(File jawsTemplateFile)
Sets the template file for jaws.xml.
voidsetJbosscmpTemplateFile(File jbosscmpTemplateFile)
Sets the template file for jbosscmp-jdbc.xml.
voidsetJbossTemplateFile(File jbossTemplateFile)
Sets the template file for jboss.xml.
voidsetPreferredRelationMapping(String preferredRelationMapping)
voidsetRemoveTable(String removeTable)
voidsetSecurityDomain(String aSecurityDomain)
The security domain to use.
voidsetTypemapping(String typemapping)
voidsetUnauthenticatedPrincipal(String anUnauthenticatedPrincipal)
The unauthenticated principal name to use.
voidsetVersion(JBossSubTask.JBossVersionTypes version)
The version of JBoss.
voidsetWebServiceContextRoot(String webServiceContextRoot)
Set the web service context root.
voidvalidateOptions()
Called to validate configuration parameters.

Method Detail

engineStarted

protected void engineStarted()

Throws: XDocletException Description of Exception

execute

public void execute()

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

getJbosscmpTemplateURL

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

Returns: the jbosscmp-jdbc.xml template URL

getJbossTemplateURL

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

Returns: the jboss.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)
Sets the template file for jaws.xml.

Parameters: jawsTemplateFile the jaws.xml file

Throws: XDocletException

setJbosscmpTemplateFile

public void setJbosscmpTemplateFile(File jbosscmpTemplateFile)
Sets the template file for jbosscmp-jdbc.xml.

Parameters: jbosscmpTemplateFile the jbosscmp-jdbc.xml file

Throws: XDocletException

setJbossTemplateFile

public void setJbossTemplateFile(File jbossTemplateFile)
Sets the template file for jboss.xml.

Parameters: jbossTemplateFile the jboss.xml file

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

UNKNOWN: 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()
Called to validate configuration parameters.

Throws: XDocletException Description of Exception