source: javadoc/genius/core/parties/SessionsInfo.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: 17.8 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>SessionsInfo (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="SessionsInfo (Genius Core Documentation)";
16 }
17 }
18 catch(err) {
19 }
20//-->
21var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/SessionsInfo.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/parties/PartyWithUtility.html" title="interface in genius.core.parties"><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/parties/SessionsInfo.html" target="_top">Frames</a></li>
57<li><a href="SessionsInfo.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>Field&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>Field&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.parties</div>
96<h2 title="Class SessionsInfo" class="title">Class SessionsInfo</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.parties.SessionsInfo</li>
104</ul>
105</li>
106</ul>
107<div class="description">
108<ul class="blockList">
109<li class="blockList">
110<hr>
111<br>
112<pre>public class <span class="typeNameLabel">SessionsInfo</span>
113extends java.lang.Object</pre>
114<div class="block">immutable info for all sessions.</div>
115</li>
116</ul>
117</div>
118<div class="summary">
119<ul class="blockList">
120<li class="blockList">
121<!-- ======== CONSTRUCTOR SUMMARY ======== -->
122<ul class="blockList">
123<li class="blockList"><a name="constructor.summary">
124<!-- -->
125</a>
126<h3>Constructor Summary</h3>
127<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
128<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
129<tr>
130<th class="colOne" scope="col">Constructor and Description</th>
131</tr>
132<tr class="altColor">
133<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#SessionsInfo-genius.core.protocol.MultilateralProtocol-genius.core.persistent.PersistentDataType-boolean-">SessionsInfo</a></span>(<a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a>&nbsp;protocol,
134 <a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;type,
135 boolean&nbsp;isPrintEnabled)</code>&nbsp;</td>
136</tr>
137</table>
138</li>
139</ul>
140<!-- ========== METHOD SUMMARY =========== -->
141<ul class="blockList">
142<li class="blockList"><a name="method.summary">
143<!-- -->
144</a>
145<h3>Method Summary</h3>
146<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
147<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>
148<tr>
149<th class="colFirst" scope="col">Modifier and Type</th>
150<th class="colLast" scope="col">Method and Description</th>
151</tr>
152<tr id="i0" class="altColor">
153<td class="colFirst"><code>void</code></td>
154<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#close--">close</a></span>()</code>
155<div class="block">Closes the SessionsInfo: removes the tmp dir, deletes all saved files.</div>
156</td>
157</tr>
158<tr id="i1" class="rowColor">
159<td class="colFirst"><code>java.nio.file.Path</code></td>
160<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#getPath-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">getPath</a></span>(<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
161 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)</code>&nbsp;</td>
162</tr>
163<tr id="i2" class="altColor">
164<td class="colFirst"><code><a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a></code></td>
165<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#getPersistentDataType--">getPersistentDataType</a></span>()</code>&nbsp;</td>
166</tr>
167<tr id="i3" class="rowColor">
168<td class="colFirst"><code><a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a></code></td>
169<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#getProtocol--">getProtocol</a></span>()</code>&nbsp;</td>
170</tr>
171<tr id="i4" class="altColor">
172<td class="colFirst"><code>java.io.Serializable</code></td>
173<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#getStorage-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">getStorage</a></span>(<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
174 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)</code>
175<div class="block">Try to return the stored data for given [party,profile] pair.</div>
176</td>
177</tr>
178<tr id="i5" class="rowColor">
179<td class="colFirst"><code>boolean</code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#isPrintEnabled--">isPrintEnabled</a></span>()</code>
181<div class="block">True if print ot stdout is enabled.</div>
182</td>
183</tr>
184<tr id="i6" class="altColor">
185<td class="colFirst"><code>void</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/parties/SessionsInfo.html#saveStorage-java.io.Serializable-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">saveStorage</a></span>(java.io.Serializable&nbsp;content,
187 <a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
188 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)</code>
189<div class="block">saves provided storageMap to the storageDir.</div>
190</td>
191</tr>
192</table>
193<ul class="blockList">
194<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
195<!-- -->
196</a>
197<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
198<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
199</ul>
200</li>
201</ul>
202</li>
203</ul>
204</div>
205<div class="details">
206<ul class="blockList">
207<li class="blockList">
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209<ul class="blockList">
210<li class="blockList"><a name="constructor.detail">
211<!-- -->
212</a>
213<h3>Constructor Detail</h3>
214<a name="SessionsInfo-genius.core.protocol.MultilateralProtocol-genius.core.persistent.PersistentDataType-boolean-">
215<!-- -->
216</a>
217<ul class="blockListLast">
218<li class="blockList">
219<h4>SessionsInfo</h4>
220<pre>public&nbsp;SessionsInfo(<a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a>&nbsp;protocol,
221 <a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;type,
222 boolean&nbsp;isPrintEnabled)
223 throws java.io.IOException</pre>
224<dl>
225<dt><span class="throwsLabel">Throws:</span></dt>
226<dd><code>java.io.IOException</code></dd>
227</dl>
228</li>
229</ul>
230</li>
231</ul>
232<!-- ============ METHOD DETAIL ========== -->
233<ul class="blockList">
234<li class="blockList"><a name="method.detail">
235<!-- -->
236</a>
237<h3>Method Detail</h3>
238<a name="getStorage-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">
239<!-- -->
240</a>
241<ul class="blockList">
242<li class="blockList">
243<h4>getStorage</h4>
244<pre>public&nbsp;java.io.Serializable&nbsp;getStorage(<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
245 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)
246 throws java.lang.ClassNotFoundException,
247 java.io.IOException</pre>
248<div class="block">Try to return the stored data for given [party,profile] pair. If there is
249 no file we return null. If there is a deserialization error, we delete
250 the file and print an exception.</div>
251<dl>
252<dt><span class="paramLabel">Parameters:</span></dt>
253<dd><code>party</code> - the <a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository"><code>PartyRepItem</code></a></dd>
254<dd><code>profile</code> - the <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository"><code>ProfileRepItem</code></a></dd>
255<dt><span class="returnLabel">Returns:</span></dt>
256<dd>storage for given agent and profile.</dd>
257<dt><span class="throwsLabel">Throws:</span></dt>
258<dd><code>java.lang.ClassNotFoundException</code></dd>
259<dd><code>java.io.IOException</code></dd>
260</dl>
261</li>
262</ul>
263<a name="getPath-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">
264<!-- -->
265</a>
266<ul class="blockList">
267<li class="blockList">
268<h4>getPath</h4>
269<pre>public&nbsp;java.nio.file.Path&nbsp;getPath(<a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
270 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)</pre>
271<dl>
272<dt><span class="paramLabel">Parameters:</span></dt>
273<dd><code>party</code> - the <a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository"><code>PartyRepItem</code></a></dd>
274<dd><code>profile</code> - the <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository"><code>ProfileRepItem</code></a></dd>
275<dt><span class="returnLabel">Returns:</span></dt>
276<dd>the path to the temp file where the data is saved for given
277 agentID + profile</dd>
278</dl>
279</li>
280</ul>
281<a name="close--">
282<!-- -->
283</a>
284<ul class="blockList">
285<li class="blockList">
286<h4>close</h4>
287<pre>public&nbsp;void&nbsp;close()</pre>
288<div class="block">Closes the SessionsInfo: removes the tmp dir, deletes all saved files.
289 This SessionsInfo can not be used after calling this.</div>
290</li>
291</ul>
292<a name="saveStorage-java.io.Serializable-genius.core.repository.ParticipantRepItem-genius.core.repository.ProfileRepItem-">
293<!-- -->
294</a>
295<ul class="blockList">
296<li class="blockList">
297<h4>saveStorage</h4>
298<pre>public&nbsp;void&nbsp;saveStorage(java.io.Serializable&nbsp;content,
299 <a href="../../../genius/core/repository/ParticipantRepItem.html" title="class in genius.core.repository">ParticipantRepItem</a>&nbsp;party,
300 <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository">ProfileRepItem</a>&nbsp;profile)
301 throws java.io.IOException</pre>
302<div class="block">saves provided storageMap to the storageDir. The storageMap is just
303 removed from disk if it's empty.</div>
304<dl>
305<dt><span class="paramLabel">Parameters:</span></dt>
306<dd><code>content</code> - the data to save. If null, the old data is removed but no
307 'null' object is saved.</dd>
308<dd><code>party</code> - the <a href="../../../genius/core/repository/PartyRepItem.html" title="class in genius.core.repository"><code>PartyRepItem</code></a></dd>
309<dd><code>profile</code> - the <a href="../../../genius/core/repository/ProfileRepItem.html" title="class in genius.core.repository"><code>ProfileRepItem</code></a></dd>
310<dt><span class="throwsLabel">Throws:</span></dt>
311<dd><code>java.io.IOException</code></dd>
312</dl>
313</li>
314</ul>
315<a name="getProtocol--">
316<!-- -->
317</a>
318<ul class="blockList">
319<li class="blockList">
320<h4>getProtocol</h4>
321<pre>public&nbsp;<a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol">MultilateralProtocol</a>&nbsp;getProtocol()</pre>
322</li>
323</ul>
324<a name="getPersistentDataType--">
325<!-- -->
326</a>
327<ul class="blockList">
328<li class="blockList">
329<h4>getPersistentDataType</h4>
330<pre>public&nbsp;<a href="../../../genius/core/persistent/PersistentDataType.html" title="enum in genius.core.persistent">PersistentDataType</a>&nbsp;getPersistentDataType()</pre>
331</li>
332</ul>
333<a name="isPrintEnabled--">
334<!-- -->
335</a>
336<ul class="blockListLast">
337<li class="blockList">
338<h4>isPrintEnabled</h4>
339<pre>public&nbsp;boolean&nbsp;isPrintEnabled()</pre>
340<div class="block">True if print ot stdout is enabled.</div>
341<dl>
342<dt><span class="returnLabel">Returns:</span></dt>
343</dl>
344</li>
345</ul>
346</li>
347</ul>
348</li>
349</ul>
350</div>
351</div>
352<!-- ========= END OF CLASS DATA ========= -->
353<!-- ======= START OF BOTTOM NAVBAR ====== -->
354<div class="bottomNav"><a name="navbar.bottom">
355<!-- -->
356</a>
357<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
358<a name="navbar.bottom.firstrow">
359<!-- -->
360</a>
361<ul class="navList" title="Navigation">
362<li><a href="../../../overview-summary.html">Overview</a></li>
363<li><a href="package-summary.html">Package</a></li>
364<li class="navBarCell1Rev">Class</li>
365<li><a href="class-use/SessionsInfo.html">Use</a></li>
366<li><a href="package-tree.html">Tree</a></li>
367<li><a href="../../../deprecated-list.html">Deprecated</a></li>
368<li><a href="../../../index-all.html">Index</a></li>
369<li><a href="../../../help-doc.html">Help</a></li>
370</ul>
371</div>
372<div class="subNav">
373<ul class="navList">
374<li><a href="../../../genius/core/parties/PartyWithUtility.html" title="interface in genius.core.parties"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
375<li>Next&nbsp;Class</li>
376</ul>
377<ul class="navList">
378<li><a href="../../../index.html?genius/core/parties/SessionsInfo.html" target="_top">Frames</a></li>
379<li><a href="SessionsInfo.html" target="_top">No&nbsp;Frames</a></li>
380</ul>
381<ul class="navList" id="allclasses_navbar_bottom">
382<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
383</ul>
384<div>
385<script type="text/javascript"><!--
386 allClassesLink = document.getElementById("allclasses_navbar_bottom");
387 if(window==top) {
388 allClassesLink.style.display = "block";
389 }
390 else {
391 allClassesLink.style.display = "none";
392 }
393 //-->
394</script>
395</div>
396<div>
397<ul class="subNavList">
398<li>Summary:&nbsp;</li>
399<li>Nested&nbsp;|&nbsp;</li>
400<li>Field&nbsp;|&nbsp;</li>
401<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
402<li><a href="#method.summary">Method</a></li>
403</ul>
404<ul class="subNavList">
405<li>Detail:&nbsp;</li>
406<li>Field&nbsp;|&nbsp;</li>
407<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
408<li><a href="#method.detail">Method</a></li>
409</ul>
410</div>
411<a name="skip.navbar.bottom">
412<!-- -->
413</a></div>
414<!-- ======== END OF BOTTOM NAVBAR ======= -->
415</body>
416</html>
Note: See TracBrowser for help on using the repository browser.