001/* 002 * Copyright (C) Christian Schulte, 2005-206 003 * All rights reserved. 004 * 005 * Redistribution and use in source and binary forms, with or without 006 * modification, are permitted provided that the following conditions 007 * are met: 008 * 009 * o Redistributions of source code must retain the above copyright 010 * notice, this list of conditions and the following disclaimer. 011 * 012 * o Redistributions in binary form must reproduce the above copyright 013 * notice, this list of conditions and the following disclaimer in 014 * the documentation and/or other materials provided with the 015 * distribution. 016 * 017 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 018 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 019 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 020 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT, 021 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 022 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 023 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 024 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 025 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 026 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 027 * 028 * $JOMC: AbstractResourcesWriteMojo.java 4613 2012-09-22 10:07:08Z schulte $ 029 * 030 */ 031package org.jomc.mojo; 032 033import java.io.File; 034import java.util.Locale; 035import java.util.logging.Level; 036import javax.xml.bind.JAXBContext; 037import javax.xml.bind.util.JAXBSource; 038import javax.xml.transform.Source; 039import org.apache.commons.io.FileUtils; 040import org.apache.maven.model.Resource; 041import org.apache.maven.plugin.MojoExecutionException; 042import org.apache.maven.project.MavenProject; 043import org.jomc.model.Module; 044import org.jomc.modlet.ModelContext; 045import org.jomc.modlet.ModelValidationReport; 046import org.jomc.modlet.ObjectFactory; 047import org.jomc.tools.ResourceFileProcessor; 048 049/** 050 * Base class for writing resource files. 051 * 052 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a> 053 * @version $JOMC: AbstractResourcesWriteMojo.java 4613 2012-09-22 10:07:08Z schulte $ 054 */ 055public abstract class AbstractResourcesWriteMojo extends AbstractJomcMojo 056{ 057 058 /** Constant for the name of the tool backing the class. */ 059 private static final String TOOLNAME = "ResourceFileProcessor"; 060 061 /** 062 * The language of the default language properties file of generated resource bundle properties resources. 063 * 064 * @parameter expression="${jomc.resourceBundleDefaultLanguage}" 065 */ 066 private String resourceBundleDefaultLanguage; 067 068 /** Creates a new {@code AbstractResourcesWriteMojo} instance. */ 069 public AbstractResourcesWriteMojo() 070 { 071 super(); 072 } 073 074 @Override 075 protected final void executeTool() throws Exception 076 { 077 this.logSeparator(); 078 079 if ( this.isResourceProcessingEnabled() ) 080 { 081 this.logProcessingModule( TOOLNAME, this.getResourcesModuleName() ); 082 083 final ModelContext context = this.createModelContext( this.getResourcesClassLoader() ); 084 final ResourceFileProcessor tool = this.createResourceFileProcessor( context ); 085 final JAXBContext jaxbContext = context.createContext( this.getModel() ); 086 final Source source = new JAXBSource( jaxbContext, new ObjectFactory().createModel( tool.getModel() ) ); 087 final ModelValidationReport validationReport = context.validateModel( this.getModel(), source ); 088 089 if ( this.resourceBundleDefaultLanguage != null ) 090 { 091 tool.setResourceBundleDefaultLocale( 092 new Locale( this.resourceBundleDefaultLanguage.toLowerCase( Locale.ENGLISH ) ) ); 093 094 } 095 096 this.log( context, validationReport.isModelValid() ? Level.INFO : Level.SEVERE, validationReport ); 097 098 if ( validationReport.isModelValid() ) 099 { 100 final Module module = 101 tool.getModules() != null ? tool.getModules().getModule( this.getResourcesModuleName() ) : null; 102 103 if ( module != null ) 104 { 105 if ( !this.getResourcesDirectory().exists() && !this.getResourcesDirectory().mkdirs() ) 106 { 107 throw new MojoExecutionException( Messages.getMessage( 108 "failedCreatingDirectory", this.getResourcesDirectory().getAbsolutePath() ) ); 109 110 } 111 112 tool.writeResourceBundleResourceFiles( module, this.getResourcesDirectory() ); 113 114 if ( !this.getResourcesDirectory().equals( this.getResourcesOutputDirectory() ) ) 115 { 116 FileUtils.copyDirectory( this.getResourcesDirectory(), this.getResourcesOutputDirectory() ); 117 } 118 119 final Resource resource = new Resource(); 120 resource.setDirectory( this.getResourcesDirectory().getAbsolutePath() ); 121 resource.setFiltering( false ); 122 123 this.addMavenResource( this.getMavenProject(), resource ); 124 125 this.logToolSuccess( TOOLNAME ); 126 } 127 else 128 { 129 this.logMissingModule( this.getResourcesModuleName() ); 130 } 131 } 132 else 133 { 134 throw new MojoExecutionException( Messages.getMessage( "resourceProcessingFailure" ) ); 135 } 136 } 137 else if ( this.isLoggable( Level.INFO ) ) 138 { 139 this.log( Level.INFO, Messages.getMessage( "resourceProcessingDisabled" ), null ); 140 } 141 } 142 143 /** 144 * Gets the name of the module to write resource files of. 145 * 146 * @return The name of the module to write resource files of. 147 * 148 * @throws MojoExecutionException if getting the name fails. 149 */ 150 protected abstract String getResourcesModuleName() throws MojoExecutionException; 151 152 /** 153 * Gets the class loader to use for writing resource files. 154 * 155 * @return The class loader to use for writing resource files. 156 * 157 * @throws MojoExecutionException if getting the class loader fails. 158 */ 159 protected abstract ClassLoader getResourcesClassLoader() throws MojoExecutionException; 160 161 /** 162 * Gets the directory to write the resource files to. 163 * 164 * @return The directory to write the resource files to. 165 * 166 * @throws MojoExecutionException if getting the directory fails. 167 */ 168 protected abstract File getResourcesDirectory() throws MojoExecutionException; 169 170 /** 171 * Gets the directory to copy resource files to. 172 * 173 * @return The directory to copy resource files to. 174 * 175 * @throws MojoExecutionException if getting the directory fails. 176 * 177 * @since 1.2 178 */ 179 protected abstract File getResourcesOutputDirectory() throws MojoExecutionException; 180 181 /** 182 * Adds a resource to a {@code MavenProjecŧ}. 183 * 184 * @param mavenProject The {@code MavenProject} to add a resource to. 185 * @param resource The {@code Resource} to add. 186 * 187 * @throws MojoExecutionException if adding the resource fails. 188 * 189 * @since 1.2 190 */ 191 protected abstract void addMavenResource( MavenProject mavenProject, Resource resource ) 192 throws MojoExecutionException; 193 194}