Package org.apache.maven.plugins.assembly.model

Class Assembly

java.lang.Object
org.apache.maven.plugins.assembly.model.Assembly
All Implemented Interfaces:
Serializable
public class Assembly extends Object implements Serializable
An assembly defines a collection of files usually distributed in an archive format such as zip, tar, or tar.gz that is generated from a project. For example, a project could produce a ZIP assembly which contains a project's JAR artifact in the root directory, the runtime dependencies in a lib/ directory, and a shell script to launch a stand-alone application.
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • Assembly

      public Assembly()

  • Method Details

    • addComponentDescriptor

      public void addComponentDescriptor(String string)
      Method addComponentDescriptor.
      Parameters:
      string - a string object.

    • addContainerDescriptorHandler

      public void addContainerDescriptorHandler(ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig)
      Method addContainerDescriptorHandler.
      Parameters:
      containerDescriptorHandlerConfig - a containerDescriptorHandlerConfig object.

    • addDependencySet

      public void addDependencySet(DependencySet dependencySet)
      Method addDependencySet.
      Parameters:
      dependencySet - a dependencySet object.

    • addFile

      public void addFile(FileItem fileItem)
      Method addFile.
      Parameters:
      fileItem - a fileItem object.

    • addFileSet

      public void addFileSet(FileSet fileSet)
      Method addFileSet.
      Parameters:
      fileSet - a fileSet object.

    • addFormat

      public void addFormat(String string)
      Method addFormat.
      Parameters:
      string - a string object.

    • addModuleSet

      public void addModuleSet(ModuleSet moduleSet)
      Method addModuleSet.
      Parameters:
      moduleSet - a moduleSet object.

    • getBaseDirectory

      public String getBaseDirectory()
      Get sets the base directory of the resulting assembly archive. If this is not set and includeBaseDirectory == true, ${project.build.finalName} will be used instead. (Since 2.2-beta-1).
      Returns:
      String

    • getComponentDescriptors

      public List<String> getComponentDescriptors()
      Method getComponentDescriptors.
      Returns:
      List

    • getContainerDescriptorHandlers

      public List<ContainerDescriptorHandlerConfig> getContainerDescriptorHandlers()
      Method getContainerDescriptorHandlers.
      Returns:
      List

    • getDependencySets

      public List<DependencySet> getDependencySets()
      Method getDependencySets.
      Returns:
      List

    • getFileSets

      public List<FileSet> getFileSets()
      Method getFileSets.
      Returns:
      List

    • getFiles

      public List<FileItem> getFiles()
      Method getFiles.
      Returns:
      List

    • getFormats

      public List<String> getFormats()
      Method getFormats.
      Returns:
      List

    • getId

      public String getId()
      Get sets the id of this assembly. This is a symbolic name for a particular assembly of files from this project. Also, aside from being used to distinctly name the assembled package by attaching its value to the generated archive, the id is used as your artifact's classifier when deploying.
      Returns:
      String

    • getModelEncoding

      public String getModelEncoding()
      Get the modelEncoding field.
      Returns:
      String

    • getModuleSets

      public List<ModuleSet> getModuleSets()
      Method getModuleSets.
      Returns:
      List

    • isIncludeBaseDirectory

      public boolean isIncludeBaseDirectory()
      Get includes a base directory in the final archive. For example, if you are creating an assembly named "your-app", setting includeBaseDirectory to true will create an archive that includes this base directory. If this option is set to false the archive created will unzip its content to the current directory.
      Returns:
      boolean

    • isIncludeSiteDirectory

      public boolean isIncludeSiteDirectory()
      Get includes a site directory in the final archive. The site directory location of a project is determined by the siteDirectory parameter of the Assembly Plugin.
      Returns:
      boolean

    • removeComponentDescriptor

      public void removeComponentDescriptor(String string)
      Method removeComponentDescriptor.
      Parameters:
      string - a string object.

    • removeContainerDescriptorHandler

      public void removeContainerDescriptorHandler(ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig)
      Method removeContainerDescriptorHandler.
      Parameters:
      containerDescriptorHandlerConfig - a containerDescriptorHandlerConfig object.

    • removeDependencySet

      public void removeDependencySet(DependencySet dependencySet)
      Method removeDependencySet.
      Parameters:
      dependencySet - a dependencySet object.

    • removeFile

      public void removeFile(FileItem fileItem)
      Method removeFile.
      Parameters:
      fileItem - a fileItem object.

    • removeFileSet

      public void removeFileSet(FileSet fileSet)
      Method removeFileSet.
      Parameters:
      fileSet - a fileSet object.

    • removeFormat

      public void removeFormat(String string)
      Method removeFormat.
      Parameters:
      string - a string object.

    • removeModuleSet

      public void removeModuleSet(ModuleSet moduleSet)
      Method removeModuleSet.
      Parameters:
      moduleSet - a moduleSet object.

    • setBaseDirectory

      public void setBaseDirectory(String baseDirectory)
      Set sets the base directory of the resulting assembly archive. If this is not set and includeBaseDirectory == true, ${project.build.finalName} will be used instead. (Since 2.2-beta-1).
      Parameters:
      baseDirectory - a baseDirectory object.

    • setComponentDescriptors

      public void setComponentDescriptors(List<String> componentDescriptors)
      Set specifies the shared components xml file locations to include in the assembly. The locations specified must be relative to the base location of the descriptor. If the descriptor was found via a <descriptorRef/> element in the classpath, any components it specifies will also be found on the classpath. If it is found by pathname via a <descriptor/> element the value here will be interpreted as a path relative to the project basedir. When multiple componentDescriptors are found, their contents are merged. Check out the descriptor components for more information. A componentDescriptor is specified by providing one or more of <componentDescriptor> subelements.
      Parameters:
      componentDescriptors - a componentDescriptors object.

    • setContainerDescriptorHandlers

      public void setContainerDescriptorHandlers(List<ContainerDescriptorHandlerConfig> containerDescriptorHandlers)
      Set set of components which filter various container descriptors out of the normal archive stream, so they can be aggregated then added.
      Parameters:
      containerDescriptorHandlers - a containerDescriptorHandlers object.

    • setDependencySets

      public void setDependencySets(List<DependencySet> dependencySets)
      Set specifies which dependencies to include in the assembly. A dependencySet is specified by providing one or more of <dependencySet> subelements.
      Parameters:
      dependencySets - a dependencySets object.

    • setFileSets

      public void setFileSets(List<FileSet> fileSets)
      Set specifies which groups of files to include in the assembly. A fileSet is specified by providing one or more of <fileSet> subelements.
      Parameters:
      fileSets - a fileSets object.

    • setFiles

      public void setFiles(List<FileItem> files)
      Set specifies which single files to include in the assembly. A file is specified by providing one or more of <file> subelements.
      Parameters:
      files - a files object.

    • setFormats

      public void setFormats(List<String> formats)
      Set specifies the formats of the assembly. It is often better to specify the formats via the goal parameter rather than here. For example, that allows different profiles to generate different types of archives. Multiple formats can be supplied and the Assembly Plugin will generate an archive for each of the desired formats. When deploying your project, all file formats specified will also be deployed. A format is specified by supplying one of the following values in a <format> subelement:
      • "zip" - Creates a ZIP file format
      • "tar" - Creates a TAR format
      • "tar.gz" or "tgz" - Creates a gzip'd TAR format
      • "tar.bz2" or "tbz2" - Creates a bzip'd TAR format
      • "tar.snappy" - Creates a snappy'd TAR format
      • "tar.xz" or "txz" - Creates a xz'd TAR format
      • "tar.zst" or "tzst" - Creates a zst'd TAR format
      • "jar" - Creates a JAR format
      • "dir" - Creates an exploded directory format
      • "war" - Creates a WAR format
      Parameters:
      formats - a formats object.

    • setId

      public void setId(String id)
      Set sets the id of this assembly. This is a symbolic name for a particular assembly of files from this project. Also, aside from being used to distinctly name the assembled package by attaching its value to the generated archive, the id is used as your artifact's classifier when deploying.
      Parameters:
      id - a id object.

    • setIncludeBaseDirectory

      public void setIncludeBaseDirectory(boolean includeBaseDirectory)
      Set includes a base directory in the final archive. For example, if you are creating an assembly named "your-app", setting includeBaseDirectory to true will create an archive that includes this base directory. If this option is set to false the archive created will unzip its content to the current directory.
      Parameters:
      includeBaseDirectory - a includeBaseDirectory object.

    • setIncludeSiteDirectory

      public void setIncludeSiteDirectory(boolean includeSiteDirectory)
      Set includes a site directory in the final archive. The site directory location of a project is determined by the siteDirectory parameter of the Assembly Plugin.
      Parameters:
      includeSiteDirectory - a includeSiteDirectory object.

    • setModelEncoding

      public void setModelEncoding(String modelEncoding)
      Set the modelEncoding field.
      Parameters:
      modelEncoding - a modelEncoding object.

    • setModuleSets

      public void setModuleSets(List<ModuleSet> moduleSets)
      Set specifies which module files to include in the assembly. A moduleSet is specified by providing one or more of <moduleSet> subelements.
      Parameters:
      moduleSets - a moduleSets object.