1 package org.apache.maven.plugins.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.plugins.assembly.AssemblerConfigurationSource;
23 import org.apache.maven.plugins.assembly.InvalidAssemblerConfigurationException;
24 import org.apache.maven.plugins.assembly.archive.ArchiveCreationException;
25 import org.apache.maven.plugins.assembly.artifact.DependencyResolutionException;
26 import org.apache.maven.plugins.assembly.format.AssemblyFormattingException;
27 import org.apache.maven.plugins.assembly.model.Assembly;
28 import org.codehaus.plexus.archiver.Archiver;
29
30 /**
31 * Handles one top-level section of the assembly descriptor, to determine which files to include in the assembly archive
32 * for that section.
33 *
34 * @version $Id: AssemblyArchiverPhase.html 1016737 2017-08-13 12:01:54Z khmarbaise $
35 */
36 public interface AssemblyArchiverPhase
37 {
38 String ROLE = AssemblyArchiverPhase.class.getName();
39
40 /**
41 * Handle the associated section of the assembly descriptor.
42 *
43 * @param assembly The assembly descriptor to use
44 * @param archiver The archiver used to create the assembly archive, to which files/directories/artifacts are
45 * added
46 * @param configSource The configuration for this assembly build, normally derived from the plugin that launched
47 * the assembly process.
48 * @throws org.apache.maven.plugins.assembly.archive.ArchiveCreationException in case of an archive
49 * creation error.
50 * @throws org.apache.maven.plugins.assembly.format.AssemblyFormattingException in case of a assembly
51 * formatting exception.
52 * @throws org.apache.maven.plugins.assembly.InvalidAssemblerConfigurationException in case of an invalid
53 * assembler configuration.
54 */
55 void execute( Assembly assembly, Archiver archiver, AssemblerConfigurationSource configSource )
56 throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException,
57 DependencyResolutionException;
58 }