mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-01-18 17:47:05 +01:00
documentation v1.3.2
This commit is contained in:
Jeremy Long
@@ -60,74 +60,73 @@
|
||||
<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> && 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> }
|
||||
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">final</strong> String proxyUrl = Settings.getString(Settings.KEYS.PROXY_SERVER);
|
||||
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (proxyUrl != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L58" href="#L58">58</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="L59" href="#L59">59</a> <strong class="jxr_keyword">final</strong> SocketAddress address = <strong class="jxr_keyword">new</strong> InetSocketAddress(proxyUrl, proxyPort);
|
||||
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
|
||||
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">final</strong> String username = Settings.getString(Settings.KEYS.PROXY_USERNAME);
|
||||
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">final</strong> String password = Settings.getString(Settings.KEYS.PROXY_PASSWORD);
|
||||
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (username != <strong class="jxr_keyword">null</strong> && password != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">final</strong> Authenticator auth = <strong class="jxr_keyword">new</strong> Authenticator() {
|
||||
<a class="jxr_linenumber" name="L65" href="#L65">65</a> @Override
|
||||
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">public</strong> PasswordAuthentication getPasswordAuthentication() {
|
||||
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">if</strong> (getRequestorType().equals(Authenticator.RequestorType.PROXY)) {
|
||||
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> PasswordAuthentication(username, password.toCharArray());
|
||||
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
|
||||
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.getPasswordAuthentication();
|
||||
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
|
||||
<a class="jxr_linenumber" name="L72" href="#L72">72</a> };
|
||||
<a class="jxr_linenumber" name="L73" href="#L73">73</a> Authenticator.setDefault(auth);
|
||||
<a class="jxr_linenumber" name="L74" href="#L74">74</a> }
|
||||
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
|
||||
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> Proxy proxy = <strong class="jxr_keyword">new</strong> Proxy(Proxy.Type.HTTP, address);
|
||||
<a class="jxr_linenumber" name="L77" href="#L77">77</a> conn = (HttpURLConnection) url.openConnection(proxy);
|
||||
<a class="jxr_linenumber" name="L78" href="#L78">78</a> } <strong class="jxr_keyword">else</strong> {
|
||||
<a class="jxr_linenumber" name="L79" href="#L79">79</a> conn = (HttpURLConnection) url.openConnection();
|
||||
<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
|
||||
<a class="jxr_linenumber" name="L81" href="#L81">81</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="L82" href="#L82">82</a> conn.setConnectTimeout(timeout);
|
||||
<a class="jxr_linenumber" name="L83" href="#L83">83</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
|
||||
<a class="jxr_linenumber" name="L84" href="#L84">84</a> } <strong class="jxr_keyword">catch</strong> (IOException ex) {
|
||||
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">if</strong> (conn != <strong class="jxr_keyword">null</strong>) {
|
||||
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L87" href="#L87">87</a> conn.disconnect();
|
||||
<a class="jxr_linenumber" name="L88" href="#L88">88</a> } <strong class="jxr_keyword">finally</strong> {
|
||||
<a class="jxr_linenumber" name="L89" href="#L89">89</a> conn = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L90" href="#L90">90</a> }
|
||||
<a class="jxr_linenumber" name="L91" href="#L91">91</a> }
|
||||
<a class="jxr_linenumber" name="L92" href="#L92">92</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="L93" href="#L93">93</a> }
|
||||
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">return</strong> conn;
|
||||
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
|
||||
<a class="jxr_linenumber" name="L96" href="#L96">96</a>
|
||||
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment">/**</em>
|
||||
<a class="jxr_linenumber" name="L98" href="#L98">98</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="L99" href="#L99">99</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="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> *</em>
|
||||
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param url the URL to connect to</em>
|
||||
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @param proxy whether to use the proxy (if configured)</em>
|
||||
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @return a newly constructed HttpURLConnection</em>
|
||||
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @throws URLConnectionFailureException thrown if there is an exception</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> <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="L107" href="#L107">107</a> <strong class="jxr_keyword">if</strong> (proxy) {
|
||||
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">return</strong> createHttpURLConnection(url);
|
||||
<a class="jxr_linenumber" name="L109" href="#L109">109</a> }
|
||||
<a class="jxr_linenumber" name="L110" href="#L110">110</a> HttpURLConnection conn = <strong class="jxr_keyword">null</strong>;
|
||||
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">try</strong> {
|
||||
<a class="jxr_linenumber" name="L112" href="#L112">112</a> conn = (HttpURLConnection) url.openConnection();
|
||||
<a class="jxr_linenumber" name="L113" href="#L113">113</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="L114" href="#L114">114</a> conn.setConnectTimeout(timeout);
|
||||
<a class="jxr_linenumber" name="L115" href="#L115">115</a> conn.setInstanceFollowRedirects(<strong class="jxr_keyword">true</strong>);
|
||||
<a class="jxr_linenumber" name="L116" href="#L116">116</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
|
||||
<a class="jxr_linenumber" name="L117" href="#L117">117</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="L118" href="#L118">118</a> }
|
||||
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">return</strong> conn;
|
||||
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
|
||||
<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
|
||||
</pre>
|
||||
<hr/>
|
||||
<div id="footer">Copyright © 2012–2015 <a href="http://www.owasp.org">OWASP</a>. All rights reserved.</div>
|
||||
|
||||
Reference in New Issue
Block a user