github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-21 08:39:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation v1.3.1

Browse Source
This commit is contained in:
Jeremy Long
2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions
Download Patch File Download Diff File Expand all files Collapse all files

224
dependency-check-utils/xref/org/owasp/dependencycheck/utils/FileUtils.html
View File

@@ -30,139 +30,97 @@
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.UUID;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * A collection of utilities for processing information about files.</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</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/FileUtils.html">FileUtils</a> {
<a class="jxr_linenumber" name="L35" href="#L35">35</a>
<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"> * The logger.</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">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(FileUtils.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Bit bucket for non-Windows systems</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BIT_BUCKET_UNIX = <span class="jxr_string">"/dev/null"</span>;
<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"> * Bit bucket for Windows systems (yes, only one 'L')</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BIT_BUCKET_WIN = <span class="jxr_string">"NUL"</span>;
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Private constructor for a utility class.</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html">FileUtils</a>() {
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<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"> * Returns the (lowercase) file extension for a specified file.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param fileName the file name to retrieve the file extension from.</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @return the file extension.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getFileExtension(String fileName) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> String ret = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> pos = fileName.lastIndexOf(<span class="jxr_string">"."</span>);
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">if</strong> (pos &gt;= 0) {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> ret = fileName.substring(pos + 1, fileName.length()).toLowerCase();
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> ret;
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Deletes a file. If the File is a directory it will recursively delete the contents.</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @param file the File to delete</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @return true if the file was deleted successfully, otherwise false</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> delete(File file) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">boolean</strong> success = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">if</strong> (!org.apache.commons.io.FileUtils.deleteQuietly(file)) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> success = false;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> LOGGER.debug(<span class="jxr_string">"Failed to delete file: {}; attempting to delete on exit."</span>, file.getPath());
<a class="jxr_linenumber" name="L82" href="#L82">82</a> file.deleteOnExit();
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> success;
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Generates a new temporary file name that is guaranteed to be unique.</em>
<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"> * @param prefix the prefix for the file name to generate</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @param extension the extension of the generated file name</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @return a temporary File</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException thrown if the temporary folder could not be created</em>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> File getTempFile(String prefix, String extension) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> File dir = Settings.getTempDirectory();
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">final</strong> String tempFileName = String.format(<span class="jxr_string">"%s%s.%s"</span>, prefix, UUID.randomUUID().toString(), extension);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">final</strong> File tempFile = <strong class="jxr_keyword">new</strong> File(dir, tempFileName);
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">if</strong> (tempFile.exists()) {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> getTempFile(prefix, extension);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">return</strong> tempFile;
<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 data directory. If a path was specified in dependencycheck.properties or was specified using the Settings</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * object, and the path exists, that path will be returned as a File object. If it does not exist, then a File object will be</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * created based on the file location of the JAR containing the specified class.</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> <em class="jxr_javadoccomment"> * @param configuredFilePath the configured relative or absolute path</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * @param clazz the class to resolve the path</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @return a File object</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @throws IOException is thrown if the path could not be decoded</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * @deprecated This method should no longer be used. See the implementation in dependency-check-cli/App.java to see how the</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * data directory should be set.</em>
<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> @java.lang.Deprecated
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> File getDataDirectory(String configuredFilePath, Class clazz) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">final</strong> File file = <strong class="jxr_keyword">new</strong> File(configuredFilePath);
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">if</strong> (file.isDirectory() &amp;&amp; file.canWrite()) {
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(file.getCanonicalPath());
<a class="jxr_linenumber" name="L122" href="#L122">122</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">final</strong> File exePath = getPathToJar(clazz);
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(exePath, configuredFilePath);
<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="L128" href="#L128">128</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * Retrieves the physical path to the parent directory containing the provided class. For example, if a JAR file contained a</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * class org.something.clazz this method would return the parent directory of the JAR file.</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @param clazz the class to determine the parent directory of</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @return the parent directory of the file containing the specified class.</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @throws UnsupportedEncodingException thrown if UTF-8 is not supported.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * @deprecated this should no longer be used.</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> @java.lang.Deprecated
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> File getPathToJar(Class clazz) <strong class="jxr_keyword">throws</strong> UnsupportedEncodingException {
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">final</strong> String filePath = clazz.getProtectionDomain().getCodeSource().getLocation().getPath();
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">final</strong> String decodedPath = URLDecoder.decode(filePath, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">final</strong> File jarPath = <strong class="jxr_keyword">new</strong> File(decodedPath);
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">return</strong> jarPath.getParentFile();
<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * Return the bit bucket for the OS. '/dev/null' for Unix and 'NUL' for Windows</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * @return a String containing the bit bucket</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getBitBucket() {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">if</strong> (System.getProperty(<span class="jxr_string">"os.name"</span>).startsWith(<span class="jxr_string">"Windows"</span>)) {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> BIT_BUCKET_WIN;
<a class="jxr_linenumber" name="L153" href="#L153">153</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">return</strong> BIT_BUCKET_UNIX;
<a class="jxr_linenumber" name="L155" href="#L155">155</a> }
<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
<a class="jxr_linenumber" name="L157" href="#L157">157</a> }
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.UUID;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * A collection of utilities for processing information about files.</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html">FileUtils</a> {
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * The logger.</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOGGER = LoggerFactory.getLogger(FileUtils.<strong class="jxr_keyword">class</strong>);
<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> <em class="jxr_javadoccomment"> * Bit bucket for non-Windows systems</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BIT_BUCKET_UNIX = <span class="jxr_string">"/dev/null"</span>;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Bit bucket for Windows systems (yes, only one 'L')</em>
<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BIT_BUCKET_WIN = <span class="jxr_string">"NUL"</span>;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<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> <em class="jxr_javadoccomment"> * Private constructor for a utility class.</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/utils/FileUtils.html">FileUtils</a>() {
<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"> * Returns the (lowercase) file extension for a specified file.</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"> * @param fileName the file name to retrieve the file extension from.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @return the file extension.</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getFileExtension(String fileName) {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> String ret = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> pos = fileName.lastIndexOf(<span class="jxr_string">"."</span>);
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (pos &gt;= 0) {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> ret = fileName.substring(pos + 1, fileName.length()).toLowerCase();
<a class="jxr_linenumber" name="L65" href="#L65">65</a> }
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> ret;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Deletes a file. If the File is a directory it will recursively delete the contents.</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @param file the File to delete</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @return true if the file was deleted successfully, otherwise false</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> delete(File file) {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">boolean</strong> success = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">if</strong> (!org.apache.commons.io.FileUtils.deleteQuietly(file)) {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> success = false;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> LOGGER.debug(<span class="jxr_string">"Failed to delete file: {}; attempting to delete on exit."</span>, file.getPath());
<a class="jxr_linenumber" name="L80" href="#L80">80</a> file.deleteOnExit();
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> success;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * Generates a new temporary file name that is guaranteed to be unique.</em>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * @param prefix the prefix for the file name to generate</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @param extension the extension of the generated file name</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @return a temporary File</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @throws java.io.IOException thrown if the temporary folder could not be created</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> File getTempFile(String prefix, String extension) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">final</strong> File dir = Settings.getTempDirectory();
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> String tempFileName = String.format(<span class="jxr_string">"%s%s.%s"</span>, prefix, UUID.randomUUID().toString(), extension);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> File tempFile = <strong class="jxr_keyword">new</strong> File(dir, tempFileName);
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">if</strong> (tempFile.exists()) {
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">return</strong> getTempFile(prefix, extension);
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> tempFile;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Return the bit bucket for the OS. '/dev/null' for Unix and 'NUL' for Windows</em>
<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"> * @return a String containing the bit bucket</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getBitBucket() {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">if</strong> (System.getProperty(<span class="jxr_string">"os.name"</span>).startsWith(<span class="jxr_string">"Windows"</span>)) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> BIT_BUCKET_WIN;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> BIT_BUCKET_UNIX;
<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> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

1116
dependency-check-utils/xref/org/owasp/dependencycheck/utils/Settings.html
View File

File diff suppressed because it is too large Load Diff

204
dependency-check-utils/xref/org/owasp/dependencycheck/utils/URLConnectionFactory.html
View File

@@ -25,107 +25,109 @@
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.owasp.dependencycheck.utils;
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.net.Authenticator;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.net.HttpURLConnection;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.net.InetSocketAddress;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.net.PasswordAuthentication;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.net.Proxy;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * A URLConnection Factory to create new connections. This encapsulates several configuration checks to ensure that the connection</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * uses the correct proxy settings.</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFactory.html">URLConnectionFactory</a> {
<a class="jxr_linenumber" name="L36" href="#L36">36</a>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * Private constructor for this factory.</em>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFactory.html">URLConnectionFactory</a>() {
<a class="jxr_linenumber" name="L41" href="#L41">41</a> }
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Utility method to create an HttpURLConnection. If the application is configured to use a proxy this method will retrieve</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * the proxy settings and use them when setting up the connection.</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param url the url to connect to</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @return an HttpURLConnection</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @throws URLConnectionFailureException thrown if there is an exception</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpURLConnection createHttpURLConnection(URL url) <strong class="jxr_keyword">throws</strong> URLConnectionFailureException {
<a class="jxr_linenumber" name="L52" href="#L52">52</a> HttpURLConnection conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> Proxy proxy;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">final</strong> String proxyUrl = Settings.getString(Settings.KEYS.PROXY_SERVER);
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">if</strong> (proxyUrl != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> proxyPort = Settings.getInt(Settings.KEYS.PROXY_PORT);
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">final</strong> SocketAddress address = <strong class="jxr_keyword">new</strong> InetSocketAddress(proxyUrl, proxyPort);
<a class="jxr_linenumber" name="L59" href="#L59">59</a>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">final</strong> String username = Settings.getString(Settings.KEYS.PROXY_USERNAME);
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">final</strong> String password = Settings.getString(Settings.KEYS.PROXY_PASSWORD);
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">if</strong> (username != <strong class="jxr_keyword">null</strong> &amp;&amp; password != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">final</strong> Authenticator auth = <strong class="jxr_keyword">new</strong> Authenticator() {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> @Override
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">public</strong> PasswordAuthentication getPasswordAuthentication() {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (getRequestorType().equals(Authenticator.RequestorType.PROXY)) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PasswordAuthentication(username, password.toCharArray());
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.getPasswordAuthentication();
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a> };
<a class="jxr_linenumber" name="L72" href="#L72">72</a> Authenticator.setDefault(auth);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> proxy = <strong class="jxr_keyword">new</strong> Proxy(Proxy.Type.HTTP, address);
<a class="jxr_linenumber" name="L76" href="#L76">76</a> conn = (HttpURLConnection) url.openConnection(proxy);
<a class="jxr_linenumber" name="L77" href="#L77">77</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> conn = (HttpURLConnection) url.openConnection();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> timeout = Settings.getInt(Settings.KEYS.CONNECTION_TIMEOUT, 10000);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> conn.setConnectTimeout(timeout);
<a class="jxr_linenumber" name="L82" href="#L82">82</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> conn.disconnect();
<a class="jxr_linenumber" name="L87" href="#L87">87</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L89" href="#L89">89</a> }
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFailureException.html">URLConnectionFailureException</a>(<span class="jxr_string">"Error getting connection."</span>, ex);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> conn;
<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"> * Utility method to create an HttpURLConnection. The use of a proxy here is optional as there may be cases where a proxy is</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * configured but we don't want to use it (for example, if there's an internal repository configured)</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> <em class="jxr_javadoccomment"> * @param url the URL to connect to</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param proxy whether to use the proxy (if configured)</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @return a newly constructed HttpURLConnection</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @throws URLConnectionFailureException thrown if there is an exception</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpURLConnection createHttpURLConnection(URL url, <strong class="jxr_keyword">boolean</strong> proxy) <strong class="jxr_keyword">throws</strong> URLConnectionFailureException {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> (proxy) {
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">return</strong> createHttpURLConnection(url);
<a class="jxr_linenumber" name="L108" href="#L108">108</a> }
<a class="jxr_linenumber" name="L109" href="#L109">109</a> HttpURLConnection conn = <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> conn = (HttpURLConnection) url.openConnection();
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> timeout = Settings.getInt(Settings.KEYS.CONNECTION_TIMEOUT, 10000);
<a class="jxr_linenumber" name="L113" href="#L113">113</a> conn.setConnectTimeout(timeout);
<a class="jxr_linenumber" name="L114" href="#L114">114</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFailureException.html">URLConnectionFailureException</a>(<span class="jxr_string">"Error getting connection."</span>, ioe);
<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong> conn;
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.net.Authenticator;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.net.HttpURLConnection;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.net.InetSocketAddress;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.net.PasswordAuthentication;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.net.Proxy;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.net.SocketAddress;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * A URLConnection Factory to create new connections. This encapsulates several configuration checks to ensure that the connection</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * uses the correct proxy settings.</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @author Jeremy Long</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</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/URLConnectionFactory.html">URLConnectionFactory</a> {
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<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> <em class="jxr_javadoccomment"> * Private constructor for this factory.</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFactory.html">URLConnectionFactory</a>() {
<a class="jxr_linenumber" name="L42" href="#L42">42</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"> * Utility method to create an HttpURLConnection. If the application is configured to use a proxy this method will retrieve</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * the proxy settings and use them when setting up the connection.</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"> * @param url the url to connect to</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @return an HttpURLConnection</em>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * @throws URLConnectionFailureException thrown if there is an exception</em>
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> @SuppressFBWarnings(value = <span class="jxr_string">"RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"</span>, justification = <span class="jxr_string">"Just being extra safe"</span>)
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpURLConnection createHttpURLConnection(URL url) <strong class="jxr_keyword">throws</strong> URLConnectionFailureException {
<a class="jxr_linenumber" name="L54" href="#L54">54</a> HttpURLConnection conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L55" href="#L55">55</a> Proxy proxy;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">final</strong> String proxyUrl = Settings.getString(Settings.KEYS.PROXY_SERVER);
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">if</strong> (proxyUrl != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> proxyPort = Settings.getInt(Settings.KEYS.PROXY_PORT);
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">final</strong> SocketAddress address = <strong class="jxr_keyword">new</strong> InetSocketAddress(proxyUrl, proxyPort);
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">final</strong> String username = Settings.getString(Settings.KEYS.PROXY_USERNAME);
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">final</strong> String password = Settings.getString(Settings.KEYS.PROXY_PASSWORD);
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">if</strong> (username != <strong class="jxr_keyword">null</strong> &amp;&amp; password != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">final</strong> Authenticator auth = <strong class="jxr_keyword">new</strong> Authenticator() {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> @Override
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> PasswordAuthentication getPasswordAuthentication() {
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">if</strong> (getRequestorType().equals(Authenticator.RequestorType.PROXY)) {
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PasswordAuthentication(username, password.toCharArray());
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.getPasswordAuthentication();
<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> Authenticator.setDefault(auth);
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> proxy = <strong class="jxr_keyword">new</strong> Proxy(Proxy.Type.HTTP, address);
<a class="jxr_linenumber" name="L78" href="#L78">78</a> conn = (HttpURLConnection) url.openConnection(proxy);
<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> conn = (HttpURLConnection) url.openConnection();
<a class="jxr_linenumber" name="L81" href="#L81">81</a> }
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> timeout = Settings.getInt(Settings.KEYS.CONNECTION_TIMEOUT, 10000);
<a class="jxr_linenumber" name="L83" href="#L83">83</a> conn.setConnectTimeout(timeout);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> conn.disconnect();
<a class="jxr_linenumber" name="L89" href="#L89">89</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFailureException.html">URLConnectionFailureException</a>(<span class="jxr_string">"Error getting connection."</span>, ex);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">return</strong> conn;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * Utility method to create an HttpURLConnection. The use of a proxy here is optional as there may be cases where a proxy is</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * configured but we don't want to use it (for example, if there's an internal repository configured)</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param url the URL to connect to</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @param proxy whether to use the proxy (if configured)</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @return a newly constructed HttpURLConnection</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @throws URLConnectionFailureException thrown if there is an exception</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> HttpURLConnection createHttpURLConnection(URL url, <strong class="jxr_keyword">boolean</strong> proxy) <strong class="jxr_keyword">throws</strong> URLConnectionFailureException {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">if</strong> (proxy) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> createHttpURLConnection(url);
<a class="jxr_linenumber" name="L110" href="#L110">110</a> }
<a class="jxr_linenumber" name="L111" href="#L111">111</a> HttpURLConnection conn = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> conn = (HttpURLConnection) url.openConnection();
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> timeout = Settings.getInt(Settings.KEYS.CONNECTION_TIMEOUT, 10000);
<a class="jxr_linenumber" name="L115" href="#L115">115</a> conn.setConnectTimeout(timeout);
<a class="jxr_linenumber" name="L116" href="#L116">116</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="L117" href="#L117">117</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../org/owasp/dependencycheck/utils/URLConnectionFailureException.html">URLConnectionFailureException</a>(<span class="jxr_string">"Error getting connection."</span>, ioe);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">return</strong> conn;
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
<a class="jxr_linenumber" name="L122" href="#L122">122</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2012&#x2013;2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>

2
dependency-check-utils/xref/org/owasp/dependencycheck/utils/package-frame.html
View File

@@ -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 Utils 1.3.0 Reference Package org.owasp.dependencycheck.utils</title>
<title>Dependency-Check Utils 1.3.1 Reference Package org.owasp.dependencycheck.utils</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>

2
dependency-check-utils/xref/org/owasp/dependencycheck/utils/package-summary.html
View File

@@ -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 Utils 1.3.0 Reference Package org.owasp.dependencycheck.utils</title>
<title>Dependency-Check Utils 1.3.1 Reference Package org.owasp.dependencycheck.utils</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
</head>
<body>