source: javadoc/genius/core/logging/XmlLogger.html@ 1

Last change on this file since 1 was 1, checked in by Wouter Pasman, 7 years ago

Initial import : Genius 9.0.0
File size: 14.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:57 CEST 2018 -->
6<title>XmlLogger (Genius Core Documentation)</title>
7<meta name="date" content="2018-06-21">
8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9<script type="text/javascript" src="../../../script.js"></script>
10</head>
11<body>
12<script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="XmlLogger (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10};
22var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
23var altColor = "altColor";
24var rowColor = "rowColor";
25var tableTab = "tableTab";
26var activeTableTab = "activeTableTab";
27</script>
28<noscript>
29<div>JavaScript is disabled on your browser.</div>
30</noscript>
31<!-- ========= START OF TOP NAVBAR ======= -->
32<div class="topNav"><a name="navbar.top">
33<!-- -->
34</a>
35<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36<a name="navbar.top.firstrow">
37<!-- -->
38</a>
39<ul class="navList" title="Navigation">
40<li><a href="../../../overview-summary.html">Overview</a></li>
41<li><a href="package-summary.html">Package</a></li>
42<li class="navBarCell1Rev">Class</li>
43<li><a href="class-use/XmlLogger.html">Use</a></li>
44<li><a href="package-tree.html">Tree</a></li>
45<li><a href="../../../deprecated-list.html">Deprecated</a></li>
46<li><a href="../../../index-all.html">Index</a></li>
47<li><a href="../../../help-doc.html">Help</a></li>
48</ul>
49</div>
50<div class="subNav">
51<ul class="navList">
52<li><a href="../../../genius/core/logging/StatisticsLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li>Next&nbsp;Class</li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/logging/XmlLogger.html" target="_top">Frames</a></li>
57<li><a href="XmlLogger.html" target="_top">No&nbsp;Frames</a></li>
58</ul>
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61</ul>
62<div>
63<script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72</script>
73</div>
74<div>
75<ul class="subNavList">
76<li>Summary:&nbsp;</li>
77<li>Nested&nbsp;|&nbsp;</li>
78<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
79<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80<li><a href="#method.summary">Method</a></li>
81</ul>
82<ul class="subNavList">
83<li>Detail:&nbsp;</li>
84<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
85<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86<li><a href="#method.detail">Method</a></li>
87</ul>
88</div>
89<a name="skip.navbar.top">
90<!-- -->
91</a></div>
92<!-- ========= END OF TOP NAVBAR ========= -->
93<!-- ======== START OF CLASS DATA ======== -->
94<div class="header">
95<div class="subTitle">genius.core.logging</div>
96<h2 title="Class XmlLogger" class="title">Class XmlLogger</h2>
97</div>
98<div class="contentContainer">
99<ul class="inheritance">
100<li>java.lang.Object</li>
101<li>
102<ul class="inheritance">
103<li>genius.core.logging.XmlLogger</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<dl>
111<dt>All Implemented Interfaces:</dt>
112<dd><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable, java.lang.AutoCloseable</dd>
113</dl>
114<hr>
115<br>
116<pre>public class <span class="typeNameLabel">XmlLogger</span>
117extends java.lang.Object
118implements <a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.io.Closeable</pre>
119<div class="block">Creates a logger which will log <a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events"><code>NegotiationEvent</code></a>s to a XML file. Logs
120 the <a href="../../../genius/core/events/SessionEndedNormallyEvent.html" title="class in genius.core.events"><code>SessionEndedNormallyEvent</code></a>.</div>
121</li>
122</ul>
123</div>
124<div class="summary">
125<ul class="blockList">
126<li class="blockList">
127<!-- =========== FIELD SUMMARY =========== -->
128<ul class="blockList">
129<li class="blockList"><a name="field.summary">
130<!-- -->
131</a>
132<h3>Field Summary</h3>
133<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
134<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
135<tr>
136<th class="colFirst" scope="col">Modifier and Type</th>
137<th class="colLast" scope="col">Field and Description</th>
138</tr>
139<tr class="altColor">
140<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,java.util.Map&lt;java.lang.Object,java.lang.Object&gt;&gt;</code></td>
141<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/XmlLogger.html#agentLogs">agentLogs</a></span></code>
142<div class="block">map<key,value> where keys are the agent names.</div>
143</td>
144</tr>
145</table>
146</li>
147</ul>
148<!-- ======== CONSTRUCTOR SUMMARY ======== -->
149<ul class="blockList">
150<li class="blockList"><a name="constructor.summary">
151<!-- -->
152</a>
153<h3>Constructor Summary</h3>
154<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
155<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
156<tr>
157<th class="colOne" scope="col">Constructor and Description</th>
158</tr>
159<tr class="altColor">
160<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/logging/XmlLogger.html#XmlLogger-java.io.OutputStream-java.lang.String-">XmlLogger</a></span>(java.io.OutputStream&nbsp;out,
161 java.lang.String&nbsp;topLabel)</code>&nbsp;</td>
162</tr>
163</table>
164</li>
165</ul>
166<!-- ========== METHOD SUMMARY =========== -->
167<ul class="blockList">
168<li class="blockList"><a name="method.summary">
169<!-- -->
170</a>
171<h3>Method Summary</h3>
172<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
173<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>
174<tr>
175<th class="colFirst" scope="col">Modifier and Type</th>
176<th class="colLast" scope="col">Method and Description</th>
177</tr>
178<tr id="i0" class="altColor">
179<td class="colFirst"><code>void</code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/XmlLogger.html#close--">close</a></span>()</code>&nbsp;</td>
181</tr>
182<tr id="i1" class="rowColor">
183<td class="colFirst"><code>void</code></td>
184<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/logging/XmlLogger.html#notifyChange-genius.core.events.NegotiationEvent-">notifyChange</a></span>(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</code>
185<div class="block">a notification call that occurs when something changed.</div>
186</td>
187</tr>
188</table>
189<ul class="blockList">
190<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
191<!-- -->
192</a>
193<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
194<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
195</ul>
196</li>
197</ul>
198</li>
199</ul>
200</div>
201<div class="details">
202<ul class="blockList">
203<li class="blockList">
204<!-- ============ FIELD DETAIL =========== -->
205<ul class="blockList">
206<li class="blockList"><a name="field.detail">
207<!-- -->
208</a>
209<h3>Field Detail</h3>
210<a name="agentLogs">
211<!-- -->
212</a>
213<ul class="blockListLast">
214<li class="blockList">
215<h4>agentLogs</h4>
216<pre>protected&nbsp;java.util.Map&lt;java.lang.String,java.util.Map&lt;java.lang.Object,java.lang.Object&gt;&gt; agentLogs</pre>
217<div class="block">map<key,value> where keys are the agent names. The values are the logs
218 returned by the agent through an <a href="../../../genius/core/events/AgentLogEvent.html" title="class in genius.core.events"><code>AgentLogEvent</code></a>.</div>
219</li>
220</ul>
221</li>
222</ul>
223<!-- ========= CONSTRUCTOR DETAIL ======== -->
224<ul class="blockList">
225<li class="blockList"><a name="constructor.detail">
226<!-- -->
227</a>
228<h3>Constructor Detail</h3>
229<a name="XmlLogger-java.io.OutputStream-java.lang.String-">
230<!-- -->
231</a>
232<ul class="blockListLast">
233<li class="blockList">
234<h4>XmlLogger</h4>
235<pre>public&nbsp;XmlLogger(java.io.OutputStream&nbsp;out,
236 java.lang.String&nbsp;topLabel)
237 throws java.io.FileNotFoundException,
238 javax.xml.stream.XMLStreamException</pre>
239<dl>
240<dt><span class="paramLabel">Parameters:</span></dt>
241<dd><code>out</code> - <code>OutputStream</code> to write the log to. If this is a file,
242 we recommend to use the extension ".xml". This logger becomes
243 owner of this outputstream and will close it eventually.</dd>
244<dd><code>topLabel</code> - the top level label to use in the output file</dd>
245<dt><span class="throwsLabel">Throws:</span></dt>
246<dd><code>java.io.FileNotFoundException</code></dd>
247<dd><code>javax.xml.stream.XMLStreamException</code></dd>
248</dl>
249</li>
250</ul>
251</li>
252</ul>
253<!-- ============ METHOD DETAIL ========== -->
254<ul class="blockList">
255<li class="blockList"><a name="method.detail">
256<!-- -->
257</a>
258<h3>Method Detail</h3>
259<a name="close--">
260<!-- -->
261</a>
262<ul class="blockList">
263<li class="blockList">
264<h4>close</h4>
265<pre>public&nbsp;void&nbsp;close()
266 throws java.io.IOException</pre>
267<dl>
268<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
269<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
270<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
271<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
272<dt><span class="throwsLabel">Throws:</span></dt>
273<dd><code>java.io.IOException</code></dd>
274</dl>
275</li>
276</ul>
277<a name="notifyChange-genius.core.events.NegotiationEvent-">
278<!-- -->
279</a>
280<ul class="blockListLast">
281<li class="blockList">
282<h4>notifyChange</h4>
283<pre>public&nbsp;void&nbsp;notifyChange(<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&nbsp;e)</pre>
284<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">Listener</a></code></span></div>
285<div class="block">a notification call that occurs when something changed. Consult the
286 parent object for details about this event.
287
288 <h1>NOTICE 1</h1> notifications run in the thread of the caller. The
289 caller will be blocked until this callback has been completed. It is
290 therfore good practice to handle callbacks quickly.
291
292 <h1>NOTICE 2</h1> Notifications often cross a thread sarety boundary. For
293 example when in MVC a model (typically thread safe) calls back a panel
294 (not thread safe). The called side (the panel) thus must handle the
295 callback in a thread safe manner, e.g. using
296 <code>SwingUtilities.invokeLater(Runnable)</code>. We recommend to avoid
297 synchronize as this will can block indefinitely (see notice 1) which
298 might lead to deadlocks.</div>
299<dl>
300<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
301<dd><code><a href="../../../genius/core/listener/Listener.html#notifyChange-T-">notifyChange</a></code>&nbsp;in interface&nbsp;<code><a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener">Listener</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;</code></dd>
302<dt><span class="paramLabel">Parameters:</span></dt>
303<dd><code>e</code> - additional data, typically the new value associated with the
304 event</dd>
305</dl>
306</li>
307</ul>
308</li>
309</ul>
310</li>
311</ul>
312</div>
313</div>
314<!-- ========= END OF CLASS DATA ========= -->
315<!-- ======= START OF BOTTOM NAVBAR ====== -->
316<div class="bottomNav"><a name="navbar.bottom">
317<!-- -->
318</a>
319<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
320<a name="navbar.bottom.firstrow">
321<!-- -->
322</a>
323<ul class="navList" title="Navigation">
324<li><a href="../../../overview-summary.html">Overview</a></li>
325<li><a href="package-summary.html">Package</a></li>
326<li class="navBarCell1Rev">Class</li>
327<li><a href="class-use/XmlLogger.html">Use</a></li>
328<li><a href="package-tree.html">Tree</a></li>
329<li><a href="../../../deprecated-list.html">Deprecated</a></li>
330<li><a href="../../../index-all.html">Index</a></li>
331<li><a href="../../../help-doc.html">Help</a></li>
332</ul>
333</div>
334<div class="subNav">
335<ul class="navList">
336<li><a href="../../../genius/core/logging/StatisticsLogger.html" title="class in genius.core.logging"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
337<li>Next&nbsp;Class</li>
338</ul>
339<ul class="navList">
340<li><a href="../../../index.html?genius/core/logging/XmlLogger.html" target="_top">Frames</a></li>
341<li><a href="XmlLogger.html" target="_top">No&nbsp;Frames</a></li>
342</ul>
343<ul class="navList" id="allclasses_navbar_bottom">
344<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
345</ul>
346<div>
347<script type="text/javascript"><!--
348 allClassesLink = document.getElementById("allclasses_navbar_bottom");
349 if(window==top) {
350 allClassesLink.style.display = "block";
351 }
352 else {
353 allClassesLink.style.display = "none";
354 }
355 //-->
356</script>
357</div>
358<div>
359<ul class="subNavList">
360<li>Summary:&nbsp;</li>
361<li>Nested&nbsp;|&nbsp;</li>
362<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
363<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
364<li><a href="#method.summary">Method</a></li>
365</ul>
366<ul class="subNavList">
367<li>Detail:&nbsp;</li>
368<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
369<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
370<li><a href="#method.detail">Method</a></li>
371</ul>
372</div>
373<a name="skip.navbar.bottom">
374<!-- -->
375</a></div>
376<!-- ======== END OF BOTTOM NAVBAR ======= -->
377</body>
378</html>
Note: See TracBrowser for help on using the repository browser.