Class Assembly

  • All Implemented Interfaces:
    java.io.Serializable

    public class Assembly
    extends java.lang.Object
    implements java.io.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:
    Serialized Form
    • Field Detail

      • id

        private java.lang.String id
        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.
      • formats

        private java.util.List<java.lang.String> formats
        Field formats.
      • includeBaseDirectory

        private boolean includeBaseDirectory
        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.
      • baseDirectory

        private java.lang.String baseDirectory
        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) .
      • includeSiteDirectory

        private boolean includeSiteDirectory
        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.
      • moduleSets

        private java.util.List<ModuleSet> moduleSets
        Field moduleSets.
      • fileSets

        private java.util.List<FileSet> fileSets
        Field fileSets.
      • files

        private java.util.List<FileItem> files
        Field files.
      • dependencySets

        private java.util.List<DependencySet> dependencySets
        Field dependencySets.
      • repositories

        private java.util.List<Repository> repositories
        Field repositories.
      • componentDescriptors

        private java.util.List<java.lang.String> componentDescriptors
        Field componentDescriptors.
      • modelEncoding

        private java.lang.String modelEncoding
        Field modelEncoding.
    • Constructor Detail

      • Assembly

        public Assembly()
    • Method Detail

      • addComponentDescriptor

        public void addComponentDescriptor​(java.lang.String string)
        Method addComponentDescriptor.
        Parameters:
        string -
      • addContainerDescriptorHandler

        public void addContainerDescriptorHandler​(ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig)
        Method addContainerDescriptorHandler.
        Parameters:
        containerDescriptorHandlerConfig -
      • addDependencySet

        public void addDependencySet​(DependencySet dependencySet)
        Method addDependencySet.
        Parameters:
        dependencySet -
      • addFile

        public void addFile​(FileItem fileItem)
        Method addFile.
        Parameters:
        fileItem -
      • addFileSet

        public void addFileSet​(FileSet fileSet)
        Method addFileSet.
        Parameters:
        fileSet -
      • addFormat

        public void addFormat​(java.lang.String string)
        Method addFormat.
        Parameters:
        string -
      • addModuleSet

        public void addModuleSet​(ModuleSet moduleSet)
        Method addModuleSet.
        Parameters:
        moduleSet -
      • addRepository

        public void addRepository​(Repository repository)
        Method addRepository.
        Parameters:
        repository -
      • getBaseDirectory

        public java.lang.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 java.util.List<java.lang.String> getComponentDescriptors()
        Method getComponentDescriptors.
        Returns:
        List
      • getContainerDescriptorHandlers

        public java.util.List<ContainerDescriptorHandlerConfig> getContainerDescriptorHandlers()
        Method getContainerDescriptorHandlers.
        Returns:
        List
      • getDependencySets

        public java.util.List<DependencySet> getDependencySets()
        Method getDependencySets.
        Returns:
        List
      • getFileSets

        public java.util.List<FileSet> getFileSets()
        Method getFileSets.
        Returns:
        List
      • getFiles

        public java.util.List<FileItem> getFiles()
        Method getFiles.
        Returns:
        List
      • getFormats

        public java.util.List<java.lang.String> getFormats()
        Method getFormats.
        Returns:
        List
      • getId

        public java.lang.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 java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String
      • getModuleSets

        public java.util.List<ModuleSet> getModuleSets()
        Method getModuleSets.
        Returns:
        List
      • getRepositories

        public java.util.List<Repository> getRepositories()
        Method getRepositories.
        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​(java.lang.String string)
        Method removeComponentDescriptor.
        Parameters:
        string -
      • removeContainerDescriptorHandler

        public void removeContainerDescriptorHandler​(ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig)
        Method removeContainerDescriptorHandler.
        Parameters:
        containerDescriptorHandlerConfig -
      • removeDependencySet

        public void removeDependencySet​(DependencySet dependencySet)
        Method removeDependencySet.
        Parameters:
        dependencySet -
      • removeFile

        public void removeFile​(FileItem fileItem)
        Method removeFile.
        Parameters:
        fileItem -
      • removeFileSet

        public void removeFileSet​(FileSet fileSet)
        Method removeFileSet.
        Parameters:
        fileSet -
      • removeFormat

        public void removeFormat​(java.lang.String string)
        Method removeFormat.
        Parameters:
        string -
      • removeModuleSet

        public void removeModuleSet​(ModuleSet moduleSet)
        Method removeModuleSet.
        Parameters:
        moduleSet -
      • removeRepository

        public void removeRepository​(Repository repository)
        Method removeRepository.
        Parameters:
        repository -
      • setBaseDirectory

        public void setBaseDirectory​(java.lang.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 -
      • setComponentDescriptors

        public void setComponentDescriptors​(java.util.List<java.lang.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 -
      • setContainerDescriptorHandlers

        public void setContainerDescriptorHandlers​(java.util.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 -
      • setDependencySets

        public void setDependencySets​(java.util.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 -
      • setFileSets

        public void setFileSets​(java.util.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 -
      • setFiles

        public void setFiles​(java.util.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 -
      • setFormats

        public void setFormats​(java.util.List<java.lang.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
        • "jar" - Creates a JAR format
        • "dir" - Creates an exploded directory format
        • "war" - Creates a WAR format
        Parameters:
        formats -
      • setId

        public void setId​(java.lang.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 -
      • 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 -
      • 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 -
      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding -
      • setModuleSets

        public void setModuleSets​(java.util.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 -
      • setRepositories

        public void setRepositories​(java.util.List<Repository> repositories)
        Set specifies which repository files to include in the assembly. A repository is specified by providing one or more of <repository> subelements.
        Parameters:
        repositories -