| <!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>ClassPathCatalogReader xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../apidocs/org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Copyright 2001-2005 The Apache Software Foundation.</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * limitations under the License.</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.catalog.api.dao; |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayOutputStream; |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException; |
| <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.io.InputStream; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.net.URL; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.net.URLConnection; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.time.Instant; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.time.LocalDateTime; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.time.ZoneId; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> com.fasterxml.jackson.core.JsonFactory; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> com.fasterxml.jackson.core.JsonParser; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> com.fasterxml.jackson.databind.ObjectMapper; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.LogManager; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.catalog.api.CatalogData; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.util.LoaderUtil; |
| <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"> * Reads the catalog from the local file system.</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">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.html">ClassPathCatalogReader</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html">AbstractCatalogReader</a> { |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> |
| <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> Logger LOGGER = LogManager.getLogger(ClassPathCatalogReader.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String BASEDIR = <span class="jxr_string">"baseDir"</span>; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> |
| <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 CATALOG_ATTRIBUTE_NAME = <span class="jxr_string">"catalogFile"</span>; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_CATALOG_FILE = <span class="jxr_string">"catalog.json"</span>; |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String catalog; |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> LocalDateTime lastUpdated; |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.html">ClassPathCatalogReader</a>(Map<String, String> attributes) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> String catalogFile = attributes != <strong class="jxr_keyword">null</strong> ? |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> attributes.getOrDefault(CATALOG_ATTRIBUTE_NAME, DEFAULT_CATALOG_FILE) : DEFAULT_CATALOG_FILE; |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> Collection<URL> catalogs = LoaderUtil.findResources(catalogFile); |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> URL catalogURL; |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">if</strong> (catalogs.size() == 0) { |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> LOGGER.error(<span class="jxr_string">"No catalog named {} could be found on the class path"</span>, catalogFile); |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> FileNotFoundException(<span class="jxr_string">"No catalog named "</span> + catalogFile + <span class="jxr_string">" could be found"</span>); |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (catalogs.size() > 1) { |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> catalogURL = catalogs.stream().findFirst().get(); |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> LOGGER.warn(<span class="jxr_string">"Multiple catalogs named {} were found. Using {}"</span>, catalogFile, catalogURL.toString()); |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> catalogURL = catalogs.stream().findFirst().get(); |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> } |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> catalog = readCatalog(catalogURL); |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> LocalDateTime localDateTime = <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> URLConnection connection = catalogURL.openConnection(); |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> localDateTime = LocalDateTime.ofInstant(Instant.ofEpochMilli(connection.getLastModified()), |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> ZoneId.systemDefault()); |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> LOGGER.warn(<span class="jxr_string">"Unable to open connection to {}"</span>, catalogURL.toString()); |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> } |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> lastUpdated = localDateTime; |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> JsonFactory factory = <strong class="jxr_keyword">new</strong> JsonFactory(); |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> factory.enable(JsonParser.Feature.ALLOW_COMMENTS); |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> ObjectMapper objectMapper = <strong class="jxr_keyword">new</strong> ObjectMapper(factory); |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> catalogData = objectMapper.readValue(catalog, CatalogData.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> } |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> String readCatalog(URL catalogUrl) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">try</strong> (InputStream is = catalogUrl.openStream()) { |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> ByteArrayOutputStream baos = <strong class="jxr_keyword">new</strong> ByteArrayOutputStream(); |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> byte[] buffer = <strong class="jxr_keyword">new</strong> byte[1024]; |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">int</strong> length; |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">while</strong> ((length = is.read(buffer)) != -1) { |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> baos.write(buffer, 0, length); |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> } |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">return</strong> baos.toString(<span class="jxr_string">"UTF-8"</span>); |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> } |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> } |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/ClassPathCatalogReader.html">ClassPathCatalogReader</a>() <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> } |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> @Override |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> String readCatalog() { |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">return</strong> catalog; |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> } |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> @Override |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">public</strong> LocalDateTime getLastUpdated() { |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> lastUpdated; |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> } |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2016–2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |