Google Git
Sign in
apache / logging-log4j-audit-site / 4ea2ec6d7b4f743fb9c5b48c774e9fbe5be4cd24 / . / log4j-audit-1.0.0 / log4j-audit / log4j-audit-maven-plugin / xref / org / apache / logging / log4j / audit / plugin / AuditMojo.html
blob: 77d22fb9d0adf3497c74654e713b2ca9719b90e4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AuditMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/audit/plugin/AuditMojo.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Copyright 2001-2005 The Apache Software Foundation.</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.audit.plugin;
<a class="jxr_linenumber" name="L17" href="#L17">17</a>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Constructor;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.audit.generator.InterfacesGenerator;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.catalog.api.CatalogReader;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.catalog.api.dao.JsonCatalogReader;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.util.LoaderUtil;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * Goal which generates the audit interfaces.</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> @Mojo(name = <span class="jxr_string">"generate"</span>, defaultPhase = LifecyclePhase.GENERATE_SOURCES)
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/audit/plugin/AuditMojo.html">AuditMojo</a> <strong class="jxr_keyword">extends</strong> AbstractMojo {
<a class="jxr_linenumber" name="L39" href="#L39">39</a>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BASEDIR = <span class="jxr_string">"baseDir"</span>;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BUILDDIR = <span class="jxr_string">"buildDir"</span>;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MAX_KEY_LENGTH = 32;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_ENTERPRISE_ID = 18060;
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> @Parameter(defaultValue = <span class="jxr_string">"${project}"</span>)
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> MavenProject project;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Parameter(property = <span class="jxr_string">"catalogReaderClassName"</span>, defaultValue = <span class="jxr_string">"org.apache.logging.log4j.catalog.api.dao.FileCatalogReader"</span>)
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> String catalogReaderClassName;
<a class="jxr_linenumber" name="L50" href="#L50">50</a>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> @Parameter(property = <span class="jxr_string">"catalogReaderAttributes"</span>, required = false)
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> Map&lt;String, String&gt; catalogReaderAttributes;
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> @Parameter(property = <span class="jxr_string">"packageName"</span>, required = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> String packageName;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * Location of the file.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> @Parameter(defaultValue = <span class="jxr_string">"${project.build.directory}/generated-sources/log4j-audit"</span>, property = <span class="jxr_string">"outputDir"</span>)
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> File outputDirectory;
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Parameter(required = false)
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> maxKeyLength;
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Parameter(required = false)
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> enterpriseId;
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>)
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> MojoExecutionException {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">if</strong> (maxKeyLength &lt;= 0) {
<a class="jxr_linenumber" name="L71" href="#L71">71</a> maxKeyLength = MAX_KEY_LENGTH;
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (enterpriseId &lt;= 0) {
<a class="jxr_linenumber" name="L74" href="#L74">74</a> enterpriseId = DEFAULT_ENTERPRISE_ID;
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a> CatalogReader catalogReader = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> File basedir = project.getBasedir();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> Class&lt;?&gt; clazz = LoaderUtil.loadClass(catalogReaderClassName);
<a class="jxr_linenumber" name="L80" href="#L80">80</a> Constructor&lt;CatalogReader&gt;[] constructors = (Constructor&lt;CatalogReader&gt;[]) clazz.getConstructors();
<a class="jxr_linenumber" name="L81" href="#L81">81</a>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">for</strong> (Constructor&lt;CatalogReader&gt; constructor : constructors) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (constructor.getParameterCount() == 1 &amp;&amp; constructor.getParameterTypes()[0].isAssignableFrom(Map.<strong class="jxr_keyword">class</strong>)) {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (catalogReaderAttributes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> catalogReaderAttributes = <strong class="jxr_keyword">new</strong> HashMap&lt;&gt;();
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> (!catalogReaderAttributes.containsKey(BASEDIR)) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> catalogReaderAttributes.put(BASEDIR, project.getBasedir().getAbsolutePath());
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (!catalogReaderAttributes.containsKey(BUILDDIR)) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> catalogReaderAttributes.put(BUILDDIR, project.getBuild().getDirectory());
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> catalogReader = constructor.newInstance(catalogReaderAttributes);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">break</strong>;
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (catalogReader == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> catalogReader = LoaderUtil.newInstanceOf(catalogReaderClassName);
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="L102" href="#L102">102</a> getLog().error(<span class="jxr_string">"Unable to load catalog reader "</span> + catalogReaderClassName, ex);
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="L104" href="#L104">104</a> }
<a class="jxr_linenumber" name="L105" href="#L105">105</a> InterfacesGenerator generator = <strong class="jxr_keyword">new</strong> InterfacesGenerator();
<a class="jxr_linenumber" name="L106" href="#L106">106</a> JsonCatalogReader jsonCatalogReader = <strong class="jxr_keyword">new</strong> JsonCatalogReader();
<a class="jxr_linenumber" name="L107" href="#L107">107</a> jsonCatalogReader.setCatalogReader(catalogReader);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> jsonCatalogReader.init();
<a class="jxr_linenumber" name="L109" href="#L109">109</a> generator.setCatalogReader(jsonCatalogReader);
<a class="jxr_linenumber" name="L110" href="#L110">110</a> generator.setOutputDirectory(outputDirectory.getAbsolutePath());
<a class="jxr_linenumber" name="L111" href="#L111">111</a> generator.setPackageName(packageName);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> generator.setMaxKeyLength(maxKeyLength);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> generator.setEnterpriseId(enterpriseId);
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L115" href="#L115">115</a> generator.generateSource();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> project.addCompileSourceRoot(outputDirectory.getAbsolutePath());
<a class="jxr_linenumber" name="L117" href="#L117">117</a> } <strong class="jxr_keyword">catch</strong> (Exception ex) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(<span class="jxr_string">"Error generating Audit interfaces"</span>, ex);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2016&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>