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.AssemblyContext;
24  import org.apache.maven.plugin.assembly.InvalidAssemblerConfigurationException;
25  import org.apache.maven.plugin.assembly.archive.ArchiveCreationException;
26  import org.apache.maven.plugin.assembly.format.AssemblyFormattingException;
27  import org.apache.maven.plugin.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.java 999612 2010-09-21 20:34:50Z jdcasey $
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
44       *            The assembly descriptor to use
45       * @param archiver
46       *            The archiver used to create the assembly archive, to which files/directories/artifacts are added
47       * @param configSource
48       *            The configuration for this assembly build, normally derived from the plugin that launched the assembly
49       *            process.
50       * @param context
51       */
52      void execute( Assembly assembly, Archiver archiver, AssemblerConfigurationSource configSource,
53                    AssemblyContext context )
54          throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException;
55  }