TMP:site (Nach Korrektur an thymeskin neu generiert??)
[website] / dist / http-resources / 2.0.0 / xref / de / juplo / httpresources / HttpResourcesAutoConfiguration.html
diff --git a/dist/http-resources/2.0.0/xref/de/juplo/httpresources/HttpResourcesAutoConfiguration.html b/dist/http-resources/2.0.0/xref/de/juplo/httpresources/HttpResourcesAutoConfiguration.html
new file mode 100644 (file)
index 0000000..554762c
--- /dev/null
@@ -0,0 +1,152 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>HttpResourcesAutoConfiguration xref</title>
+<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../apidocs/de/juplo/httpresources/HttpResourcesAutoConfiguration.html">View Javadoc</a></div><pre>
+<a class="jxr_linenumber" name="L1" href="#L1">1</a>   <strong class="jxr_keyword">package</strong> de.juplo.httpresources;
+<a class="jxr_linenumber" name="L2" href="#L2">2</a>   
+<a class="jxr_linenumber" name="L3" href="#L3">3</a>   
+<a class="jxr_linenumber" name="L4" href="#L4">4</a>   <strong class="jxr_keyword">import</strong> java.time.Clock;
+<a class="jxr_linenumber" name="L5" href="#L5">5</a>   <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
+<a class="jxr_linenumber" name="L6" href="#L6">6</a>   <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
+<a class="jxr_linenumber" name="L7" href="#L7">7</a>   <strong class="jxr_keyword">import</strong> org.springframework.boot.autoconfigure.AutoConfigureBefore;
+<a class="jxr_linenumber" name="L8" href="#L8">8</a>   <strong class="jxr_keyword">import</strong> org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+<a class="jxr_linenumber" name="L9" href="#L9">9</a>   <strong class="jxr_keyword">import</strong> org.springframework.boot.autoconfigure.web.ResourceProperties;
+<a class="jxr_linenumber" name="L10" href="#L10">10</a>  <strong class="jxr_keyword">import</strong> org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
+<a class="jxr_linenumber" name="L11" href="#L11">11</a>  <strong class="jxr_keyword">import</strong> org.springframework.boot.context.properties.EnableConfigurationProperties;
+<a class="jxr_linenumber" name="L12" href="#L12">12</a>  <strong class="jxr_keyword">import</strong> org.springframework.cache.Cache;
+<a class="jxr_linenumber" name="L13" href="#L13">13</a>  <strong class="jxr_keyword">import</strong> org.springframework.cache.concurrent.ConcurrentMapCache;
+<a class="jxr_linenumber" name="L14" href="#L14">14</a>  <strong class="jxr_keyword">import</strong> org.springframework.cache.support.NoOpCache;
+<a class="jxr_linenumber" name="L15" href="#L15">15</a>  <strong class="jxr_keyword">import</strong> org.springframework.context.ApplicationContext;
+<a class="jxr_linenumber" name="L16" href="#L16">16</a>  <strong class="jxr_keyword">import</strong> org.springframework.context.annotation.Bean;
+<a class="jxr_linenumber" name="L17" href="#L17">17</a>  <strong class="jxr_keyword">import</strong> org.springframework.context.annotation.Configuration;
+<a class="jxr_linenumber" name="L18" href="#L18">18</a>  <strong class="jxr_keyword">import</strong> org.springframework.core.io.DefaultResourceLoader;
+<a class="jxr_linenumber" name="L19" href="#L19">19</a>  <strong class="jxr_keyword">import</strong> org.springframework.http.client.ClientHttpRequestFactory;
+<a class="jxr_linenumber" name="L20" href="#L20">20</a>  
+<a class="jxr_linenumber" name="L21" href="#L21">21</a>  
+<a class="jxr_linenumber" name="L22" href="#L22">22</a>  <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L23" href="#L23">23</a>  <em class="jxr_javadoccomment"> * Automatic configuration</em>
+<a class="jxr_linenumber" name="L24" href="#L24">24</a>  <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L25" href="#L25">25</a>  <em class="jxr_javadoccomment"> * @author Kai Moritz</em>
+<a class="jxr_linenumber" name="L26" href="#L26">26</a>  <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L27" href="#L27">27</a>  @Configuration
+<a class="jxr_linenumber" name="L28" href="#L28">28</a>  @EnableConfigurationProperties(HttpResourcesProperties.<strong class="jxr_keyword">class</strong>)
+<a class="jxr_linenumber" name="L29" href="#L29">29</a>  @AutoConfigureBefore(WebMvcAutoConfiguration.<strong class="jxr_keyword">class</strong>)
+<a class="jxr_linenumber" name="L30" href="#L30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="HttpResourcesAutoConfiguration" href="../../../de/juplo/httpresources/HttpResourcesAutoConfiguration.html#HttpResourcesAutoConfiguration">HttpResourcesAutoConfiguration</a>
+<a class="jxr_linenumber" name="L31" href="#L31">31</a>  {
+<a class="jxr_linenumber" name="L32" href="#L32">32</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG =
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>        LoggerFactory.getLogger(HttpResourcesAutoConfiguration.<strong class="jxr_keyword">class</strong>);
+<a class="jxr_linenumber" name="L34" href="#L34">34</a>  
+<a class="jxr_linenumber" name="L35" href="#L35">35</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CACHE_NAME = <span class="jxr_string">"http-resources-cache"</span>;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>  
+<a class="jxr_linenumber" name="L37" href="#L37">37</a>  
+<a class="jxr_linenumber" name="L38" href="#L38">38</a>    @ConditionalOnMissingBean(Clock.<strong class="jxr_keyword">class</strong>)
+<a class="jxr_linenumber" name="L39" href="#L39">39</a>    @Bean
+<a class="jxr_linenumber" name="L40" href="#L40">40</a>    <strong class="jxr_keyword">public</strong> Clock clock()
+<a class="jxr_linenumber" name="L41" href="#L41">41</a>    {
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>      <strong class="jxr_keyword">return</strong> Clock.systemDefaultZone();
+<a class="jxr_linenumber" name="L43" href="#L43">43</a>    }
+<a class="jxr_linenumber" name="L44" href="#L44">44</a>  
+<a class="jxr_linenumber" name="L45" href="#L45">45</a>    @ConditionalOnMissingBean(name = <span class="jxr_string">"sources"</span>)
+<a class="jxr_linenumber" name="L46" href="#L46">46</a>    @Bean
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>    <strong class="jxr_keyword">public</strong> String[] sources(ResourceProperties properties)
+<a class="jxr_linenumber" name="L48" href="#L48">48</a>    {
+<a class="jxr_linenumber" name="L49" href="#L49">49</a>      String[] sources = properties.getStaticLocations();
+<a class="jxr_linenumber" name="L50" href="#L50">50</a>  
+<a class="jxr_linenumber" name="L51" href="#L51">51</a>      <strong class="jxr_keyword">if</strong> (sources.length == 0)
+<a class="jxr_linenumber" name="L52" href="#L52">52</a>        <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"At least one source must be configured!"</span>);
+<a class="jxr_linenumber" name="L53" href="#L53">53</a>  
+<a class="jxr_linenumber" name="L54" href="#L54">54</a>      <strong class="jxr_keyword">boolean</strong> hasRemoteResource = false;
+<a class="jxr_linenumber" name="L55" href="#L55">55</a>      <strong class="jxr_keyword">for</strong> (String source : sources)
+<a class="jxr_linenumber" name="L56" href="#L56">56</a>        hasRemoteResource |= HttpResources.isHttpResource(source);
+<a class="jxr_linenumber" name="L57" href="#L57">57</a>      <strong class="jxr_keyword">if</strong> (!hasRemoteResource)
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>        LOG.warn(<span class="jxr_string">"No remote-resource in {}"</span>, sources);
+<a class="jxr_linenumber" name="L59" href="#L59">59</a>  
+<a class="jxr_linenumber" name="L60" href="#L60">60</a>      <strong class="jxr_keyword">return</strong> sources;
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>    }
+<a class="jxr_linenumber" name="L62" href="#L62">62</a>  
+<a class="jxr_linenumber" name="L63" href="#L63">63</a>  
+<a class="jxr_linenumber" name="L64" href="#L64">64</a>    @ConditionalOnMissingBean(HttpResourceFetcher.<strong class="jxr_keyword">class</strong>)
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>    @Bean
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>    <strong class="jxr_keyword">public</strong> <a name="HttpResourceFetcher" href="../../../de/juplo/httpresources/HttpResourceFetcher.html#HttpResourceFetcher">HttpResourceFetcher</a> fetcher(
+<a class="jxr_linenumber" name="L67" href="#L67">67</a>        ClientHttpRequestFactory requestFactory,
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>        Clock clock,
+<a class="jxr_linenumber" name="L69" href="#L69">69</a>        <a name="HttpResourcesProperties" href="../../../de/juplo/httpresources/HttpResourcesProperties.html#HttpResourcesProperties">HttpResourcesProperties</a> properties)
+<a class="jxr_linenumber" name="L70" href="#L70">70</a>    {
+<a class="jxr_linenumber" name="L71" href="#L71">71</a>      LOG.info(
+<a class="jxr_linenumber" name="L72" href="#L72">72</a>          <span class="jxr_string">"Creating bean of type HttpResourceFetcher (default-ttl={}, min-ttl={}, serve-stale={})"</span>,
+<a class="jxr_linenumber" name="L73" href="#L73">73</a>          properties.defaultTTL,
+<a class="jxr_linenumber" name="L74" href="#L74">74</a>          properties.minTTL,
+<a class="jxr_linenumber" name="L75" href="#L75">75</a>          properties.serveStale);
+<a class="jxr_linenumber" name="L76" href="#L76">76</a>  
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>      Cache cache;
+<a class="jxr_linenumber" name="L78" href="#L78">78</a>      <strong class="jxr_keyword">if</strong> (properties.cache)
+<a class="jxr_linenumber" name="L79" href="#L79">79</a>      {
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>        LOG.info(<span class="jxr_string">"Enable caching for HttpResources"</span>);
+<a class="jxr_linenumber" name="L81" href="#L81">81</a>        cache = <strong class="jxr_keyword">new</strong> ConcurrentMapCache(CACHE_NAME);
+<a class="jxr_linenumber" name="L82" href="#L82">82</a>      }
+<a class="jxr_linenumber" name="L83" href="#L83">83</a>      <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L84" href="#L84">84</a>      {
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>        cache = <strong class="jxr_keyword">new</strong> NoOpCache(CACHE_NAME);
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>      }
+<a class="jxr_linenumber" name="L87" href="#L87">87</a>  
+<a class="jxr_linenumber" name="L88" href="#L88">88</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="HttpResourceFetcher" href="../../../de/juplo/httpresources/HttpResourceFetcher.html#HttpResourceFetcher">HttpResourceFetcher</a>(
+<a class="jxr_linenumber" name="L89" href="#L89">89</a>          requestFactory,
+<a class="jxr_linenumber" name="L90" href="#L90">90</a>          cache,
+<a class="jxr_linenumber" name="L91" href="#L91">91</a>          clock,
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>          properties.defaultTTL,
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>          properties.minTTL,
+<a class="jxr_linenumber" name="L94" href="#L94">94</a>          properties.serveStale);
+<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>    @ConditionalOnMissingBean(HttpResources.<strong class="jxr_keyword">class</strong>)
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>    @Bean
+<a class="jxr_linenumber" name="L99" href="#L99">99</a>    <strong class="jxr_keyword">public</strong> <a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a> httpResources(
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>       <a name="HttpResourceFetcher" href="../../../de/juplo/httpresources/HttpResourceFetcher.html#HttpResourceFetcher">HttpResourceFetcher</a> fetcher,
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>       Clock clock,
+<a class="jxr_linenumber" name="L102" href="#L102">102</a>       <a name="HttpResourcesProperties" href="../../../de/juplo/httpresources/HttpResourcesProperties.html#HttpResourcesProperties">HttpResourcesProperties</a> properties
+<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>     LOG.info(
+<a class="jxr_linenumber" name="L106" href="#L106">106</a>         <span class="jxr_string">"Creating bean of type HttpResources (fetcher={}, cache={})"</span>,
+<a class="jxr_linenumber" name="L107" href="#L107">107</a>         properties.cache,
+<a class="jxr_linenumber" name="L108" href="#L108">108</a>         fetcher);
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> 
+<a class="jxr_linenumber" name="L110" href="#L110">110</a>     <a name="HttpResources" href="../../../de/juplo/httpresources/HttpR<a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a>#HttpResources">HttpResources</a> resources = <strong class="jxr_keyword">new</strong> <a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a>(fetcher, clock);
+<a class="jxr_linenumber" name="L111" href="#L111">111</a>     <strong class="jxr_keyword">return</strong> resources;
+<a class="jxr_linenumber" name="L112" href="#L112">112</a>   }
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> 
+<a class="jxr_linenumber" name="L114" href="#L114">114</a>   @ConditionalOnMissingBean
+<a class="jxr_linenumber" name="L115" href="#L115">115</a>   @Bean
+<a class="jxr_linenumber" name="L116" href="#L116">116</a>   <strong class="jxr_keyword">public</strong> <a name="HttpResourceProtocolResolver" href="../../../de/juplo/httpresources/HttpResourceProtocolResolver.html#HttpResourceProtocolResolver">HttpResourceProtocolResolver</a> httpResourceProtocolResolver(
+<a class="jxr_linenumber" name="L117" href="#L117">117</a>       <a name="HttpResources" href="../../../de/juplo/httpresources/HttpResources.html#HttpResources">HttpResources</a> resources,
+<a class="jxr_linenumber" name="L118" href="#L118">118</a>       <a name="HttpResourcesProperties" href="../../../de/juplo/httpresources/HttpResourcesProperties.html#HttpResourcesProperties">HttpResourcesProperties</a> properties,
+<a class="jxr_linenumber" name="L119" href="#L119">119</a>       DefaultResourceLoader resourceLoader
+<a class="jxr_linenumber" name="L120" href="#L120">120</a>       )
+<a class="jxr_linenumber" name="L121" href="#L121">121</a>   {
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>     LOG.info(<span class="jxr_string">"Creating and registrating a bean of type HttpResourceProtocolResolver"</span>);
+<a class="jxr_linenumber" name="L123" href="#L123">123</a>     <a name="HttpResourceProtocolResolver" href="../../../de/juplo/httpresources/HttpResourceProtocolResolver.html#HttpResourceProtocolResolver">HttpResourceProtocolResolver</a> resolver =
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>         <strong class="jxr_keyword">new</strong> <a name="HttpResourceProtocolResolver" href="../../../de/juplo/httpresources/HttpResourceProtocolResolver.html#HttpResourceProtocolResolver">HttpResourceProtocolResolver</a>(resources);
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>     resourceLoader.addProtocolResolver(resolver);
+<a class="jxr_linenumber" name="L126" href="#L126">126</a>     <strong class="jxr_keyword">return</strong> resolver;
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>   }
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> 
+<a class="jxr_linenumber" name="L129" href="#L129">129</a>   @ConditionalOnMissingBean
+<a class="jxr_linenumber" name="L130" href="#L130">130</a>   @Bean
+<a class="jxr_linenumber" name="L131" href="#L131">131</a>   <strong class="jxr_keyword">public</strong> <a name="HttpResourceChainAwareResourceLoader" href="../../../de/juplo/httpresources/HttpResourceChainAwareResourceLoader.html#HttpResourceChainAwareResourceLoader">HttpResourceChainAwareResourceLoader</a> httpResourceChainAwareResourceLoader(
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>       ApplicationContext context,
+<a class="jxr_linenumber" name="L133" href="#L133">133</a>       String[] sources
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>       )
+<a class="jxr_linenumber" name="L135" href="#L135">135</a>   {
+<a class="jxr_linenumber" name="L136" href="#L136">136</a>     LOG.info(<span class="jxr_string">"Creating a bean of type HttpResourceChainAwareResourceLoader"</span>);
+<a class="jxr_linenumber" name="L137" href="#L137">137</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="HttpResourceChainAwareResourceLoader" href="../../../de/juplo/httpresources/HttpResourceChainAwareResourceLoader.html#HttpResourceChainAwareResourceLoader">HttpResourceChainAwareResourceLoader</a>(context, sources);
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>   }
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> }
+</pre>
+<hr/>
+<div id="footer">Copyright &#169; 2020&#x2013;2021 <a href="https://juplo.de">juplo</a>. All rights reserved.</div>
+</body>
+</html>