A deployment descriptor such as application.xml.
Type | Name and description |
---|---|
String |
getApplicationName() The application name. |
String |
getDescription() The application description. |
String |
getDisplayName() The application display name. |
String |
getFileName() The name of the descriptor file, typically "application.xml" |
Boolean |
getInitializeInOrder() Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules. |
String |
getLibraryDirectory() The name of the directory to look for libraries in. |
Map<String, String> |
getModuleTypeMappings() Mapping of module paths to module types. |
Set<? extends EarModule> |
getModules() List of module descriptors. |
Set<? extends EarSecurityRole> |
getSecurityRoles() List of security roles. |
String |
getVersion() The version of application.xml. |
DeploymentDescriptor |
module(EarModule module, String type) Add a module to the deployment descriptor. |
DeploymentDescriptor |
module(String path, String type) Add a module to the deployment descriptor. |
DeploymentDescriptor |
readFrom(Reader reader) Reads the deployment descriptor from a reader. |
boolean |
readFrom(Object path) Reads the deployment descriptor from a file. |
DeploymentDescriptor |
securityRole(EarSecurityRole role) Add a security role to the deployment descriptor. |
DeploymentDescriptor |
securityRole(String role) Add a security role to the deployment descriptor. |
void |
setApplicationName(String applicationName) |
void |
setDescription(String description) |
void |
setDisplayName(String displayName) |
void |
setFileName(String fileName) |
void |
setInitializeInOrder(Boolean initializeInOrder) |
void |
setLibraryDirectory(String libraryDirectory) |
void |
setModuleTypeMappings(Map<String, String> moduleTypeMappings) |
void |
setModules(Set<? extends EarModule> modules) |
void |
setSecurityRoles(Set<? extends EarSecurityRole> securityRoles) |
void |
setVersion(String version) |
DeploymentDescriptor |
webModule(String path, String contextRoot) Add a web module to the deployment descriptor. |
DeploymentDescriptor |
withXml(Closure closure) Adds a closure to be called when the XML document has been created. |
DeploymentDescriptor |
withXml(Action<? super XmlProvider> action) Adds an action to be called when the XML document has been created. |
DeploymentDescriptor |
writeTo(Writer writer) Writes the deployment descriptor into a writer. |
DeploymentDescriptor |
writeTo(Object path) Writes the deployment descriptor into a file. |
The application name. Optional. Only valid with version 6.
The application description. Optional.
The application display name. Optional.
The name of the descriptor file, typically "application.xml"
Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules. Optional. Only valid with version 6.
The name of the directory to look for libraries in. Optional. If not specified then "lib" is assumed. Typically this should be set via EarPluginConvention.setLibDirName instead of this property.
Mapping of module paths to module types. Non-null by default. For example, to specify that a module is a java
module, set moduleTypeMappings["myJavaModule.jar"] = "java"
.
List of module descriptors. Must not be empty. Non-null and order-maintaining by default. Must maintain order if
initializeInOrder is true
.
List of security roles. Optional. Non-null and order-maintaining by default.
The version of application.xml. Required. Valid versions are "1.3", "1.4", "5" and "6". Defaults to "6".
Add a module to the deployment descriptor.
module
- The module to add.type
- The type of the module, such as "ejb", "java", etc.Add a module to the deployment descriptor.
path
- The path of the module to add.type
- The type of the module, such as "ejb", "java", etc.Reads the deployment descriptor from a reader.
reader
- The reader to read the deployment descriptor fromReads the deployment descriptor from a file. The paths are resolved as defined by Project.file
path
- The path of the file to read the deployment descriptor fromAdd a security role to the deployment descriptor.
role
- The security role to add.Add a security role to the deployment descriptor.
role
- The name of the security role to add.Add a web module to the deployment descriptor.
path
- The path of the module to add.contextRoot
- The context root type of the web module.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 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.
closure
- The closure to execute when the XML has been createdAdds 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 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.
action
- The action to execute when the XML has been createdWrites the deployment descriptor into a writer.
writer
- The writer to write the deployment descriptor toWrites the deployment descriptor into a file. The paths are resolved as defined by Project.file
path
- The path of the file to write the deployment descriptor into.