mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-20 00:04:27 +01:00
documentation v1.3.2
This commit is contained in:
Jeremy Long
File diff suppressed because it is too large
Load Diff
@@ -366,79 +366,83 @@
|
||||
<a class="jxr_linenumber" name="L358" href="#L358">358</a> }
|
||||
<a class="jxr_linenumber" name="L359" href="#L359">359</a>
|
||||
<a class="jxr_linenumber" name="L360" href="#L360">360</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the</em>
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> * local database.</em>
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a> <em class="jxr_javadoccomment"> * @throws BuildException thrown if a connection to the local database cannot be made.</em>
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a> @Override
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</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="L368" href="#L368">368</a> populateSettings();
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> Engine engine = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> engine = <strong class="jxr_keyword">new</strong> Engine(Update.<strong class="jxr_keyword">class</strong>.getClassLoader());
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> engine.doUpdates();
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(<span class="jxr_string">"Unable to connect to the dependency-check database; unable to update the NVD data"</span>, ex);
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a> Settings.cleanup(<strong class="jxr_keyword">true</strong>);
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a> engine.cleanup();
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> }
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> }
|
||||
<a class="jxr_linenumber" name="L361" href="#L361">361</a> <em class="jxr_javadoccomment"> * The number of hours to wait before re-checking for updates.</em>
|
||||
<a class="jxr_linenumber" name="L362" href="#L362">362</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L363" href="#L363">363</a> <strong class="jxr_keyword">private</strong> Integer cveValidForHours;
|
||||
<a class="jxr_linenumber" name="L364" href="#L364">364</a>
|
||||
<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em class="jxr_javadoccomment"> * Get the value of cveValidForHours.</em>
|
||||
<a class="jxr_linenumber" name="L367" href="#L367">367</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L368" href="#L368">368</a> <em class="jxr_javadoccomment"> * @return the value of cveValidForHours</em>
|
||||
<a class="jxr_linenumber" name="L369" href="#L369">369</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L370" href="#L370">370</a> <strong class="jxr_keyword">public</strong> Integer getCveValidForHours() {
|
||||
<a class="jxr_linenumber" name="L371" href="#L371">371</a> <strong class="jxr_keyword">return</strong> cveValidForHours;
|
||||
<a class="jxr_linenumber" name="L372" href="#L372">372</a> }
|
||||
<a class="jxr_linenumber" name="L373" href="#L373">373</a>
|
||||
<a class="jxr_linenumber" name="L374" href="#L374">374</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L375" href="#L375">375</a> <em class="jxr_javadoccomment"> * Set the value of cveValidForHours.</em>
|
||||
<a class="jxr_linenumber" name="L376" href="#L376">376</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L377" href="#L377">377</a> <em class="jxr_javadoccomment"> * @param cveValidForHours new value of cveValidForHours</em>
|
||||
<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L379" href="#L379">379</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCveValidForHours(Integer cveValidForHours) {
|
||||
<a class="jxr_linenumber" name="L380" href="#L380">380</a> <strong class="jxr_keyword">this</strong>.cveValidForHours = cveValidForHours;
|
||||
<a class="jxr_linenumber" name="L381" href="#L381">381</a> }
|
||||
<a class="jxr_linenumber" name="L382" href="#L382">382</a>
|
||||
<a class="jxr_linenumber" name="L383" href="#L383">383</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</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="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * required to change the proxy server, port, and connection timeout.</em>
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a> @Override
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> populateSettings() {
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a> <strong class="jxr_keyword">super</strong>.populateSettings();
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</a> <strong class="jxr_keyword">if</strong> (proxyServer != <strong class="jxr_keyword">null</strong> && !proxyServer.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L391" href="#L391">391</a> Settings.setString(Settings.KEYS.PROXY_SERVER, proxyServer);
|
||||
<a class="jxr_linenumber" name="L392" href="#L392">392</a> }
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">if</strong> (proxyPort != <strong class="jxr_keyword">null</strong> && !proxyPort.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> Settings.setString(Settings.KEYS.PROXY_PORT, proxyPort);
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> }
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong class="jxr_keyword">if</strong> (proxyUsername != <strong class="jxr_keyword">null</strong> && !proxyUsername.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> Settings.setString(Settings.KEYS.PROXY_USERNAME, proxyUsername);
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> }
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong class="jxr_keyword">if</strong> (proxyPassword != <strong class="jxr_keyword">null</strong> && !proxyPassword.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> Settings.setString(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> }
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> <strong class="jxr_keyword">if</strong> (connectionTimeout != <strong class="jxr_keyword">null</strong> && !connectionTimeout.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> Settings.setString(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> }
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong class="jxr_keyword">if</strong> (databaseDriverName != <strong class="jxr_keyword">null</strong> && !databaseDriverName.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> Settings.setString(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
|
||||
<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong class="jxr_keyword">if</strong> (databaseDriverPath != <strong class="jxr_keyword">null</strong> && !databaseDriverPath.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> Settings.setString(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> }
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong class="jxr_keyword">if</strong> (connectionString != <strong class="jxr_keyword">null</strong> && !connectionString.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> Settings.setString(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</a> }
|
||||
<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong class="jxr_keyword">if</strong> (databaseUser != <strong class="jxr_keyword">null</strong> && !databaseUser.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> Settings.setString(Settings.KEYS.DB_USER, databaseUser);
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> }
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a> <strong class="jxr_keyword">if</strong> (databasePassword != <strong class="jxr_keyword">null</strong> && !databasePassword.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a> Settings.setString(Settings.KEYS.DB_PASSWORD, databasePassword);
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> }
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> <strong class="jxr_keyword">if</strong> (cveUrl12Modified != <strong class="jxr_keyword">null</strong> && !cveUrl12Modified.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a> Settings.setString(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> <strong class="jxr_keyword">if</strong> (cveUrl20Modified != <strong class="jxr_keyword">null</strong> && !cveUrl20Modified.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> Settings.setString(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <strong class="jxr_keyword">if</strong> (cveUrl12Base != <strong class="jxr_keyword">null</strong> && !cveUrl12Base.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a> Settings.setString(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> }
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">if</strong> (cveUrl20Base != <strong class="jxr_keyword">null</strong> && !cveUrl20Base.isEmpty()) {
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a> Settings.setString(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> }
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> }
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> }
|
||||
<a class="jxr_linenumber" name="L384" href="#L384">384</a> <em class="jxr_javadoccomment"> * Executes the update by initializing the settings, downloads the NVD XML data, and then processes the data storing it in the</em>
|
||||
<a class="jxr_linenumber" name="L385" href="#L385">385</a> <em class="jxr_javadoccomment"> * local database.</em>
|
||||
<a class="jxr_linenumber" name="L386" href="#L386">386</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L387" href="#L387">387</a> <em class="jxr_javadoccomment"> * @throws BuildException thrown if a connection to the local database cannot be made.</em>
|
||||
<a class="jxr_linenumber" name="L388" href="#L388">388</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L389" href="#L389">389</a> @Override
|
||||
<a class="jxr_linenumber" name="L390" href="#L390">390</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="L391" href="#L391">391</a> populateSettings();
|
||||
<a class="jxr_linenumber" name="L392" href="#L392">392</a> Engine engine = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L393" href="#L393">393</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L394" href="#L394">394</a> engine = <strong class="jxr_keyword">new</strong> Engine(Update.<strong class="jxr_keyword">class</strong>.getClassLoader());
|
||||
<a class="jxr_linenumber" name="L395" href="#L395">395</a> engine.doUpdates();
|
||||
<a class="jxr_linenumber" name="L396" href="#L396">396</a> } <strong class="jxr_keyword">catch</strong> (DatabaseException ex) {
|
||||
<a class="jxr_linenumber" name="L397" href="#L397">397</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(<span class="jxr_string">"Unable to connect to the dependency-check database; unable to update the NVD data"</span>, ex);
|
||||
<a class="jxr_linenumber" name="L398" href="#L398">398</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L399" href="#L399">399</a> Settings.cleanup(<strong class="jxr_keyword">true</strong>);
|
||||
<a class="jxr_linenumber" name="L400" href="#L400">400</a> <strong class="jxr_keyword">if</strong> (engine != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L401" href="#L401">401</a> engine.cleanup();
|
||||
<a class="jxr_linenumber" name="L402" href="#L402">402</a> }
|
||||
<a class="jxr_linenumber" name="L403" href="#L403">403</a> }
|
||||
<a class="jxr_linenumber" name="L404" href="#L404">404</a> }
|
||||
<a class="jxr_linenumber" name="L405" href="#L405">405</a>
|
||||
<a class="jxr_linenumber" name="L406" href="#L406">406</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L407" href="#L407">407</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="L408" href="#L408">408</a> <em class="jxr_javadoccomment"> * required to change the proxy server, port, and connection timeout.</em>
|
||||
<a class="jxr_linenumber" name="L409" href="#L409">409</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L410" href="#L410">410</a> <em class="jxr_javadoccomment"> * @throws BuildException thrown when an invalid setting is configured.</em>
|
||||
<a class="jxr_linenumber" name="L411" href="#L411">411</a> <em class="jxr_javadoccomment"> */</em>
|
||||
<a class="jxr_linenumber" name="L412" href="#L412">412</a> @Override
|
||||
<a class="jxr_linenumber" name="L413" href="#L413">413</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="L414" href="#L414">414</a> <strong class="jxr_keyword">super</strong>.populateSettings();
|
||||
<a class="jxr_linenumber" name="L415" href="#L415">415</a> Settings.setStringIfNotEmpty(Settings.KEYS.PROXY_SERVER, proxyServer);
|
||||
<a class="jxr_linenumber" name="L416" href="#L416">416</a> Settings.setStringIfNotEmpty(Settings.KEYS.PROXY_PORT, proxyPort);
|
||||
<a class="jxr_linenumber" name="L417" href="#L417">417</a> Settings.setStringIfNotEmpty(Settings.KEYS.PROXY_USERNAME, proxyUsername);
|
||||
<a class="jxr_linenumber" name="L418" href="#L418">418</a> Settings.setStringIfNotEmpty(Settings.KEYS.PROXY_PASSWORD, proxyPassword);
|
||||
<a class="jxr_linenumber" name="L419" href="#L419">419</a> Settings.setStringIfNotEmpty(Settings.KEYS.CONNECTION_TIMEOUT, connectionTimeout);
|
||||
<a class="jxr_linenumber" name="L420" href="#L420">420</a> Settings.setStringIfNotEmpty(Settings.KEYS.DB_DRIVER_NAME, databaseDriverName);
|
||||
<a class="jxr_linenumber" name="L421" href="#L421">421</a> Settings.setStringIfNotEmpty(Settings.KEYS.DB_DRIVER_PATH, databaseDriverPath);
|
||||
<a class="jxr_linenumber" name="L422" href="#L422">422</a> Settings.setStringIfNotEmpty(Settings.KEYS.DB_CONNECTION_STRING, connectionString);
|
||||
<a class="jxr_linenumber" name="L423" href="#L423">423</a> Settings.setStringIfNotEmpty(Settings.KEYS.DB_USER, databaseUser);
|
||||
<a class="jxr_linenumber" name="L424" href="#L424">424</a> Settings.setStringIfNotEmpty(Settings.KEYS.DB_PASSWORD, databasePassword);
|
||||
<a class="jxr_linenumber" name="L425" href="#L425">425</a> Settings.setStringIfNotEmpty(Settings.KEYS.CVE_MODIFIED_12_URL, cveUrl12Modified);
|
||||
<a class="jxr_linenumber" name="L426" href="#L426">426</a> Settings.setStringIfNotEmpty(Settings.KEYS.CVE_MODIFIED_20_URL, cveUrl20Modified);
|
||||
<a class="jxr_linenumber" name="L427" href="#L427">427</a> Settings.setStringIfNotEmpty(Settings.KEYS.CVE_SCHEMA_1_2, cveUrl12Base);
|
||||
<a class="jxr_linenumber" name="L428" href="#L428">428</a> Settings.setStringIfNotEmpty(Settings.KEYS.CVE_SCHEMA_2_0, cveUrl20Base);
|
||||
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong class="jxr_keyword">if</strong> (cveValidForHours != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <strong class="jxr_keyword">if</strong> (cveValidForHours >= 0) {
|
||||
<a class="jxr_linenumber" name="L431" href="#L431">431</a> Settings.setInt(Settings.KEYS.CVE_CHECK_VALID_FOR_HOURS, cveValidForHours);
|
||||
<a class="jxr_linenumber" name="L432" href="#L432">432</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L433" href="#L433">433</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> BuildException(<span class="jxr_string">"Invalid setting: `cpeValidForHours` must be 0 or greater"</span>);
|
||||
<a class="jxr_linenumber" name="L434" href="#L434">434</a> }
|
||||
<a class="jxr_linenumber" name="L435" href="#L435">435</a> }
|
||||
<a class="jxr_linenumber" name="L436" href="#L436">436</a> }
|
||||
<a class="jxr_linenumber" name="L437" href="#L437">437</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<html xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
||||
<title>Dependency-Check Ant Task 1.3.1 Reference Package org.owasp.dependencycheck.taskdefs</title>
|
||||
<title>Dependency-Check Ant Task 1.3.2 Reference Package org.owasp.dependencycheck.taskdefs</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
<html xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
||||
<title>Dependency-Check Ant Task 1.3.1 Reference Package org.owasp.dependencycheck.taskdefs</title>
|
||||
<title>Dependency-Check Ant Task 1.3.2 Reference Package org.owasp.dependencycheck.taskdefs</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
Reference in New Issue
Block a user