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 1639422 2014-11-13 18:08:07Z 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 )
74          throws ArchiverException
75      {
76          if ( archiveConfiguration != null )
77          {
78              try
79              {
80                  Manifest manifest;
81                  final File manifestFile = archiveConfiguration.getManifestFile();
82  
83                  if ( manifestFile != null )
84                  {
85                      Reader manifestFileReader = null;
86                      try
87                      {
88                          manifestFileReader = new InputStreamReader( new FileInputStream( manifestFile ), "UTF-8" );
89                          manifest = new Manifest( manifestFileReader );
90                      }
91                      catch ( final FileNotFoundException e )
92                      {
93                          throw new ArchiverException( "Manifest not found: " + e.getMessage(), e );
94                      }
95                      catch ( final IOException e )
96                      {
97                          throw new ArchiverException( "Error processing manifest: " + e.getMessage(), e );
98                      }
99                      finally
100                     {
101                         IOUtil.close( manifestFileReader );
102                     }
103                 }
104                 else
105                 {
106                     manifest = mavenArchiver.getManifest( session, project, archiveConfiguration );
107                 }
108 
109                 if ( ( manifest != null ) && ( archiver instanceof JarArchiver ) )
110                 {
111                     final JarArchiver jarArchiver = (JarArchiver) archiver;
112                     jarArchiver.addConfiguredManifest( manifest );
113                 }
114             }
115             catch ( final ManifestException e )
116             {
117                 throw new ArchiverException( "Error creating manifest: " + e.getMessage(), e );
118             }
119             catch ( final DependencyResolutionRequiredException e )
120             {
121                 throw new ArchiverException( "Dependencies were not resolved: " + e.getMessage(), e );
122             }
123         }
124     }
125 
126     public List<String> getVirtualFiles()
127     {
128         if ( archiveConfiguration != null )
129         {
130             try
131             {
132                 if ( mavenArchiver.getManifest( project, archiveConfiguration.getManifest() ) != null )
133                 {
134                     return Collections.singletonList( "META-INF/MANIFEST.MF" );
135                 }
136             }
137             catch ( final ManifestException ignore )
138             {
139             }
140             catch ( final DependencyResolutionRequiredException ignore )
141             {
142             }
143         }
144 
145         return null;
146     }
147 
148 }