1 /*
2 * Copyright (C) Christian Schulte <cs@schulte.it>, 2005-206
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * o Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * o Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
15 * distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * $JOMC: AbstractResourcesWriteMojo.java 5043 2015-05-27 07:03:39Z schulte $
29 *
30 */
31 package org.jomc.mojo;
32
33 import java.io.File;
34 import java.util.Locale;
35 import java.util.logging.Level;
36 import javax.xml.bind.JAXBContext;
37 import javax.xml.bind.util.JAXBSource;
38 import javax.xml.transform.Source;
39 import org.apache.commons.io.FileUtils;
40 import org.apache.maven.model.Resource;
41 import org.apache.maven.plugin.MojoExecutionException;
42 import org.apache.maven.project.MavenProject;
43 import org.jomc.model.Module;
44 import org.jomc.modlet.ModelContext;
45 import org.jomc.modlet.ModelValidationReport;
46 import org.jomc.modlet.ObjectFactory;
47 import org.jomc.tools.ResourceFileProcessor;
48
49 /**
50 * Base class for writing resource files.
51 *
52 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
53 * @version $JOMC: AbstractResourcesWriteMojo.java 5043 2015-05-27 07:03:39Z schulte $
54 */
55 public abstract class AbstractResourcesWriteMojo extends AbstractJomcMojo
56 {
57
58 /**
59 * Constant for the name of the tool backing the class.
60 */
61 private static final String TOOLNAME = "ResourceFileProcessor";
62
63 /**
64 * The language of the default language properties file of generated resource bundle properties resources.
65 *
66 * @parameter expression="${jomc.resourceBundleDefaultLanguage}"
67 */
68 private String resourceBundleDefaultLanguage;
69
70 /**
71 * Creates a new {@code AbstractResourcesWriteMojo} instance.
72 */
73 public AbstractResourcesWriteMojo()
74 {
75 super();
76 }
77
78 @Override
79 protected final void executeTool() throws Exception
80 {
81 this.logSeparator();
82
83 if ( this.isResourceProcessingEnabled() )
84 {
85 this.logProcessingModule( TOOLNAME, this.getResourcesModuleName() );
86
87 final ModelContext context = this.createModelContext( this.getResourcesClassLoader() );
88 final ResourceFileProcessor tool = this.createResourceFileProcessor( context );
89 final JAXBContext jaxbContext = context.createContext( this.getModel() );
90 final Source source = new JAXBSource( jaxbContext, new ObjectFactory().createModel( tool.getModel() ) );
91 final ModelValidationReport validationReport = context.validateModel( this.getModel(), source );
92
93 if ( this.resourceBundleDefaultLanguage != null )
94 {
95 tool.setResourceBundleDefaultLocale(
96 new Locale( this.resourceBundleDefaultLanguage.toLowerCase( Locale.ENGLISH ) ) );
97
98 }
99
100 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport );
101
102 if ( validationReport.isModelValid() )
103 {
104 final Module module =
105 tool.getModules() != null ? tool.getModules().getModule( this.getResourcesModuleName() ) : null;
106
107 if ( module != null )
108 {
109 if ( !this.getResourcesDirectory().exists() && !this.getResourcesDirectory().mkdirs() )
110 {
111 throw new MojoExecutionException( Messages.getMessage(
112 "failedCreatingDirectory", this.getResourcesDirectory().getAbsolutePath() ) );
113
114 }
115
116 tool.writeResourceBundleResourceFiles( module, this.getResourcesDirectory() );
117
118 if ( !this.getResourcesDirectory().equals( this.getResourcesOutputDirectory() ) )
119 {
120 FileUtils.copyDirectory( this.getResourcesDirectory(), this.getResourcesOutputDirectory() );
121 }
122
123 final Resource resource = new Resource();
124 resource.setDirectory( this.getResourcesDirectory().getAbsolutePath() );
125 resource.setFiltering( false );
126
127 this.addMavenResource( this.getMavenProject(), resource );
128
129 this.logToolSuccess( TOOLNAME );
130 }
131 else
132 {
133 this.logMissingModule( this.getResourcesModuleName() );
134 }
135 }
136 else
137 {
138 throw new MojoExecutionException( Messages.getMessage( "resourceProcessingFailure" ) );
139 }
140 }
141 else if ( this.isLoggable( Level.INFO ) )
142 {
143 this.log( Level.INFO, Messages.getMessage( "resourceProcessingDisabled" ), null );
144 }
145 }
146
147 /**
148 * Gets the name of the module to write resource files of.
149 *
150 * @return The name of the module to write resource files of.
151 *
152 * @throws MojoExecutionException if getting the name fails.
153 */
154 protected abstract String getResourcesModuleName() throws MojoExecutionException;
155
156 /**
157 * Gets the class loader to use for writing resource files.
158 *
159 * @return The class loader to use for writing resource files.
160 *
161 * @throws MojoExecutionException if getting the class loader fails.
162 */
163 protected abstract ClassLoader getResourcesClassLoader() throws MojoExecutionException;
164
165 /**
166 * Gets the directory to write the resource files to.
167 *
168 * @return The directory to write the resource files to.
169 *
170 * @throws MojoExecutionException if getting the directory fails.
171 */
172 protected abstract File getResourcesDirectory() throws MojoExecutionException;
173
174 /**
175 * Gets the directory to copy resource files to.
176 *
177 * @return The directory to copy resource files to.
178 *
179 * @throws MojoExecutionException if getting the directory fails.
180 *
181 * @since 1.2
182 */
183 protected abstract File getResourcesOutputDirectory() throws MojoExecutionException;
184
185 /**
186 * Adds a resource to a {@code MavenProjecŧ}.
187 *
188 * @param mavenProject The {@code MavenProject} to add a resource to.
189 * @param resource The {@code Resource} to add.
190 *
191 * @throws MojoExecutionException if adding the resource fails.
192 *
193 * @since 1.2
194 */
195 protected abstract void addMavenResource( MavenProject mavenProject, Resource resource )
196 throws MojoExecutionException;
197
198 }