View Javadoc
1   package org.apache.maven.plugin.assembly.archive.phase;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.plugin.assembly.AssemblerConfigurationSource;
23  import org.apache.maven.plugin.assembly.InvalidAssemblerConfigurationException;
24  import org.apache.maven.plugin.assembly.archive.ArchiveCreationException;
25  import org.apache.maven.plugin.assembly.format.AssemblyFormattingException;
26  import org.apache.maven.plugin.assembly.resolved.ResolvedAssembly;
27  import org.codehaus.plexus.archiver.Archiver;
28  
29  /**
30   * Handles one top-level section of the assembly descriptor, to determine which files to include in the assembly archive
31   * for that section.
32   * 
33   * @version $Id: AssemblyArchiverPhase.java 1632869 2014-10-19 00:19:23Z khmarbaise $
34   */
35  public interface AssemblyArchiverPhase
36  {
37      String ROLE = AssemblyArchiverPhase.class.getName();
38  
39      /**
40       * Handle the associated section of the assembly descriptor.
41       * 
42       * @param assembly The assembly descriptor to use
43       * @param archiver The archiver used to create the assembly archive, to which files/directories/artifacts are added
44       * @param configSource The configuration for this assembly build, normally derived from the plugin that launched the
45       *            assembly process.
46       * @throws ArchiveCreationException in case of an archive creation error.
47       * @throws AssemblyFormattingException in case of a assembly formatting exception.
48       * @throws InvalidAssemblerConfigurationException in case of an invalid assembler configuration.
49       */
50      void execute( ResolvedAssembly assembly, Archiver archiver, AssemblerConfigurationSource configSource )
51          throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException;
52  }