blob: 1bfe4f78f11704606058b23ccf6a2593d58b0c09 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sun Jun 10 13:05:19 MST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JsonCatalogReader (Apache Log4j Audit 1.0.0 API)</title>
<meta name="date" content="2018-06-10">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JsonCatalogReader (Apache Log4j Audit 1.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JsonCatalogReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/FileCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html" target="_top">Frames</a></li>
<li><a href="JsonCatalogReader.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.catalog.api.dao.AbstractCatalogReader">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.logging.log4j.catalog.api.dao</div>
<h2 title="Class JsonCatalogReader" class="title">Class JsonCatalogReader</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao">org.apache.logging.log4j.catalog.api.dao.AbstractCatalogReader</a></li>
<li>
<ul class="inheritance">
<li>org.apache.logging.log4j.catalog.api.dao.JsonCatalogReader</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">JsonCatalogReader</span>
extends <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao">AbstractCatalogReader</a></pre>
<div class="block">Provides access to the JSON version of the catalog. This version is not modifiable.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.catalog.api.dao.AbstractCatalogReader">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.logging.log4j.catalog.api.dao.<a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao">AbstractCatalogReader</a></h3>
<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#attributes">attributes</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#catalogData">catalogData</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#JsonCatalogReader--">JsonCatalogReader</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#getCatalogReader--">getCatalogReader</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html?is-external=true" title="class or interface in java.time">LocalDateTime</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#getLastUpdated--">getLastUpdated</a></span>()</code>
<div class="block">Returns the last update time of the catalog.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#init--">init</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#readCatalog--">readCatalog</a></span>()</code>
<div class="block">Returns a String representation of the Catalog.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html#setCatalogReader-org.apache.logging.log4j.catalog.api.CatalogReader-">setCatalogReader</a></span>(<a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a>&nbsp;catalogReader)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.logging.log4j.catalog.api.dao.AbstractCatalogReader">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.logging.log4j.catalog.api.dao.<a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao">AbstractCatalogReader</a></h3>
<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#getAttribute-java.lang.String-">getAttribute</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#getAttributes--">getAttributes</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#getCategory-java.lang.String-">getCategory</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#getEvent-java.lang.String-">getEvent</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#getProduct-java.lang.String-">getProduct</a>, <a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#read--">read</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JsonCatalogReader--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JsonCatalogReader</h4>
<pre>public&nbsp;JsonCatalogReader()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCatalogReader--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalogReader</h4>
<pre>public&nbsp;<a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a>&nbsp;getCatalogReader()</pre>
</li>
</ul>
<a name="setCatalogReader-org.apache.logging.log4j.catalog.api.CatalogReader-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCatalogReader</h4>
<pre>public&nbsp;void&nbsp;setCatalogReader(<a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a>&nbsp;catalogReader)</pre>
</li>
</ul>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public&nbsp;void&nbsp;init()</pre>
</li>
</ul>
<a name="readCatalog--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readCatalog</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;readCatalog()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html#readCatalog--">CatalogReader</a></code></span></div>
<div class="block">Returns a String representation of the Catalog. The representation format is implementation specific.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html#readCatalog--">readCatalog</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html" title="interface in org.apache.logging.log4j.catalog.api">CatalogReader</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html#readCatalog--">readCatalog</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/AbstractCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao">AbstractCatalogReader</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a String containing the Catalog data.</dd>
</dl>
</li>
</ul>
<a name="getLastUpdated--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLastUpdated</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/time/LocalDateTime.html?is-external=true" title="class or interface in java.time">LocalDateTime</a>&nbsp;getLastUpdated()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../../org/apache/logging/log4j/catalog/api/CatalogReader.html#getLastUpdated--">CatalogReader</a></code></span></div>
<div class="block">Returns the last update time of the catalog.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The last update time of the catalog.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/JsonCatalogReader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../org/apache/logging/log4j/catalog/api/dao/FileCatalogReader.html" title="class in org.apache.logging.log4j.catalog.api.dao"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/logging/log4j/catalog/api/dao/JsonCatalogReader.html" target="_top">Frames</a></li>
<li><a href="JsonCatalogReader.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.logging.log4j.catalog.api.dao.AbstractCatalogReader">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><p align="center">Copyright &#169; 2016-2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.<br /> Apache Logging, Apache Log4j, Apache Log4j Audit, Log4j, Log4j Audit, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.</p></small></p>
</body>
</html>