1 package org.apache.maven.plugins.site.render;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22 import java.io.File;
23 import java.io.IOException;
24
25 import org.apache.maven.archiver.MavenArchiveConfiguration;
26 import org.apache.maven.archiver.MavenArchiver;
27 import org.apache.maven.artifact.DependencyResolutionRequiredException;
28 import org.apache.maven.plugin.MojoExecutionException;
29 import org.apache.maven.plugin.MojoFailureException;
30 import org.apache.maven.plugins.annotations.Component;
31 import org.apache.maven.plugins.annotations.LifecyclePhase;
32 import org.apache.maven.plugins.annotations.Mojo;
33 import org.apache.maven.plugins.annotations.Parameter;
34 import org.apache.maven.plugins.annotations.ResolutionScope;
35 import org.apache.maven.project.MavenProjectHelper;
36 import org.codehaus.plexus.archiver.Archiver;
37 import org.codehaus.plexus.archiver.ArchiverException;
38 import org.codehaus.plexus.archiver.jar.JarArchiver;
39 import org.codehaus.plexus.archiver.jar.ManifestException;
40
41
42
43
44
45
46
47
48
49 @Mojo( name = "jar", defaultPhase = LifecyclePhase.PACKAGE, requiresDependencyResolution = ResolutionScope.TEST,
50 requiresReports = true )
51 public class SiteJarMojo
52 extends SiteMojo
53 {
54 private static final String[] DEFAULT_ARCHIVE_EXCLUDES = new String[]{ };
55
56 private static final String[] DEFAULT_ARCHIVE_INCLUDES = new String[]{ "**/**" };
57
58
59
60
61 @Parameter( property = "project.build.directory", required = true )
62 private String jarOutputDirectory;
63
64
65
66
67
68 @Parameter( property = "project.build.finalName", required = true )
69 private String finalName;
70
71
72
73
74 @Component
75 private MavenProjectHelper projectHelper;
76
77
78
79
80 @Parameter( property = "site.attach", defaultValue = "true" )
81 private boolean attach;
82
83
84
85
86
87
88 @Component( role = Archiver.class, hint = "jar" )
89 private JarArchiver jarArchiver;
90
91
92
93
94
95
96
97 @Parameter
98 private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();
99
100
101
102
103
104
105
106 @Parameter
107 private String[] archiveIncludes;
108
109
110
111
112
113
114
115 @Parameter
116 private String[] archiveExcludes;
117
118
119
120
121
122
123
124
125 @Parameter( defaultValue = "${project.build.outputTimestamp}" )
126 private String outputTimestamp;
127
128
129
130
131 public void execute()
132 throws MojoExecutionException, MojoFailureException
133 {
134 if ( skip )
135 {
136 getLog().info( "maven.site.skip = true: Skipping jar generation" );
137 return;
138 }
139
140 super.execute();
141
142 try
143 {
144 File outputFile = createArchive( outputDirectory,
145 finalName + "-" + getClassifier() + "." + getArtifactType() );
146
147 if ( attach )
148 {
149 projectHelper.attachArtifact( project, getArtifactType(), getClassifier(), outputFile );
150 }
151 else
152 {
153 getLog().info( "NOT adding site jar to the list of attached artifacts." );
154 }
155 }
156 catch ( ArchiverException | IOException | ManifestException | DependencyResolutionRequiredException e )
157 {
158 throw new MojoExecutionException( "Error while creating archive.", e );
159 }
160 }
161
162 protected String getArtifactType()
163 {
164 return "jar";
165 }
166
167 protected String getClassifier()
168 {
169 return "site";
170 }
171
172
173
174
175
176
177
178
179
180
181
182
183 private File createArchive( File siteDirectory, String jarFilename )
184 throws ArchiverException, IOException, ManifestException, DependencyResolutionRequiredException
185 {
186 File siteJar = new File( jarOutputDirectory, jarFilename );
187
188 MavenArchiver archiver = new MavenArchiver();
189 archiver.setCreatedBy( "Maven Site Plugin", "org.apache.maven.plugins", "maven-site-plugin" );
190
191 archiver.setArchiver( this.jarArchiver );
192
193 archiver.setOutputFile( siteJar );
194
195
196 archiver.configureReproducible( outputTimestamp );
197
198 if ( !siteDirectory.isDirectory() )
199 {
200 getLog().warn( "JAR will be empty - no content was marked for inclusion!" );
201 }
202 else
203 {
204 archiver.getArchiver().addDirectory( siteDirectory, getArchiveIncludes(), getArchiveExcludes() );
205 }
206
207 archiver.createArchive( getSession(), getProject(), archive );
208
209 return siteJar;
210 }
211
212 private String[] getArchiveIncludes()
213 {
214 if ( this.archiveIncludes != null && this.archiveIncludes.length > 0 )
215 {
216 return this.archiveIncludes;
217 }
218
219 return DEFAULT_ARCHIVE_INCLUDES;
220 }
221
222 private String[] getArchiveExcludes()
223 {
224 if ( this.archiveExcludes != null && this.archiveExcludes.length > 0 )
225 {
226 return this.archiveExcludes;
227 }
228 return DEFAULT_ARCHIVE_EXCLUDES;
229 }
230 }