github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-04-27 10:47:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation version 1.4.5

Browse Source
This commit is contained in:
Jeremy Long
2017-01-22 17:22:46 -05:00
parent a1b5e3f7b0
commit 615f6e3750
1583 changed files with 55974 additions and 52631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

179
dependency-check-maven/xref/org/owasp/dependencycheck/maven/PurgeMojo.html
View File

@@ -45,96 +45,97 @@
<a class="jxr_linenumber" name="L37" href="#L37">37</a> defaultPhase = LifecyclePhase.GENERATE_RESOURCES,
<a class="jxr_linenumber" name="L38" href="#L38">38</a> threadSafe = false,
<a class="jxr_linenumber" name="L39" href="#L39">39</a> requiresDependencyResolution = ResolutionScope.NONE,
<a class="jxr_linenumber" name="L40" href="#L40">40</a> requiresOnline = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> )
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/PurgeMojo.html">PurgeMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<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"> * Returns false; this mojo cannot generate a report.</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"> * @return &lt;code&gt;false&lt;/code&gt;</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">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">return</strong> false;
<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"> * Purges the local copy of the NVD.</em>
<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"> * @throws MojoExecutionException thrown if there is an exception executing</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * the goal</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * fail the build</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Override
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L64" href="#L64">64</a>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">if</strong> (getConnectionString() != <strong class="jxr_keyword">null</strong> &amp;&amp; !getConnectionString().isEmpty()) {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to purge the local NVD when using a non-default connection string"</span>;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a> getLog().error(msg);
<a class="jxr_linenumber" name="L71" href="#L71">71</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> populateSettings();
<a class="jxr_linenumber" name="L73" href="#L73">73</a> File db;
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L75" href="#L75">75</a> db = <strong class="jxr_keyword">new</strong> File(Settings.getDataDirectory(), <span class="jxr_string">"dc.h2.db"</span>);
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">if</strong> (db.exists()) {
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (db.delete()) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> getLog().info(<span class="jxr_string">"Database file purged; local copy of the NVD has been removed"</span>);
<a class="jxr_linenumber" name="L79" href="#L79">79</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to delete '%s'; please delete the file manually"</span>, db.getAbsolutePath());
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a> getLog().error(msg);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to purge database; the database file does not exists: %s"</span>, db.getAbsolutePath());
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a> getLog().error(msg);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to delete the database"</span>;
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, ex);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> }
<a class="jxr_linenumber" name="L98" href="#L98">98</a> getLog().error(msg);
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> Settings.cleanup();
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> @Override
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-purge"</span>;
<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"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @return the description</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> @Override
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Purges the local cache of the NVD dataT."</span>;
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
<a class="jxr_linenumber" name="L126" href="#L126">126</a>
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L40" href="#L40">40</a> requiresOnline = <strong class="jxr_keyword">true</strong>,
<a class="jxr_linenumber" name="L41" href="#L41">41</a> aggregator = <strong class="jxr_keyword">true</strong>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> )
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/maven/PurgeMojo.html">PurgeMojo</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/owasp/dependencycheck/maven/BaseDependencyCheckMojo.html">BaseDependencyCheckMojo</a> {
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Returns false; this mojo cannot generate a 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"> * @return &lt;code&gt;false&lt;/code&gt;</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> @Override
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> canGenerateReport() {
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> }
<a class="jxr_linenumber" name="L54" href="#L54">54</a>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Purges the local copy of the NVD.</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"> * @throws MojoExecutionException thrown if there is an exception executing</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * the goal</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @throws MojoFailureException thrown if dependency-check is configured to</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * fail the build</em>
<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> @Override
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> runCheck() <strong class="jxr_keyword">throws</strong> MojoExecutionException, MojoFailureException {
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (getConnectionString() != <strong class="jxr_keyword">null</strong> &amp;&amp; !getConnectionString().isEmpty()) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to purge the local NVD when using a non-default connection string"</span>;
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a> getLog().error(msg);
<a class="jxr_linenumber" name="L72" href="#L72">72</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L73" href="#L73">73</a> populateSettings();
<a class="jxr_linenumber" name="L74" href="#L74">74</a> File db;
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> db = <strong class="jxr_keyword">new</strong> File(Settings.getDataDirectory(), <span class="jxr_string">"dc.h2.db"</span>);
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (db.exists()) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (db.delete()) {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> getLog().info(<span class="jxr_string">"Database file purged; local copy of the NVD has been removed"</span>);
<a class="jxr_linenumber" name="L80" href="#L80">80</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to delete '%s'; please delete the file manually"</span>, db.getAbsolutePath());
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> getLog().error(msg);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">final</strong> String msg = String.format(<span class="jxr_string">"Unable to purge database; the database file does not exists: %s"</span>, db.getAbsolutePath());
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoFailureException(msg);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a> getLog().error(msg);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to delete the database"</span>;
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isFailOnError()) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException(msg, ex);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> getLog().error(msg);
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> Settings.cleanup();
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Returns the report name.</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param locale the location</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @return the report name</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> @Override
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">public</strong> String getName(Locale locale) {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"dependency-check-purge"</span>;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a>
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * Gets the description of the Dependency-Check report to be displayed in</em>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * the Maven Generated Reports page.</em>
<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"> * @param locale The Locale to get the description for</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @return the description</em>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L123" href="#L123">123</a> @Override
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> String getDescription(Locale locale) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Purges the local cache of the NVD dataT."</span>;
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a>
<a class="jxr_linenumber" name="L128" href="#L128">128</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2013&#x2013;2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
<div id="footer">Copyright &#169; 2013&#x2013;2017 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
</body>
</html>