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