mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-19 15:54:52 +01:00
documentation v1.3.1
This commit is contained in:
Jeremy Long
96
xref/org/owasp/dependencycheck/reporting/EscapeTool.html
Normal file
96
xref/org/owasp/dependencycheck/reporting/EscapeTool.html
Normal file
@@ -0,0 +1,96 @@
|
||||
<!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>EscapeTool xref</title>
|
||||
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/reporting/EscapeTool.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"> * This file is part of dependency-check-core.</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> <em class="jxr_comment"> * Copyright (c) 2014 Jeremy Long. All Rights Reserved.</em>
|
||||
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
|
||||
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.reporting;
|
||||
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
|
||||
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
|
||||
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
|
||||
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringEscapeUtils;
|
||||
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
|
||||
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
|
||||
<a class="jxr_linenumber" name="L25" href="#L25">25</a>
|
||||
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * An extremely simple wrapper around various escape utils to perform URL and HTML encoding within the reports. This class was</em>
|
||||
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * created to simplify the velocity configuration and avoid using the "built-in" escape tool.</em>
|
||||
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/reporting/EscapeTool.html">EscapeTool</a> {
|
||||
<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"> * The logger.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(EscapeTool.<strong class="jxr_keyword">class</strong>);
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * URL Encodes the provided text.</em>
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @param text the text to encode</em>
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @return the URL encoded text</em>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> String url(String text) {
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">if</strong> (text == <strong class="jxr_keyword">null</strong> || text.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">return</strong> text;
|
||||
<a class="jxr_linenumber" name="L48" href="#L48">48</a> }
|
||||
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">return</strong> URLEncoder.encode(text, <span class="jxr_string">"UTF-8"</span>);
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException ex) {
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> LOGGER.warn(<span class="jxr_string">"UTF-8 is not supported?"</span>);
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a> LOGGER.info(<span class="jxr_string">""</span>, ex);
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> }
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a>
|
||||
<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> <em class="jxr_javadoccomment"> * HTML Encodes the provided text.</em>
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param text the text to encode</em>
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return the HTML encoded text</em>
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> String html(String text) {
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">if</strong> (text == <strong class="jxr_keyword">null</strong> || text.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> text;
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> StringEscapeUtils.escapeHtml4(text);
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * XML Encodes the provided text.</em>
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @param text the text to encode</em>
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @return the XML encoded text</em>
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> String xml(String text) {
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (text == <strong class="jxr_keyword">null</strong> || text.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> text;
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">return</strong> StringEscapeUtils.escapeXml11(text);
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
</body>
|
||||
</html>
|
||||
331
xref/org/owasp/dependencycheck/reporting/ReportGenerator.html
Normal file
331
xref/org/owasp/dependencycheck/reporting/ReportGenerator.html
Normal file
@@ -0,0 +1,331 @@
|
||||
<!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>ReportGenerator xref</title>
|
||||
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/reporting/ReportGenerator.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"> * This file is part of dependency-check-core.</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> <em class="jxr_comment"> * Copyright (c) 2012 Jeremy Long. All Rights Reserved.</em>
|
||||
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
|
||||
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.reporting;
|
||||
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
|
||||
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
|
||||
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
|
||||
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException;
|
||||
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.FileOutputStream;
|
||||
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
|
||||
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
|
||||
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.io.InputStreamReader;
|
||||
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream;
|
||||
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.OutputStreamWriter;
|
||||
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.text.DateFormat;
|
||||
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.text.SimpleDateFormat;
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.Date;
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> java.util.List;
|
||||
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.VelocityContext;
|
||||
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.app.VelocityEngine;
|
||||
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context;
|
||||
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeConstants;
|
||||
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.analyzer.Analyzer;
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.data.nvdcve.DatabaseProperties;
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.dependency.Dependency;
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.owasp.dependencycheck.utils.Settings;
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
|
||||
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * The ReportGenerator is used to, as the name implies, generate reports. Internally the generator uses the Velocity</em>
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Templating Engine. The ReportGenerator exposes a list of Dependencies to the template when generating the report.</em>
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
|
||||
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/reporting/ReportGenerator.html">ReportGenerator</a> {
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * The logger.</em>
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(ReportGenerator.<strong class="jxr_keyword">class</strong>);
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a>
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * An enumeration of the report formats.</em>
|
||||
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../org/owasp/dependencycheck/reporting/ReportGenerator.html">Format</a> {
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Generate all reports.</em>
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> ALL,
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * Generate XML report.</em>
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> XML,
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Generate HTML report.</em>
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> HTML,
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Generate HTML Vulnerability report.</em>
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> VULN
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> }
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * The Velocity Engine.</em>
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> VelocityEngine engine;
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * The Velocity Engine Context.</em>
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Context context;
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Constructs a new ReportGenerator.</em>
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @param applicationName the application name being analyzed</em>
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param dependencies the list of dependencies</em>
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param analyzers the list of analyzers used</em>
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param properties the database properties (containing timestamps of the NVD CVE data)</em>
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/owasp/dependencycheck/reporting/ReportGenerator.html">ReportGenerator</a>(String applicationName, List<Dependency> dependencies, List<Analyzer> analyzers, <a href="../../../../org/owasp/dependencycheck/data/nvdcve/DatabaseProperties.html">DatabaseProperties</a> properties) {
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> engine = createVelocityEngine();
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> context = createContext();
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a>
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> engine.init();
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a>
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">final</strong> DateFormat dateFormat = <strong class="jxr_keyword">new</strong> SimpleDateFormat(<span class="jxr_string">"MMM d, yyyy 'at' HH:mm:ss z"</span>);
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">final</strong> DateFormat dateFormatXML = <strong class="jxr_keyword">new</strong> SimpleDateFormat(<span class="jxr_string">"yyyy-MM-dd'T'HH:mm:ss.SSSZ"</span>);
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">final</strong> Date d = <strong class="jxr_keyword">new</strong> Date();
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">final</strong> String scanDate = dateFormat.format(d);
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">final</strong> String scanDateXML = dateFormatXML.format(d);
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">final</strong> <a href="../../../../org/owasp/dependencycheck/reporting/EscapeTool.html">EscapeTool</a> enc = <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/reporting/EscapeTool.html">EscapeTool</a>();
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a> context.put(<span class="jxr_string">"applicationName"</span>, applicationName);
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> context.put(<span class="jxr_string">"dependencies"</span>, dependencies);
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> context.put(<span class="jxr_string">"analyzers"</span>, analyzers);
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> context.put(<span class="jxr_string">"properties"</span>, properties);
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> context.put(<span class="jxr_string">"scanDate"</span>, scanDate);
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a> context.put(<span class="jxr_string">"scanDateXML"</span>, scanDateXML);
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> context.put(<span class="jxr_string">"enc"</span>, enc);
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> context.put(<span class="jxr_string">"version"</span>, Settings.getString(Settings.KEYS.APPLICATION_VERSION, <span class="jxr_string">"Unknown"</span>));
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a>
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Creates a new Velocity Engine.</em>
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> * @return a velocity engine.</em>
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">private</strong> VelocityEngine createVelocityEngine() {
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">final</strong> VelocityEngine engine = <strong class="jxr_keyword">new</strong> VelocityEngine();
|
||||
<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_comment">// Logging redirection for Velocity - Required by Jenkins and other server applications</em>
|
||||
<a class="jxr_linenumber" name="L127" href="#L127">127</a> engine.setProperty(RuntimeConstants.RUNTIME_LOG_LOGSYSTEM_CLASS, VelocityLoggerRedirect.<strong class="jxr_keyword">class</strong>.getName());
|
||||
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> engine;
|
||||
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
|
||||
<a class="jxr_linenumber" name="L130" href="#L130">130</a>
|
||||
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * Creates a new Velocity Context.</em>
|
||||
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @return a Velocity Context.</em>
|
||||
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">private</strong> Context createContext() {
|
||||
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> VelocityContext();
|
||||
<a class="jxr_linenumber" name="L138" href="#L138">138</a> }
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a>
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * Generates the Dependency Reports for the identified dependencies.</em>
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @param outputStream the OutputStream to send the generated report to</em>
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * @param format the format the report should be written in</em>
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown when the template file does not exist</em>
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @throws Exception is thrown if there is an error writing out the reports.</em>
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generateReports(OutputStream outputStream, <a href="../../../../org/owasp/dependencycheck/reporting/ReportGenerator.html">Format</a> format) <strong class="jxr_keyword">throws</strong> IOException, Exception {
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (format == Format.XML || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a> generateReport(<span class="jxr_string">"XmlReport"</span>, outputStream);
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (format == Format.HTML || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> generateReport(<span class="jxr_string">"HtmlReport"</span>, outputStream);
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">if</strong> (format == Format.VULN || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a> generateReport(<span class="jxr_string">"VulnerabilityReport"</span>, outputStream);
|
||||
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
|
||||
<a class="jxr_linenumber" name="L158" href="#L158">158</a> }
|
||||
<a class="jxr_linenumber" name="L159" href="#L159">159</a>
|
||||
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * Generates the Dependency Reports for the identified dependencies.</em>
|
||||
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> * @param outputDir the path where the reports should be written</em>
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * @param format the format the report should be written in</em>
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown when the template file does not exist</em>
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * @throws Exception is thrown if there is an error writing out the reports.</em>
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generateReports(String outputDir, <a href="../../../../org/owasp/dependencycheck/reporting/ReportGenerator.html">Format</a> format) <strong class="jxr_keyword">throws</strong> IOException, Exception {
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">if</strong> (format == Format.XML || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> generateReport(<span class="jxr_string">"XmlReport"</span>, outputDir + File.separator + <span class="jxr_string">"dependency-check-report.xml"</span>);
|
||||
<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
|
||||
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> (format == Format.HTML || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L173" href="#L173">173</a> generateReport(<span class="jxr_string">"HtmlReport"</span>, outputDir + File.separator + <span class="jxr_string">"dependency-check-report.html"</span>);
|
||||
<a class="jxr_linenumber" name="L174" href="#L174">174</a> }
|
||||
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> (format == Format.VULN || format == Format.ALL) {
|
||||
<a class="jxr_linenumber" name="L176" href="#L176">176</a> generateReport(<span class="jxr_string">"VulnerabilityReport"</span>, outputDir + File.separator + <span class="jxr_string">"dependency-check-vulnerability.html"</span>);
|
||||
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
|
||||
<a class="jxr_linenumber" name="L178" href="#L178">178</a> }
|
||||
<a class="jxr_linenumber" name="L179" href="#L179">179</a>
|
||||
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * Generates the Dependency Reports for the identified dependencies.</em>
|
||||
<a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em class="jxr_javadoccomment"> * @param outputDir the path where the reports should be written</em>
|
||||
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment"> * @param outputFormat the format the report should be written in (XML, HTML, ALL)</em>
|
||||
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown when the template file does not exist</em>
|
||||
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * @throws Exception is thrown if there is an error writing out the reports.</em>
|
||||
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> generateReports(String outputDir, String outputFormat) <strong class="jxr_keyword">throws</strong> IOException, Exception {
|
||||
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> String format = outputFormat.toUpperCase();
|
||||
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">final</strong> String pathToCheck = outputDir.toLowerCase();
|
||||
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> (format.matches(<span class="jxr_string">"^(XML|HTML|VULN|ALL)$"</span>)) {
|
||||
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"XML"</span>.equalsIgnoreCase(format)) {
|
||||
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (pathToCheck.endsWith(<span class="jxr_string">".xml"</span>)) {
|
||||
<a class="jxr_linenumber" name="L194" href="#L194">194</a> generateReport(<span class="jxr_string">"XmlReport"</span>, outputDir);
|
||||
<a class="jxr_linenumber" name="L195" href="#L195">195</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L196" href="#L196">196</a> generateReports(outputDir, Format.XML);
|
||||
<a class="jxr_linenumber" name="L197" href="#L197">197</a> }
|
||||
<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
|
||||
<a class="jxr_linenumber" name="L199" href="#L199">199</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"HTML"</span>.equalsIgnoreCase(format)) {
|
||||
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> (pathToCheck.endsWith(<span class="jxr_string">".html"</span>) || pathToCheck.endsWith(<span class="jxr_string">".htm"</span>)) {
|
||||
<a class="jxr_linenumber" name="L201" href="#L201">201</a> generateReport(<span class="jxr_string">"HtmlReport"</span>, outputDir);
|
||||
<a class="jxr_linenumber" name="L202" href="#L202">202</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L203" href="#L203">203</a> generateReports(outputDir, Format.HTML);
|
||||
<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
|
||||
<a class="jxr_linenumber" name="L205" href="#L205">205</a> }
|
||||
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"VULN"</span>.equalsIgnoreCase(format)) {
|
||||
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (pathToCheck.endsWith(<span class="jxr_string">".html"</span>) || pathToCheck.endsWith(<span class="jxr_string">".htm"</span>)) {
|
||||
<a class="jxr_linenumber" name="L208" href="#L208">208</a> generateReport(<span class="jxr_string">"VulnReport"</span>, outputDir);
|
||||
<a class="jxr_linenumber" name="L209" href="#L209">209</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L210" href="#L210">210</a> generateReports(outputDir, Format.VULN);
|
||||
<a class="jxr_linenumber" name="L211" href="#L211">211</a> }
|
||||
<a class="jxr_linenumber" name="L212" href="#L212">212</a> }
|
||||
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"ALL"</span>.equalsIgnoreCase(format)) {
|
||||
<a class="jxr_linenumber" name="L214" href="#L214">214</a> generateReports(outputDir, Format.ALL);
|
||||
<a class="jxr_linenumber" name="L215" href="#L215">215</a> }
|
||||
<a class="jxr_linenumber" name="L216" href="#L216">216</a> }
|
||||
<a class="jxr_linenumber" name="L217" href="#L217">217</a> }
|
||||
<a class="jxr_linenumber" name="L218" href="#L218">218</a>
|
||||
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Generates a report from a given Velocity Template. The template name provided can be the name of a template</em>
|
||||
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * contained in the jar file, such as 'XmlReport' or 'HtmlReport', or the template name can be the path to a</em>
|
||||
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * template file.</em>
|
||||
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> * @param templateName the name of the template to load.</em>
|
||||
<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em class="jxr_javadoccomment"> * @param outputStream the OutputStream to write the report to.</em>
|
||||
<a class="jxr_linenumber" name="L226" href="#L226">226</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown when the template file does not exist.</em>
|
||||
<a class="jxr_linenumber" name="L227" href="#L227">227</a> <em class="jxr_javadoccomment"> * @throws Exception is thrown when an exception occurs.</em>
|
||||
<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> generateReport(String templateName, OutputStream outputStream) <strong class="jxr_keyword">throws</strong> IOException, Exception {
|
||||
<a class="jxr_linenumber" name="L230" href="#L230">230</a> InputStream input = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L231" href="#L231">231</a> String templatePath = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">final</strong> File f = <strong class="jxr_keyword">new</strong> File(templateName);
|
||||
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong class="jxr_keyword">if</strong> (f.exists() && f.isFile()) {
|
||||
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L235" href="#L235">235</a> templatePath = templateName;
|
||||
<a class="jxr_linenumber" name="L236" href="#L236">236</a> input = <strong class="jxr_keyword">new</strong> FileInputStream(f);
|
||||
<a class="jxr_linenumber" name="L237" href="#L237">237</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException ex) {
|
||||
<a class="jxr_linenumber" name="L238" href="#L238">238</a> LOGGER.error(<span class="jxr_string">"Unable to generate the report, the report template file could not be found."</span>);
|
||||
<a class="jxr_linenumber" name="L239" href="#L239">239</a> LOGGER.debug(<span class="jxr_string">""</span>, ex);
|
||||
<a class="jxr_linenumber" name="L240" href="#L240">240</a> }
|
||||
<a class="jxr_linenumber" name="L241" href="#L241">241</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L242" href="#L242">242</a> templatePath = <span class="jxr_string">"templates/"</span> + templateName + <span class="jxr_string">".vsl"</span>;
|
||||
<a class="jxr_linenumber" name="L243" href="#L243">243</a> input = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(templatePath);
|
||||
<a class="jxr_linenumber" name="L244" href="#L244">244</a> }
|
||||
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">if</strong> (input == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"Template file doesn't exist"</span>);
|
||||
<a class="jxr_linenumber" name="L247" href="#L247">247</a> }
|
||||
<a class="jxr_linenumber" name="L248" href="#L248">248</a>
|
||||
<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">final</strong> InputStreamReader reader = <strong class="jxr_keyword">new</strong> InputStreamReader(input, <span class="jxr_string">"UTF-8"</span>);
|
||||
<a class="jxr_linenumber" name="L250" href="#L250">250</a> OutputStreamWriter writer = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L251" href="#L251">251</a>
|
||||
<a class="jxr_linenumber" name="L252" href="#L252">252</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L253" href="#L253">253</a> writer = <strong class="jxr_keyword">new</strong> OutputStreamWriter(outputStream, <span class="jxr_string">"UTF-8"</span>);
|
||||
<a class="jxr_linenumber" name="L254" href="#L254">254</a>
|
||||
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <strong class="jxr_keyword">if</strong> (!engine.evaluate(context, writer, templatePath, reader)) {
|
||||
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Failed to convert the template into html."</span>);
|
||||
<a class="jxr_linenumber" name="L257" href="#L257">257</a> }
|
||||
<a class="jxr_linenumber" name="L258" href="#L258">258</a> writer.flush();
|
||||
<a class="jxr_linenumber" name="L259" href="#L259">259</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">if</strong> (writer != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L262" href="#L262">262</a> writer.close();
|
||||
<a class="jxr_linenumber" name="L263" href="#L263">263</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L264" href="#L264">264</a> LOGGER.trace(<span class="jxr_string">""</span>, ex);
|
||||
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
|
||||
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
|
||||
<a class="jxr_linenumber" name="L267" href="#L267">267</a> <strong class="jxr_keyword">if</strong> (outputStream != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L269" href="#L269">269</a> outputStream.close();
|
||||
<a class="jxr_linenumber" name="L270" href="#L270">270</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L271" href="#L271">271</a> LOGGER.trace(<span class="jxr_string">""</span>, ex);
|
||||
<a class="jxr_linenumber" name="L272" href="#L272">272</a> }
|
||||
<a class="jxr_linenumber" name="L273" href="#L273">273</a> }
|
||||
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L275" href="#L275">275</a> reader.close();
|
||||
<a class="jxr_linenumber" name="L276" href="#L276">276</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L277" href="#L277">277</a> LOGGER.trace(<span class="jxr_string">""</span>, ex);
|
||||
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
|
||||
<a class="jxr_linenumber" name="L279" href="#L279">279</a> }
|
||||
<a class="jxr_linenumber" name="L280" href="#L280">280</a> }
|
||||
<a class="jxr_linenumber" name="L281" href="#L281">281</a>
|
||||
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> * Generates a report from a given Velocity Template. The template name provided can be the name of a template</em>
|
||||
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * contained in the jar file, such as 'XmlReport' or 'HtmlReport', or the template name can be the path to a</em>
|
||||
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> * template file.</em>
|
||||
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em class="jxr_javadoccomment"> * @param templateName the name of the template to load.</em>
|
||||
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em class="jxr_javadoccomment"> * @param outFileName the filename and path to write the report to.</em>
|
||||
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown when the template file does not exist.</em>
|
||||
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em class="jxr_javadoccomment"> * @throws Exception is thrown when an exception occurs.</em>
|
||||
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> generateReport(String templateName, String outFileName) <strong class="jxr_keyword">throws</strong> Exception {
|
||||
<a class="jxr_linenumber" name="L293" href="#L293">293</a> File outFile = <strong class="jxr_keyword">new</strong> File(outFileName);
|
||||
<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong class="jxr_keyword">if</strong> (outFile.getParentFile() == <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L295" href="#L295">295</a> outFile = <strong class="jxr_keyword">new</strong> File(<span class="jxr_string">"."</span>, outFileName);
|
||||
<a class="jxr_linenumber" name="L296" href="#L296">296</a> }
|
||||
<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">if</strong> (!outFile.getParentFile().exists()) {
|
||||
<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> created = outFile.getParentFile().mkdirs();
|
||||
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong class="jxr_keyword">if</strong> (!created) {
|
||||
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Unable to create directory '"</span> + outFile.getParentFile().getAbsolutePath() + <span class="jxr_string">"'."</span>);
|
||||
<a class="jxr_linenumber" name="L301" href="#L301">301</a> }
|
||||
<a class="jxr_linenumber" name="L302" href="#L302">302</a> }
|
||||
<a class="jxr_linenumber" name="L303" href="#L303">303</a>
|
||||
<a class="jxr_linenumber" name="L304" href="#L304">304</a> OutputStream outputSteam = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L305" href="#L305">305</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L306" href="#L306">306</a> outputSteam = <strong class="jxr_keyword">new</strong> FileOutputStream(outFile);
|
||||
<a class="jxr_linenumber" name="L307" href="#L307">307</a> generateReport(templateName, outputSteam);
|
||||
<a class="jxr_linenumber" name="L308" href="#L308">308</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <strong class="jxr_keyword">if</strong> (outputSteam != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L311" href="#L311">311</a> outputSteam.close();
|
||||
<a class="jxr_linenumber" name="L312" href="#L312">312</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L313" href="#L313">313</a> LOGGER.trace(<span class="jxr_string">"ignore"</span>, ex);
|
||||
<a class="jxr_linenumber" name="L314" href="#L314">314</a> }
|
||||
<a class="jxr_linenumber" name="L315" href="#L315">315</a> }
|
||||
<a class="jxr_linenumber" name="L316" href="#L316">316</a> }
|
||||
<a class="jxr_linenumber" name="L317" href="#L317">317</a> }
|
||||
<a class="jxr_linenumber" name="L318" href="#L318">318</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,138 @@
|
||||
<!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>VelocityLoggerRedirect xref</title>
|
||||
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
|
||||
</head>
|
||||
<body>
|
||||
<div id="overview"><a href="../../../../../apidocs/org/owasp/dependencycheck/reporting/VelocityLoggerRedirect.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"> * This file is part of dependency-check-core.</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> <em class="jxr_comment"> * Copyright (c) 2013 Steve Springett. All Rights Reserved.</em>
|
||||
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
|
||||
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.reporting;
|
||||
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
|
||||
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeServices;
|
||||
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.LogChute;
|
||||
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
|
||||
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
|
||||
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
|
||||
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <p></em>
|
||||
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * DependencyCheck uses {@link org.slf4j.Logger} as a logging framework, and Apache Velocity uses a custom</em>
|
||||
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * logging implementation that outputs to a file named velocity.log by default. This class is an implementation of a</em>
|
||||
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * custom Velocity logger that redirects all velocity logging to the Java Logger class.</em>
|
||||
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * </p><p></em>
|
||||
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * This class was written to address permission issues when using Dependency-Check in a server environment (such as the</em>
|
||||
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * Jenkins plugin). In some circumstances, Velocity would attempt to create velocity.log in an un-writable</em>
|
||||
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * directory.</p></em>
|
||||
<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"> * @author Steve Springett <steve.springett@owasp.org></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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/reporting/VelocityLoggerRedirect.html">VelocityLoggerRedirect</a> <strong class="jxr_keyword">implements</strong> LogChute {
|
||||
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
|
||||
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * The Logger.</em>
|
||||
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<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> Logger LOGGER = LoggerFactory.getLogger(VelocityLoggerRedirect.<strong class="jxr_keyword">class</strong>);
|
||||
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
|
||||
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * This will be invoked once by the LogManager.</em>
|
||||
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param rsvc the RuntimeServices</em>
|
||||
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L49" href="#L49">49</a> @Override
|
||||
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(RuntimeServices rsvc) {
|
||||
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_comment">// do nothing</em>
|
||||
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
|
||||
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
|
||||
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Given a Velocity log level and message, this method will call the appropriate Logger level and log the specified</em>
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * values.</em>
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @param level the logging level</em>
|
||||
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param message the message to be logged</em>
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Override
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> log(<strong class="jxr_keyword">int</strong> level, String message) {
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">switch</strong> (level) {
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">case</strong> TRACE_ID:
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> LOGGER.trace(message);
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">case</strong> DEBUG_ID:
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> LOGGER.debug(message);
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">case</strong> INFO_ID:
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> LOGGER.info(message);
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">case</strong> WARN_ID:
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> LOGGER.warn(message);
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">case</strong> ERROR_ID:
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> LOGGER.error(message);
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">default</strong>:
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> LOGGER.info(message);
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> }
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a>
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> * Given a Velocity log level, message and Throwable, this method will call the appropriate Logger level and log the</em>
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * specified values.</em>
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param level the logging level</em>
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @param message the message to be logged</em>
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param t a throwable to log</em>
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> @Override
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> log(<strong class="jxr_keyword">int</strong> level, String message, Throwable t) {
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">switch</strong> (level) {
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">case</strong> TRACE_ID:
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> LOGGER.trace(message, t);
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">case</strong> DEBUG_ID:
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> LOGGER.debug(message, t);
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">case</strong> INFO_ID:
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> LOGGER.info(message, t);
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">case</strong> WARN_ID:
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> LOGGER.warn(message, t);
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">case</strong> ERROR_ID:
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a> LOGGER.error(message, t);
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">break</strong>;
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">default</strong>:
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> LOGGER.info(message, t);
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a>
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> * Will always return true. The property file will decide what level to log.</em>
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * @param level the logging level</em>
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @return true</em>
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> @Override
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isLevelEnabled(<strong class="jxr_keyword">int</strong> level) {
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> }
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
</body>
|
||||
</html>
|
||||
33
xref/org/owasp/dependencycheck/reporting/package-frame.html
Normal file
33
xref/org/owasp/dependencycheck/reporting/package-frame.html
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
||||
<title>Dependency-Check 1.3.1 Reference Package org.owasp.dependencycheck.reporting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<h3>
|
||||
<a href="package-summary.html" target="classFrame">org.owasp.dependencycheck.reporting</a>
|
||||
</h3>
|
||||
|
||||
<h3>Classes</h3>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="EscapeTool.html" target="classFrame">EscapeTool</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="ReportGenerator.html" target="classFrame">Format</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="ReportGenerator.html" target="classFrame">ReportGenerator</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="VelocityLoggerRedirect.html" target="classFrame">VelocityLoggerRedirect</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,84 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
||||
<title>Dependency-Check 1.3.1 Reference Package org.owasp.dependencycheck.reporting</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="overview">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="../../../../overview-summary.html">Overview</a>
|
||||
</li>
|
||||
<li class="selected">Package</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="framenoframe">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="../../../../index.html" target="_top">FRAMES</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="package-summary.html" target="_top">NO FRAMES</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<h2>Package org.owasp.dependencycheck.reporting</h2>
|
||||
|
||||
<table class="summary">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Class Summary</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="EscapeTool.html" target="classFrame">EscapeTool</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="ReportGenerator.html" target="classFrame">Format</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="ReportGenerator.html" target="classFrame">ReportGenerator</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="VelocityLoggerRedirect.html" target="classFrame">VelocityLoggerRedirect</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<div class="overview">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="../../../../overview-summary.html">Overview</a>
|
||||
</li>
|
||||
<li class="selected">Package</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="framenoframe">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="../../../../index.html" target="_top">FRAMES</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="package-summary.html" target="_top">NO FRAMES</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<hr />
|
||||
<div id="footer">
|
||||
Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user