View Javadoc

1   package org.apache.maven.plugin.war.packaging;
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.MojoExecutionException;
23  import org.apache.maven.plugin.MojoFailureException;
24  
25  /**
26   * The base packaging task.
27   *
28   * @author Stephane Nicoll
29   * @version $Id: WarPackagingTask.html 867902 2013-06-30 13:58:43Z olamy $
30   */
31  public interface WarPackagingTask
32  {
33  
34      /**
35       * Performs the packaging for the specified task.
36       * <p/>
37       * The task is responsible to update the packaging context, namely
38       * with the files that have been copied.
39       *
40       * @param context the packaging context
41       * @throws MojoExecutionException if an error occurred
42       * @throws MojoFailureException   if the project configuration is invalid
43       */
44      void performPackaging( WarPackagingContext context )
45          throws MojoExecutionException, MojoFailureException;
46  
47  
48  }