Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | METHOD | DETAIL: FIELD | METHOD

## org.gradle.plugins.ear.descriptor
[Java] Interface DeploymentDescriptor

    public interface DeploymentDescriptor

A deployment descriptor such as application.xml.

Method Summary
`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` | `getModuleTypeMappings()` Mapping of module paths to module types.
`Set` | `getModules()` List of module descriptors.
`Set` | `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 moduleTypeMappings)`
`void` | `setModules(Set modules)`
`void` | `setSecurityRoles(Set 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 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.

Method Detail

### getApplicationName

    public String getApplicationName()

  The application name. Optional. Only valid with version 6.

### getDescription

    public String getDescription()

  The application description. Optional.

### getDisplayName

    public String getDisplayName()

  The application display name. Optional.

### getFileName

    public String getFileName()

  The name of the descriptor file, typically "application.xml"

### getInitializeInOrder

    public Boolean getInitializeInOrder()

  Whether to initialize modules in the order they appear in the descriptor, with the exception of client modules. Optional. Only valid with version 6.

### getLibraryDirectory

    public String getLibraryDirectory()

  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.

### getModuleTypeMappings

    public Map getModuleTypeMappings()

  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"`.

### getModules

    public Set getModules()

  List of module descriptors. Must not be empty. Non-null and order-maintaining by default. Must maintain order if initializeInOrder is `true`.

### getSecurityRoles

    public Set getSecurityRoles()

  List of security roles. Optional. Non-null and order-maintaining by default.

### getVersion

    public String getVersion()

  The version of application.xml. Required. Valid versions are "1.3", "1.4", "5" and "6". Defaults to "6".

### module

    public DeploymentDescriptor module(EarModule module, String type)

  Add a module to the deployment descriptor.
  Parameters:
    `module` - The module to add.
    `type` - The type of the module, such as "ejb", "java", etc.
  Returns:
    this.

### module

    public DeploymentDescriptor module(String path, String type)

  Add a module to the deployment descriptor.
  Parameters:
    `path` - The path of the module to add.
    `type` - The type of the module, such as "ejb", "java", etc.
  Returns:
    this.

### readFrom

    public DeploymentDescriptor readFrom(Reader reader)

  Reads the deployment descriptor from a reader.
  Parameters:
    `reader` - The reader to read the deployment descriptor from
  Returns:
    this

### readFrom

    public boolean readFrom(Object path)

  Reads the deployment descriptor from a file. The paths are resolved as defined by Project.file
  Parameters:
    `path` - The path of the file to read the deployment descriptor from
  Returns:
    whether the descriptor could be read from the given path

### securityRole

    public DeploymentDescriptor securityRole(EarSecurityRole role)

  Add a security role to the deployment descriptor.
  Parameters:
    `role` - The security role to add.
  Returns:
    this.

### securityRole

    public DeploymentDescriptor securityRole(String role)

  Add a security role to the deployment descriptor.
  Parameters:
    `role` - The name of the security role to add.
  Returns:
    this.

### setApplicationName

    public void setApplicationName(String applicationName)

### setDescription

    public void setDescription(String description)

### setDisplayName

    public void setDisplayName(String displayName)

### setFileName

    public void setFileName(String fileName)

### setInitializeInOrder

    public void setInitializeInOrder(Boolean initializeInOrder)

### setLibraryDirectory

    public void setLibraryDirectory(String libraryDirectory)

### setModuleTypeMappings

    public void setModuleTypeMappings(Map moduleTypeMappings)

### setModules

    public void setModules(Set modules)

### setSecurityRoles

    public void setSecurityRoles(Set securityRoles)

### setVersion

    public void setVersion(String version)

### webModule

    public DeploymentDescriptor webModule(String path, String contextRoot)

  Add a web module to the deployment descriptor.
  Parameters:
    `path` - The path of the module to add.
    `contextRoot` - The context root type of the web module.
  Returns:
    this.

### withXml

    public DeploymentDescriptor withXml(Closure closure)

  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.
  Parameters:
    `closure` - The closure to execute when the XML has been created
  Returns:
    this

### withXml

    public DeploymentDescriptor withXml(Action action)

  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 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.
  Parameters:
    `action` - The action to execute when the XML has been created
  Returns:
    this

### writeTo

    public DeploymentDescriptor writeTo(Writer writer)

  Writes the deployment descriptor into a writer.
  Parameters:
    `writer` - The writer to write the deployment descriptor to
  Returns:
    this

### writeTo

    public DeploymentDescriptor writeTo(Object path)

  Writes the deployment descriptor into a file. The paths are resolved as defined by Project.file
  Parameters:
    `path` - The path of the file to write the deployment descriptor into.
  Returns:
    this

Gradle API 1.10