View Javadoc
1   package org.apache.maven.plugin.assembly.archive;
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.archiver.MavenArchiveConfiguration;
23  import org.apache.maven.archiver.MavenArchiver;
24  import org.apache.maven.artifact.DependencyResolutionRequiredException;
25  import org.apache.maven.execution.MavenSession;
26  import org.apache.maven.project.MavenProject;
27  import org.codehaus.plexus.archiver.AbstractArchiveFinalizer;
28  import org.codehaus.plexus.archiver.Archiver;
29  import org.codehaus.plexus.archiver.ArchiverException;
30  import org.codehaus.plexus.archiver.jar.JarArchiver;
31  import org.codehaus.plexus.archiver.jar.Manifest;
32  import org.codehaus.plexus.archiver.jar.ManifestException;
33  import org.codehaus.plexus.util.IOUtil;
34  
35  import java.io.File;
36  import java.io.FileInputStream;
37  import java.io.FileNotFoundException;
38  import java.io.IOException;
39  import java.io.InputStreamReader;
40  import java.io.Reader;
41  import java.util.Collections;
42  import java.util.List;
43  
44  /**
45   * @version $Id: ManifestCreationFinalizer.java 1633832 2014-10-23 15:03:47Z krosenvold $
46   */
47  public class ManifestCreationFinalizer
48      extends AbstractArchiveFinalizer
49  {
50  
51      private final MavenProject project;
52  
53      private final MavenSession session;
54  
55      private final MavenArchiveConfiguration archiveConfiguration;
56  
57      // TODO: I'd really prefer to rewrite MavenArchiver as either a
58      // separate manifest creation utility (and to
59      // create an include pom.properties etc into another archiver), or
60      // an implementation of an archiver
61      // (the first is preferable).
62      private final MavenArchiver mavenArchiver = new MavenArchiver();
63  
64      public ManifestCreationFinalizer( final MavenSession session, final MavenProject project,
65                                        final MavenArchiveConfiguration archiveConfiguration )
66      {
67          this.session = session;
68          this.project = project;
69          this.archiveConfiguration = archiveConfiguration;
70      }
71  
72      @Override
73      public void finalizeArchiveCreation( final Archiver archiver ) throws ArchiverException
74      {
75          if ( archiveConfiguration != null )
76          {
77              try
78              {
79                  Manifest manifest;
80                  final File manifestFile = archiveConfiguration.getManifestFile();
81  
82                  if ( manifestFile != null )
83                  {
84                      Reader manifestFileReader = null;
85                      try
86                      {
87                          manifestFileReader = new InputStreamReader( new FileInputStream( manifestFile ), "UTF-8" );
88                          manifest = new Manifest( manifestFileReader );
89                      }
90                      catch ( final FileNotFoundException e )
91                      {
92                          throw new ArchiverException( "Manifest not found: " + e.getMessage(), e );
93                      }
94                      catch ( final IOException e )
95                      {
96                          throw new ArchiverException( "Error processing manifest: " + e.getMessage(), e );
97                      }
98                      finally
99                      {
100                         IOUtil.close( manifestFileReader );
101                     }
102                 }
103                 else
104                 {
105                     manifest = mavenArchiver.getManifest( session, project, archiveConfiguration );
106                 }
107 
108                 if ( ( manifest != null ) && ( archiver instanceof JarArchiver ) )
109                 {
110                     final JarArchiver jarArchiver = (JarArchiver) archiver;
111                     jarArchiver.addConfiguredManifest( manifest );
112                 }
113             }
114             catch ( final ManifestException e )
115             {
116                 throw new ArchiverException( "Error creating manifest: " + e.getMessage(), e );
117             }
118             catch ( final DependencyResolutionRequiredException e )
119             {
120                 throw new ArchiverException( "Dependencies were not resolved: " + e.getMessage(), e );
121             }
122         }
123     }
124 
125     public List<String> getVirtualFiles()
126     {
127         if ( archiveConfiguration != null )
128         {
129             try
130             {
131                 if ( mavenArchiver.getManifest( project, archiveConfiguration.getManifest() ) != null )
132                 {
133                     return Collections.singletonList( "META-INF/MANIFEST.MF" );
134                 }
135             }
136             catch ( final ManifestException ignore )
137             {
138             }
139             catch ( final DependencyResolutionRequiredException ignore )
140             {
141             }
142         }
143 
144         return null;
145     }
146 
147 }