1 /*
2 * Copyright (C) 2005 Christian Schulte <cs@schulte.it>
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: AbstractModelShowMojo.java 5228 2016-04-24 11:08:06Z schulte $
29 *
30 */
31 package org.jomc.mojo;
32
33 import java.io.File;
34 import java.io.StringWriter;
35 import java.util.logging.Level;
36 import javax.xml.bind.JAXBElement;
37 import javax.xml.bind.Marshaller;
38 import org.apache.maven.plugin.MojoExecutionException;
39 import org.apache.maven.plugins.annotations.Parameter;
40 import org.jomc.modlet.ModelContext;
41
42 /**
43 * Base class for displaying and dumping model objects.
44 *
45 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
46 * @version $JOMC: AbstractModelShowMojo.java 5228 2016-04-24 11:08:06Z schulte $
47 * @since 1.1
48 */
49 public abstract class AbstractModelShowMojo extends AbstractJomcMojo
50 {
51
52 /**
53 * Constant for the name of the tool backing the mojo.
54 */
55 private static final String TOOLNAME = "ModelProcessor";
56
57 /**
58 * File to write the model to.
59 */
60 @Parameter( name = "document",
61 property = "jomc.document" )
62 private File document;
63
64 /**
65 * Encoding of the document to write.
66 */
67 @Parameter( name = "documentEncoding",
68 property = "jomc.documentEncoding",
69 defaultValue = "${project.build.sourceEncoding}" )
70 private String documentEncoding;
71
72 /**
73 * Creates a new {@code AbstractModelShowMojo} instance.
74 */
75 public AbstractModelShowMojo()
76 {
77 super();
78 }
79
80 @Override
81 protected final void executeTool() throws Exception
82 {
83 this.logSeparator();
84 this.logProcessingModel( TOOLNAME, this.getModel() );
85
86 final ModelContext modelContext = this.createModelContext( this.getDisplayClassLoader() );
87 final Marshaller m = modelContext.createMarshaller( this.getModel() );
88 final JAXBElement<?> displayModel = this.getDisplayModel( modelContext );
89 m.setSchema( modelContext.createSchema( this.getModel() ) );
90 m.setProperty( Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE );
91
92 if ( displayModel != null )
93 {
94 if ( this.document == null )
95 {
96 final StringWriter stringWriter = new StringWriter();
97 m.marshal( displayModel, stringWriter );
98
99 final boolean verbose = this.isVerbose();
100 try
101 {
102 this.setVerbose( true );
103
104 if ( this.isLoggable( Level.INFO ) )
105 {
106 this.log( Level.INFO, stringWriter.toString(), null );
107 }
108 }
109 finally
110 {
111 this.setVerbose( verbose );
112 }
113 }
114 else
115 {
116 if ( this.document.exists() && !this.document.delete() && this.isLoggable( Level.WARNING ) )
117 {
118 this.log( Level.WARNING, Messages.getMessage(
119 "failedDeletingFile", this.document.getAbsolutePath() ), null );
120
121 }
122
123 if ( this.isLoggable( Level.INFO ) )
124 {
125 this.log( Level.INFO, Messages.getMessage(
126 "writingEncoded", this.document.getAbsolutePath(), this.documentEncoding ), null );
127
128 }
129
130 m.setProperty( Marshaller.JAXB_ENCODING, this.documentEncoding );
131 m.marshal( displayModel, this.document );
132 }
133
134 this.logToolSuccess( TOOLNAME );
135 }
136 else if ( this.isLoggable( Level.WARNING ) )
137 {
138 this.log( Level.WARNING, Messages.getMessage( "modelObjectNotFound" ), null );
139 }
140 }
141
142 /**
143 * Gets the model object to display or dump.
144 *
145 * @param modelContext The model context to use for getting the model.
146 *
147 * @return The model object to display or dump.
148 *
149 * @throws MojoExecutionException if getting the model fails.
150 */
151 protected abstract JAXBElement<?> getDisplayModel( ModelContext modelContext ) throws MojoExecutionException;
152
153 /**
154 * Gets the class loader to use for displaying or dumping model objects.
155 *
156 * @return The class loader to use for displaying or dumping model objects.
157 *
158 * @throws MojoExecutionException if getting the class loader fails.
159 */
160 protected abstract ClassLoader getDisplayClassLoader() throws MojoExecutionException;
161
162 }