gradle/org.gradle.plugins.ear.descriptor/DeploymentDescriptor

DeploymentDescriptor

interface DeploymentDescriptor(source)

A deployment descriptor such as application.xml.

Functions

getApplicationName

abstract fun getApplicationName(): String

The application name.

getDescription

abstract fun getDescription(): String

The application description.

getDisplayName

abstract fun getDisplayName(): String

The application display name.

getFileName

abstract fun getFileName(): String

The name of the descriptor file, typically "application.

getInitializeInOrder

abstract fun getInitializeInOrder(): Boolean

Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules.

getLibraryDirectory

abstract fun getLibraryDirectory(): String

The name of the directory to look for libraries in.

getModules

abstract fun getModules(): Set<EarModule>

List of module descriptors.

getModuleTypeMappings

abstract fun getModuleTypeMappings(): Map<String, String>

Mapping of module paths to module types.

getSecurityRoles

abstract fun getSecurityRoles(): Set<EarSecurityRole>

List of security roles.

getVersion

abstract fun getVersion(): String

The version of application.xml.

module

abstract fun module(path: String, type: String): DeploymentDescriptor

abstract fun module(module: EarModule, type: String): DeploymentDescriptor

Add a module to the deployment descriptor.

readFrom

abstract fun readFrom(reader: Reader): DeploymentDescriptor

Reads the deployment descriptor from a reader.

abstract fun readFrom(path: Any): Boolean

Reads the deployment descriptor from a file.

securityRole

abstract fun securityRole(role: String): DeploymentDescriptor

abstract fun securityRole(role: EarSecurityRole): DeploymentDescriptor

Add a security role to the deployment descriptor.

abstract fun securityRole(action: Action<in EarSecurityRole>): DeploymentDescriptor

Add a security role to the deployment descriptor after configuring it with the given action.

setApplicationName

abstract fun setApplicationName(applicationName: String)

setDescription

abstract fun setDescription(description: String)

setDisplayName

abstract fun setDisplayName(displayName: String)

setFileName

abstract fun setFileName(fileName: String)

setInitializeInOrder

abstract fun setInitializeInOrder(initializeInOrder: Boolean)

setLibraryDirectory

abstract fun setLibraryDirectory(libraryDirectory: String)

setModules

abstract fun setModules(modules: Set<EarModule>)

setModuleTypeMappings

abstract fun setModuleTypeMappings(moduleTypeMappings: Map<String, String>)

setSecurityRoles

abstract fun setSecurityRoles(securityRoles: Set<EarSecurityRole>)

setVersion

abstract fun setVersion(version: String)

webModule

abstract fun webModule(path: String, contextRoot: String): DeploymentDescriptor

Add a web module to the deployment descriptor.

withXml

abstract fun withXml(@DelegatesTo(value = XmlProvider::class) closure: Closure): DeploymentDescriptor

Adds a closure to be called when the XML document has been created.

abstract fun withXml(action: Action<in XmlProvider>): DeploymentDescriptor

Adds an action to be called when the XML document has been created.

writeTo

abstract fun writeTo(writer: Writer): DeploymentDescriptor

Writes the deployment descriptor into a writer.

abstract fun writeTo(path: Any): DeploymentDescriptor

Writes the deployment descriptor into a file.