documentation version 1.2.10

This commit is contained in:
Jeremy Long
2015-04-13 17:43:19 -04:00
parent 480a05c798
commit 9194a42c93
1126 changed files with 34228 additions and 29019 deletions

View File

@@ -42,7 +42,7 @@
<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"> * A simple settings container that wraps the dependencycheck.properties file.</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> <em class="jxr_javadoccomment"> * @author Jeremy Long &lt;jeremy.long@owasp.org&gt;</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a> {
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
@@ -111,13 +111,13 @@
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE_META_URL = <span class="jxr_string">"cve.url.meta"</span>;
<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"> * The properties key for the URL to retrieve the recently modified and added CVE entries (last 8 days) using</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * the 2.0 schema.</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * The properties key for the URL to retrieve the recently modified and added CVE entries (last 8 days) using the 2.0</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * schema.</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE_MODIFIED_20_URL = <span class="jxr_string">"cve.url-2.0.modified"</span>;
<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> <em class="jxr_javadoccomment"> * The properties key for the URL to retrieve the recently modified and added CVE entries (last 8 days) using</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * the 1.2 schema.</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * The properties key for the URL to retrieve the recently modified and added CVE entries (last 8 days) using the 1.2</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * schema.</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE_MODIFIED_12_URL = <span class="jxr_string">"cve.url-1.2.modified"</span>;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment">/**</em>
@@ -125,8 +125,8 @@
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE_MODIFIED_VALID_FOR_DAYS = <span class="jxr_string">"cve.url.modified.validfordays"</span>;
<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"> * The properties key for the telling us how many cve.url.* URLs exists. This is used in combination with</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * CVE_BASE_URL to be able to retrieve the URLs for all of the files that make up the NVD CVE listing.</em>
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * The properties key for the telling us how many cve.url.* URLs exists. This is used in combination with CVE_BASE_URL to</em>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * be able to retrieve the URLs for all of the files that make up the NVD CVE listing.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CVE_START_YEAR = <span class="jxr_string">"cve.startyear"</span>;
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment">/**</em>
@@ -305,16 +305,16 @@
<a class="jxr_linenumber" name="L297" href="#L297">297</a> }
<a class="jxr_linenumber" name="L298" href="#L298">298</a>
<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * Initializes the thread local settings object. Note, to use the settings object you must call this method.</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * However, you must also call Settings.cleanup() to properly release resources.</em>
<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em class="jxr_javadoccomment"> * Initializes the thread local settings object. Note, to use the settings object you must call this method. However, you must</em>
<a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment"> * also call Settings.cleanup() to properly release resources.</em>
<a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> initialize() {
<a class="jxr_linenumber" name="L304" href="#L304">304</a> localSettings.set(<strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/Settings.html">Settings</a>(PROPERTIES_FILE));
<a class="jxr_linenumber" name="L305" href="#L305">305</a> }
<a class="jxr_linenumber" name="L306" href="#L306">306</a>
<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * Initializes the thread local settings object. Note, to use the settings object you must call this method.</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * However, you must also call Settings.cleanup() to properly release resources.</em>
<a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * Initializes the thread local settings object. Note, to use the settings object you must call this method. However, you must</em>
<a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> * also call Settings.cleanup() to properly release resources.</em>
<a class="jxr_linenumber" name="L310" href="#L310">310</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L311" href="#L311">311</a> <em class="jxr_javadoccomment"> * @param propertiesFilePath the path to the base properties file to load</em>
<a class="jxr_linenumber" name="L312" href="#L312">312</a> <em class="jxr_javadoccomment"> */</em>
@@ -431,8 +431,8 @@
<a class="jxr_linenumber" name="L423" href="#L423">423</a> }
<a class="jxr_linenumber" name="L424" href="#L424">424</a>
<a class="jxr_linenumber" name="L425" href="#L425">425</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided</em>
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * properties file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L426" href="#L426">426</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided properties</em>
<a class="jxr_linenumber" name="L427" href="#L427">427</a> <em class="jxr_javadoccomment"> * file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L428" href="#L428">428</a> <em class="jxr_javadoccomment"> * Note: even if using this method - system properties will be loaded before properties loaded from files.</em>
<a class="jxr_linenumber" name="L429" href="#L429">429</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L430" href="#L430">430</a> <em class="jxr_javadoccomment"> * @param filePath the path to the properties file to merge.</em>
@@ -456,8 +456,8 @@
<a class="jxr_linenumber" name="L448" href="#L448">448</a> }
<a class="jxr_linenumber" name="L449" href="#L449">449</a>
<a class="jxr_linenumber" name="L450" href="#L450">450</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided</em>
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * properties file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L451" href="#L451">451</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided properties</em>
<a class="jxr_linenumber" name="L452" href="#L452">452</a> <em class="jxr_javadoccomment"> * file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L453" href="#L453">453</a> <em class="jxr_javadoccomment"> * Note: even if using this method - system properties will be loaded before properties loaded from files.</em>
<a class="jxr_linenumber" name="L454" href="#L454">454</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L455" href="#L455">455</a> <em class="jxr_javadoccomment"> * @param filePath the path to the properties file to merge.</em>
@@ -481,8 +481,8 @@
<a class="jxr_linenumber" name="L473" href="#L473">473</a> }
<a class="jxr_linenumber" name="L474" href="#L474">474</a>
<a class="jxr_linenumber" name="L475" href="#L475">475</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided</em>
<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * properties file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L476" href="#L476">476</a> <em class="jxr_javadoccomment"> * Merges a new properties file into the current properties. This method allows for the loading of a user provided properties</em>
<a class="jxr_linenumber" name="L477" href="#L477">477</a> <em class="jxr_javadoccomment"> * file.&lt;br/&gt;&lt;br/&gt;</em>
<a class="jxr_linenumber" name="L478" href="#L478">478</a> <em class="jxr_javadoccomment"> * Note: even if using this method - system properties will be loaded before properties loaded from files.</em>
<a class="jxr_linenumber" name="L479" href="#L479">479</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L480" href="#L480">480</a> <em class="jxr_javadoccomment"> * @param stream an Input Stream pointing at a properties file to merge</em>
@@ -494,9 +494,9 @@
<a class="jxr_linenumber" name="L486" href="#L486">486</a> }
<a class="jxr_linenumber" name="L487" href="#L487">487</a>
<a class="jxr_linenumber" name="L488" href="#L488">488</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file as a File object. If the value was specified as a system property or</em>
<a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> * passed in via the -Dprop=value argument - this method will return the value from the system properties before the</em>
<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * values in the contained configuration file.</em>
<a class="jxr_linenumber" name="L489" href="#L489">489</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file as a File object. If the value was specified as a system property or passed in via</em>
<a class="jxr_linenumber" name="L490" href="#L490">490</a> <em class="jxr_javadoccomment"> * the -Dprop=value argument - this method will return the value from the system properties before the values in the contained</em>
<a class="jxr_linenumber" name="L491" href="#L491">491</a> <em class="jxr_javadoccomment"> * configuration file.</em>
<a class="jxr_linenumber" name="L492" href="#L492">492</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L493" href="#L493">493</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L494" href="#L494">494</a> <em class="jxr_javadoccomment"> * @return the property from the properties file converted to a File object</em>
@@ -510,13 +510,13 @@
<a class="jxr_linenumber" name="L502" href="#L502">502</a> }
<a class="jxr_linenumber" name="L503" href="#L503">503</a>
<a class="jxr_linenumber" name="L504" href="#L504">504</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file as a File object. If the value was specified as a system property or</em>
<a class="jxr_linenumber" name="L506" href="#L506">506</a> <em class="jxr_javadoccomment"> * passed in via the -Dprop=value argument - this method will return the value from the system properties before the</em>
<a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment"> * values in the contained configuration file.</em>
<a class="jxr_linenumber" name="L505" href="#L505">505</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file as a File object. If the value was specified as a system property or passed in via</em>
<a class="jxr_linenumber" name="L506" href="#L506">506</a> <em class="jxr_javadoccomment"> * the -Dprop=value argument - this method will return the value from the system properties before the values in the contained</em>
<a class="jxr_linenumber" name="L507" href="#L507">507</a> <em class="jxr_javadoccomment"> * configuration file.</em>
<a class="jxr_linenumber" name="L508" href="#L508">508</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> * This method will check the configured base directory and will use this as the base of the file path.</em>
<a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment"> * Additionally, if the base directory begins with a leading "[JAR]\&quot; sequence with the path to the folder</em>
<a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> * containing the JAR file containing this class.</em>
<a class="jxr_linenumber" name="L509" href="#L509">509</a> <em class="jxr_javadoccomment"> * This method will check the configured base directory and will use this as the base of the file path. Additionally, if the</em>
<a class="jxr_linenumber" name="L510" href="#L510">510</a> <em class="jxr_javadoccomment"> * base directory begins with a leading "[JAR]\&quot; sequence with the path to the folder containing the JAR file containing this</em>
<a class="jxr_linenumber" name="L511" href="#L511">511</a> <em class="jxr_javadoccomment"> * class.</em>
<a class="jxr_linenumber" name="L512" href="#L512">512</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L513" href="#L513">513</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L514" href="#L514">514</a> <em class="jxr_javadoccomment"> * @return the property from the properties file converted to a File object</em>
@@ -561,9 +561,9 @@
<a class="jxr_linenumber" name="L553" href="#L553">553</a> }
<a class="jxr_linenumber" name="L554" href="#L554">554</a>
<a class="jxr_linenumber" name="L555" href="#L555">555</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L556" href="#L556">556</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L557" href="#L557">557</a> <em class="jxr_javadoccomment"> * -Dprop=value argument - this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L558" href="#L558">558</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L556" href="#L556">556</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value</em>
<a class="jxr_linenumber" name="L557" href="#L557">557</a> <em class="jxr_javadoccomment"> * argument - this method will return the value from the system properties before the values in the contained configuration</em>
<a class="jxr_linenumber" name="L558" href="#L558">558</a> <em class="jxr_javadoccomment"> * file.</em>
<a class="jxr_linenumber" name="L559" href="#L559">559</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L560" href="#L560">560</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L561" href="#L561">561</a> <em class="jxr_javadoccomment"> * @param defaultValue the default value for the requested property</em>
@@ -599,9 +599,9 @@
<a class="jxr_linenumber" name="L591" href="#L591">591</a> }
<a class="jxr_linenumber" name="L592" href="#L592">592</a>
<a class="jxr_linenumber" name="L593" href="#L593">593</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L594" href="#L594">594</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L595" href="#L595">595</a> <em class="jxr_javadoccomment"> * -Dprop=value argument - this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L596" href="#L596">596</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L594" href="#L594">594</a> <em class="jxr_javadoccomment"> * Returns a value from the properties file. If the value was specified as a system property or passed in via the -Dprop=value</em>
<a class="jxr_linenumber" name="L595" href="#L595">595</a> <em class="jxr_javadoccomment"> * argument - this method will return the value from the system properties before the values in the contained configuration</em>
<a class="jxr_linenumber" name="L596" href="#L596">596</a> <em class="jxr_javadoccomment"> * file.</em>
<a class="jxr_linenumber" name="L597" href="#L597">597</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L598" href="#L598">598</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L599" href="#L599">599</a> <em class="jxr_javadoccomment"> * @return the property from the properties file</em>
@@ -620,9 +620,9 @@
<a class="jxr_linenumber" name="L612" href="#L612">612</a> }
<a class="jxr_linenumber" name="L613" href="#L613">613</a>
<a class="jxr_linenumber" name="L614" href="#L614">614</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L615" href="#L615">615</a> <em class="jxr_javadoccomment"> * Returns an int value from the properties file. If the value was specified as a system property or passed in via</em>
<a class="jxr_linenumber" name="L616" href="#L616">616</a> <em class="jxr_javadoccomment"> * the -Dprop=value argument - this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L617" href="#L617">617</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L615" href="#L615">615</a> <em class="jxr_javadoccomment"> * Returns an int value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L616" href="#L616">616</a> <em class="jxr_javadoccomment"> * -Dprop=value argument - this method will return the value from the system properties before the values in the contained</em>
<a class="jxr_linenumber" name="L617" href="#L617">617</a> <em class="jxr_javadoccomment"> * configuration file.</em>
<a class="jxr_linenumber" name="L618" href="#L618">618</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L619" href="#L619">619</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L620" href="#L620">620</a> <em class="jxr_javadoccomment"> * @return the property from the properties file</em>
@@ -639,14 +639,14 @@
<a class="jxr_linenumber" name="L631" href="#L631">631</a> }
<a class="jxr_linenumber" name="L632" href="#L632">632</a>
<a class="jxr_linenumber" name="L633" href="#L633">633</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L634" href="#L634">634</a> <em class="jxr_javadoccomment"> * Returns an int value from the properties file. If the value was specified as a system property or passed in via</em>
<a class="jxr_linenumber" name="L635" href="#L635">635</a> <em class="jxr_javadoccomment"> * the -Dprop=value argument - this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L636" href="#L636">636</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L634" href="#L634">634</a> <em class="jxr_javadoccomment"> * Returns an int value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L635" href="#L635">635</a> <em class="jxr_javadoccomment"> * -Dprop=value argument - this method will return the value from the system properties before the values in the contained</em>
<a class="jxr_linenumber" name="L636" href="#L636">636</a> <em class="jxr_javadoccomment"> * configuration file.</em>
<a class="jxr_linenumber" name="L637" href="#L637">637</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L638" href="#L638">638</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L639" href="#L639">639</a> <em class="jxr_javadoccomment"> * @param defaultValue the default value to return</em>
<a class="jxr_linenumber" name="L640" href="#L640">640</a> <em class="jxr_javadoccomment"> * @return the property from the properties file or the defaultValue if the property does not exist or cannot be</em>
<a class="jxr_linenumber" name="L641" href="#L641">641</a> <em class="jxr_javadoccomment"> * converted to an integer</em>
<a class="jxr_linenumber" name="L640" href="#L640">640</a> <em class="jxr_javadoccomment"> * @return the property from the properties file or the defaultValue if the property does not exist or cannot be converted to</em>
<a class="jxr_linenumber" name="L641" href="#L641">641</a> <em class="jxr_javadoccomment"> * an integer</em>
<a class="jxr_linenumber" name="L642" href="#L642">642</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L643" href="#L643">643</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> getInt(String key, <strong class="jxr_keyword">int</strong> defaultValue) {
<a class="jxr_linenumber" name="L644" href="#L644">644</a> <strong class="jxr_keyword">int</strong> value;
@@ -661,9 +661,9 @@
<a class="jxr_linenumber" name="L653" href="#L653">653</a> }
<a class="jxr_linenumber" name="L654" href="#L654">654</a>
<a class="jxr_linenumber" name="L655" href="#L655">655</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L656" href="#L656">656</a> <em class="jxr_javadoccomment"> * Returns a long value from the properties file. If the value was specified as a system property or passed in via</em>
<a class="jxr_linenumber" name="L657" href="#L657">657</a> <em class="jxr_javadoccomment"> * the -Dprop=value argument - this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L658" href="#L658">658</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L656" href="#L656">656</a> <em class="jxr_javadoccomment"> * Returns a long value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L657" href="#L657">657</a> <em class="jxr_javadoccomment"> * -Dprop=value argument - this method will return the value from the system properties before the values in the contained</em>
<a class="jxr_linenumber" name="L658" href="#L658">658</a> <em class="jxr_javadoccomment"> * configuration file.</em>
<a class="jxr_linenumber" name="L659" href="#L659">659</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L660" href="#L660">660</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L661" href="#L661">661</a> <em class="jxr_javadoccomment"> * @return the property from the properties file</em>
@@ -680,9 +680,9 @@
<a class="jxr_linenumber" name="L672" href="#L672">672</a> }
<a class="jxr_linenumber" name="L673" href="#L673">673</a>
<a class="jxr_linenumber" name="L674" href="#L674">674</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L675" href="#L675">675</a> <em class="jxr_javadoccomment"> * Returns a boolean value from the properties file. If the value was specified as a system property or passed in</em>
<a class="jxr_linenumber" name="L676" href="#L676">676</a> <em class="jxr_javadoccomment"> * via the &lt;code&gt;-Dprop=value&lt;/code&gt; argument this method will return the value from the system properties before</em>
<a class="jxr_linenumber" name="L677" href="#L677">677</a> <em class="jxr_javadoccomment"> * the values in the contained configuration file.</em>
<a class="jxr_linenumber" name="L675" href="#L675">675</a> <em class="jxr_javadoccomment"> * Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L676" href="#L676">676</a> <em class="jxr_javadoccomment"> * &lt;code&gt;-Dprop=value&lt;/code&gt; argument this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L677" href="#L677">677</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L678" href="#L678">678</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L679" href="#L679">679</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L680" href="#L680">680</a> <em class="jxr_javadoccomment"> * @return the property from the properties file</em>
@@ -699,9 +699,9 @@
<a class="jxr_linenumber" name="L691" href="#L691">691</a> }
<a class="jxr_linenumber" name="L692" href="#L692">692</a>
<a class="jxr_linenumber" name="L693" href="#L693">693</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L694" href="#L694">694</a> <em class="jxr_javadoccomment"> * Returns a boolean value from the properties file. If the value was specified as a system property or passed in</em>
<a class="jxr_linenumber" name="L695" href="#L695">695</a> <em class="jxr_javadoccomment"> * via the &lt;code&gt;-Dprop=value&lt;/code&gt; argument this method will return the value from the system properties before</em>
<a class="jxr_linenumber" name="L696" href="#L696">696</a> <em class="jxr_javadoccomment"> * the values in the contained configuration file.</em>
<a class="jxr_linenumber" name="L694" href="#L694">694</a> <em class="jxr_javadoccomment"> * Returns a boolean value from the properties file. If the value was specified as a system property or passed in via the</em>
<a class="jxr_linenumber" name="L695" href="#L695">695</a> <em class="jxr_javadoccomment"> * &lt;code&gt;-Dprop=value&lt;/code&gt; argument this method will return the value from the system properties before the values in the</em>
<a class="jxr_linenumber" name="L696" href="#L696">696</a> <em class="jxr_javadoccomment"> * contained configuration file.</em>
<a class="jxr_linenumber" name="L697" href="#L697">697</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L698" href="#L698">698</a> <em class="jxr_javadoccomment"> * @param key the key to lookup within the properties file</em>
<a class="jxr_linenumber" name="L699" href="#L699">699</a> <em class="jxr_javadoccomment"> * @param defaultValue the default value to return if the setting does not exist</em>
@@ -723,9 +723,9 @@
<a class="jxr_linenumber" name="L715" href="#L715">715</a> }
<a class="jxr_linenumber" name="L716" href="#L716">716</a>
<a class="jxr_linenumber" name="L717" href="#L717">717</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L718" href="#L718">718</a> <em class="jxr_javadoccomment"> * Returns a connection string from the configured properties. If the connection string contains a %s, this method</em>
<a class="jxr_linenumber" name="L719" href="#L719">719</a> <em class="jxr_javadoccomment"> * will determine the 'data' directory and replace the %s with the path to the data directory. If the data directory</em>
<a class="jxr_linenumber" name="L720" href="#L720">720</a> <em class="jxr_javadoccomment"> * does not exists it will be created.</em>
<a class="jxr_linenumber" name="L718" href="#L718">718</a> <em class="jxr_javadoccomment"> * Returns a connection string from the configured properties. If the connection string contains a %s, this method will</em>
<a class="jxr_linenumber" name="L719" href="#L719">719</a> <em class="jxr_javadoccomment"> * determine the 'data' directory and replace the %s with the path to the data directory. If the data directory does not</em>
<a class="jxr_linenumber" name="L720" href="#L720">720</a> <em class="jxr_javadoccomment"> * exists it will be created.</em>
<a class="jxr_linenumber" name="L721" href="#L721">721</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L722" href="#L722">722</a> <em class="jxr_javadoccomment"> * @param connectionStringKey the property file key for the connection string</em>
<a class="jxr_linenumber" name="L723" href="#L723">723</a> <em class="jxr_javadoccomment"> * @param dbFileNameKey the settings key for the db filename</em>
@@ -778,8 +778,8 @@
<a class="jxr_linenumber" name="L770" href="#L770">770</a> }
<a class="jxr_linenumber" name="L771" href="#L771">771</a>
<a class="jxr_linenumber" name="L772" href="#L772">772</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L773" href="#L773">773</a> <em class="jxr_javadoccomment"> * Retrieves the directory that the JAR file exists in so that we can ensure we always use a common data directory</em>
<a class="jxr_linenumber" name="L774" href="#L774">774</a> <em class="jxr_javadoccomment"> * for the embedded H2 database. This is public solely for some unit tests; otherwise this should be private.</em>
<a class="jxr_linenumber" name="L773" href="#L773">773</a> <em class="jxr_javadoccomment"> * Retrieves the directory that the JAR file exists in so that we can ensure we always use a common data directory for the</em>
<a class="jxr_linenumber" name="L774" href="#L774">774</a> <em class="jxr_javadoccomment"> * embedded H2 database. This is public solely for some unit tests; otherwise this should be private.</em>
<a class="jxr_linenumber" name="L775" href="#L775">775</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L776" href="#L776">776</a> <em class="jxr_javadoccomment"> * @return the data directory to store data files</em>
<a class="jxr_linenumber" name="L777" href="#L777">777</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if an IOException occurs of course...</em>