# DeploymentDescriptor

interface DeploymentDescriptor(source)

A deployment descriptor such as application.xml.

#### Since

1.0

## Functions

getApplicationName
Link copied to clipboard
abstract fun getApplicationName(): String
The application name.
getDescription
Link copied to clipboard
abstract fun getDescription(): String
The application description.
getDisplayName
Link copied to clipboard
abstract fun getDisplayName(): String
The application display name.
getFileName
Link copied to clipboard
abstract fun getFileName(): String
The name of the descriptor file, typically "application.
getInitializeInOrder
Link copied to clipboard
abstract fun getInitializeInOrder(): Boolean
Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules.
getLibraryDirectory
Link copied to clipboard
abstract fun getLibraryDirectory(): String
The name of the directory to look for libraries in.
getModules
Link copied to clipboard
abstract fun getModules(): Set<EarModule>
List of module descriptors.
getModuleTypeMappings
Link copied to clipboard
abstract fun getModuleTypeMappings(): Map<String, String>
Mapping of module paths to module types.
getSecurityRoles
Link copied to clipboard
abstract fun getSecurityRoles(): Set<EarSecurityRole>
List of security roles.
getVersion
Link copied to clipboard
abstract fun getVersion(): String
The version of application.xml.
module
Link copied to clipboard
abstract fun module(path: String, type: String): DeploymentDescriptor
abstract fun module(module: EarModule, type: String): DeploymentDescriptor
Add a module to the deployment descriptor.
readFrom
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
abstract fun setApplicationName(applicationName: String)
Sets the application name.
setDescription
Link copied to clipboard
abstract fun setDescription(description: String)
Sets the description.
setDisplayName
Link copied to clipboard
abstract fun setDisplayName(displayName: String)
Sets the display name.
setFileName
Link copied to clipboard
abstract fun setFileName(fileName: String)
Sets the file name.
setInitializeInOrder
Link copied to clipboard
abstract fun setInitializeInOrder(initializeInOrder: Boolean)
Sets the initialize in order.
setLibraryDirectory
Link copied to clipboard
abstract fun setLibraryDirectory(libraryDirectory: String)
Sets the library directory.
setModules
Link copied to clipboard
abstract fun setModules(modules: Set<EarModule>)
Sets the modules.
setModuleTypeMappings
Link copied to clipboard
abstract fun setModuleTypeMappings(moduleTypeMappings: Map<String, String>)
Sets the module type mappings.
setSecurityRoles
Link copied to clipboard
abstract fun setSecurityRoles(securityRoles: Set<EarSecurityRole>)
Sets the security roles.
setVersion
Link copied to clipboard
abstract fun setVersion(version: String)
Sets the version.
webModule
Link copied to clipboard
abstract fun webModule(path: String, contextRoot: String): DeploymentDescriptor
Add a web module to the deployment descriptor.
withXml
Link copied to clipboard
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
Link copied to clipboard
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.