interface DeploymentDescriptor
A deployment descriptor such as application.xml.
abstract fun getApplicationName(): String
The application name. Optional. Only valid with version 6. |
|
abstract fun getDescription(): String
The application description. Optional. |
|
abstract fun getDisplayName(): String
The application display name. Optional. |
|
abstract fun getFileName(): String
The name of the descriptor file, typically "application.xml" |
|
abstract fun getInitializeInOrder(): Boolean
Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules. Optional. Only valid with version 6. |
|
abstract fun getLibraryDirectory(): String
The name of the directory to look for libraries in. Optional. If not specified, |
|
abstract fun getModuleTypeMappings(): MutableMap<String, String>
Mapping of module paths to module types. Non-null by default. For example, to specify that a module is a java module, set |
|
abstract fun getModules(): MutableSet<EarModule>
List of module descriptors. Must not be empty. Non-null and order-maintaining by default. Must maintain order if initializeInOrder is |
|
abstract fun getSecurityRoles(): MutableSet<EarSecurityRole>
List of security roles. Optional. Non-null and order-maintaining by default. |
|
abstract fun getVersion(): String
The version of application.xml. Required. Valid versions are "1.3", "1.4", "5" and "6". Defaults to "6". |
|
abstract fun module(module: EarModule, type: String): DeploymentDescriptorabstract fun module(path: String, type: String): DeploymentDescriptor
Add a module to the deployment descriptor. |
|
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. The paths are resolved as defined by |
|
abstract fun securityRole(role: EarSecurityRole): DeploymentDescriptorabstract fun securityRole(role: String): 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. |
|
abstract fun setApplicationName(applicationName: String): Unit |
|
abstract fun setDescription(description: String): Unit |
|
abstract fun setDisplayName(displayName: String): Unit |
|
abstract fun setFileName(fileName: String): Unit |
|
abstract fun setInitializeInOrder(initializeInOrder: Boolean): Unit |
|
abstract fun setLibraryDirectory(libraryDirectory: String): Unit |
|
abstract fun setModuleTypeMappings(moduleTypeMappings: MutableMap<String, String>): Unit |
|
abstract fun setModules(modules: MutableSet<EarModule>): Unit |
|
abstract fun setSecurityRoles(securityRoles: MutableSet<EarSecurityRole>): Unit |
|
abstract fun setVersion(version: String): Unit |
|
abstract fun webModule(path: String, contextRoot: String): DeploymentDescriptor
Add a web module to the deployment descriptor. |
|
abstract fun withXml(closure: Closure<Any>): DeploymentDescriptor
Adds a closure to be called when the XML document has been created. The XML is passed to the closure as a parameter in form of a groovy.util.Node. The closure can modify the XML before it is written to the output file. This allows additional JavaEE version 6 elements like "data-source" or "resource-ref" to be included. abstract fun withXml(action: Action<in XmlProvider>): DeploymentDescriptor
Adds an action to be called when the XML document has been created. The XML is passed to the action as a parameter in form of a groovy.util.Node. The action can modify the XML before it is written to the output file. This allows additional JavaEE version 6 elements like "data-source" or "resource-ref" to be included. |
|
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. The paths are resolved as defined by |