mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-30 05:42:10 +02:00
documentation version 1.4.2
This commit is contained in:
Jeremy Long
@@ -79,60 +79,103 @@
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">this</strong>.dataDirectory = dataDirectory;
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> @Override
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> BuildException {
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> populateSettings();
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> File db;
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> db = <strong class="jxr_keyword">new</strong> File(Settings.getDataDirectory(), <span class="jxr_string">"dc.h2.db"</span>);
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">if</strong> (db.exists()) {
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (db.delete()) {
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> log(<span class="jxr_string">"Database file purged; local copy of the NVD has been removed"</span>, Project.MSG_INFO);
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> log(String.format(<span class="jxr_string">"Unable to delete '%s'; please delete the file manually"</span>, db.getAbsolutePath()), Project.MSG_ERR);
|
||||
<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> log(String.format(<span class="jxr_string">"Unable to purge database; the database file does not exists: %s"</span>, db.getAbsolutePath()), Project.MSG_ERR);
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> log(<span class="jxr_string">"Unable to delete the database"</span>, Project.MSG_ERR);
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</a> Settings.cleanup(<strong class="jxr_keyword">true</strong>);
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Takes the properties supplied and updates the dependency-check settings. Additionally, this sets the system properties</em>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * required to change the proxy server, port, and connection timeout.</em>
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> populateSettings() {
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> Settings.initialize();
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> InputStream taskProperties = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> taskProperties = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> Settings.mergeProperties(taskProperties);
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> log(<span class="jxr_string">"Unable to load the dependency-check ant task.properties file."</span>, ex, Project.MSG_WARN);
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (taskProperties != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> taskProperties.close();
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> log(<span class="jxr_string">""</span>, ex, Project.MSG_DEBUG);
|
||||
<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> }
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">if</strong> (dataDirectory != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">final</strong> File jarPath = <strong class="jxr_keyword">new</strong> File(Purge.<strong class="jxr_keyword">class</strong>.getProtectionDomain().getCodeSource().getLocation().getPath());
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">final</strong> File base = jarPath.getParentFile();
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">final</strong> String sub = Settings.getString(Settings.KEYS.DATA_DIRECTORY);
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">final</strong> File dataDir = <strong class="jxr_keyword">new</strong> File(base, sub);
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDir.getAbsolutePath());
|
||||
<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="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Indicates if dependency-check should fail the build if an exception</em>
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * occurs.</em>
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnError = <strong class="jxr_keyword">true</strong>;
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Get the value of failOnError.</em>
|
||||
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @return the value of failOnError</em>
|
||||
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isFailOnError() {
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">return</strong> failOnError;
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> }
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a>
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * Set the value of failOnError.</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> <em class="jxr_javadoccomment"> * @param failOnError new value of failOnError</em>
|
||||
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFailOnError(<strong class="jxr_keyword">boolean</strong> failOnError) {
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">this</strong>.failOnError = failOnError;
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</a> @Override
|
||||
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() <strong class="jxr_keyword">throws</strong> BuildException {
|
||||
<a class="jxr_linenumber" name="L100" href="#L100">100</a> populateSettings();
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> File db;
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> db = <strong class="jxr_keyword">new</strong> File(Settings.getDataDirectory(), <span class="jxr_string">"dc.h2.db"</span>);
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">if</strong> (db.exists()) {
|
||||
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">if</strong> (db.delete()) {
|
||||
<a class="jxr_linenumber" name="L106" href="#L106">106</a> log(<span class="jxr_string">"Database file purged; local copy of the NVD has been removed"</span>, Project.MSG_INFO);
|
||||
<a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</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="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.failOnError) {
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(msg);
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> log(msg, Project.MSG_ERR);
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
|
||||
<a class="jxr_linenumber" name="L114" href="#L114">114</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</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="L116" href="#L116">116</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.failOnError) {
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(msg);
|
||||
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> log(msg, Project.MSG_ERR);
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to delete the database"</span>;
|
||||
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.failOnError) {
|
||||
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(msg);
|
||||
<a class="jxr_linenumber" name="L125" href="#L125">125</a> }
|
||||
<a class="jxr_linenumber" name="L126" href="#L126">126</a> log(msg, Project.MSG_ERR);
|
||||
<a class="jxr_linenumber" name="L127" href="#L127">127</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L128" href="#L128">128</a> Settings.cleanup(<strong class="jxr_keyword">true</strong>);
|
||||
<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>
|
||||
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * Takes the properties supplied and updates the dependency-check settings.</em>
|
||||
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * Additionally, this sets the system properties required to change the</em>
|
||||
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * proxy server, port, and connection timeout.</em>
|
||||
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * @throws BuildException thrown if the properties file cannot be read.</em>
|
||||
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> populateSettings() <strong class="jxr_keyword">throws</strong> BuildException {
|
||||
<a class="jxr_linenumber" name="L140" href="#L140">140</a> Settings.initialize();
|
||||
<a class="jxr_linenumber" name="L141" href="#L141">141</a> InputStream taskProperties = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L143" href="#L143">143</a> taskProperties = <strong class="jxr_keyword">this</strong>.getClass().getClassLoader().getResourceAsStream(PROPERTIES_FILE);
|
||||
<a class="jxr_linenumber" name="L144" href="#L144">144</a> Settings.mergeProperties(taskProperties);
|
||||
<a class="jxr_linenumber" name="L145" href="#L145">145</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">final</strong> String msg = <span class="jxr_string">"Unable to load the dependency-check ant task.properties file."</span>;
|
||||
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.failOnError) {
|
||||
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(msg, ex);
|
||||
<a class="jxr_linenumber" name="L149" href="#L149">149</a> }
|
||||
<a class="jxr_linenumber" name="L150" href="#L150">150</a> log(msg, ex, Project.MSG_WARN);
|
||||
<a class="jxr_linenumber" name="L151" href="#L151">151</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">if</strong> (taskProperties != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L154" href="#L154">154</a> taskProperties.close();
|
||||
<a class="jxr_linenumber" name="L155" href="#L155">155</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L156" href="#L156">156</a> log(<span class="jxr_string">""</span>, ex, Project.MSG_DEBUG);
|
||||
<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> <strong class="jxr_keyword">if</strong> (dataDirectory != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L161" href="#L161">161</a> Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDirectory);
|
||||
<a class="jxr_linenumber" name="L162" href="#L162">162</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">final</strong> File jarPath = <strong class="jxr_keyword">new</strong> File(Purge.<strong class="jxr_keyword">class</strong>.getProtectionDomain().getCodeSource().getLocation().getPath());
|
||||
<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">final</strong> File base = jarPath.getParentFile();
|
||||
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">final</strong> String sub = Settings.getString(Settings.KEYS.DATA_DIRECTORY);
|
||||
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">final</strong> File dataDir = <strong class="jxr_keyword">new</strong> File(base, sub);
|
||||
<a class="jxr_linenumber" name="L167" href="#L167">167</a> Settings.setString(Settings.KEYS.DATA_DIRECTORY, dataDir.getAbsolutePath());
|
||||
<a class="jxr_linenumber" name="L168" href="#L168">168</a> }
|
||||
<a class="jxr_linenumber" name="L169" href="#L169">169</a> }
|
||||
<a class="jxr_linenumber" name="L170" href="#L170">170</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2016 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
|
||||
Reference in New Issue
Block a user