api / org.gradle.plugins.ear.descriptor / EarWebModule

EarWebModule

interface EarWebModule : EarModule

A module element in a deployment descriptor like application.xml that has a web child element.

Functions

getContextRoot

abstract fun getContextRoot(): String

The context-root element specifies the context root of a web application.

setContextRoot

abstract fun setContextRoot(contextRoot: String): Unit

Inherited Functions

getAltDeployDescriptor

abstract fun getAltDeployDescriptor(): String

The alt-dd element specifies an optional URI to the post-assembly version of the deployment descriptor file for a particular Java EE module. The URI must specify the full pathname of the deployment descriptor file relative to the application's root directory. If alt-dd is not specified, the deployer must read the deployment descriptor from the default location and file name required by the respective component specification.

getPath

abstract fun getPath(): String

The connector element specifies the URI of an archive file, relative to the top level of the application package.

setAltDeployDescriptor

abstract fun setAltDeployDescriptor(altDeployDescriptor: String): Unit

setPath

abstract fun setPath(path: String): Unit

toXmlNode

abstract fun toXmlNode(parentModule: Node, name: Any): Node

Convert this object to an XML Node (or two nodes if altDeployDescriptor is not null).