source: javadoc/genius/core/session/SessionManager.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: 15.0 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:58 CEST 2018 -->
6<title>SessionManager (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="SessionManager (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/SessionManager.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/session/SessionConfiguration.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53<li><a href="../../../genius/core/session/TournamentManager.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54</ul>
55<ul class="navList">
56<li><a href="../../../index.html?genius/core/session/SessionManager.html" target="_top">Frames</a></li>
57<li><a href="SessionManager.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.session</div>
96<h2 title="Class SessionManager" class="title">Class SessionManager</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><a href="../../../genius/core/listener/DefaultListenable.html" title="class in genius.core.listener">genius.core.listener.DefaultListenable</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;</li>
104<li>
105<ul class="inheritance">
106<li>genius.core.session.SessionManager</li>
107</ul>
108</li>
109</ul>
110</li>
111</ul>
112<div class="description">
113<ul class="blockList">
114<li class="blockList">
115<dl>
116<dt>All Implemented Interfaces:</dt>
117<dd><a href="../../../genius/core/listener/Listenable.html" title="interface in genius.core.listener">Listenable</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;, java.lang.Runnable</dd>
118</dl>
119<hr>
120<br>
121<pre>public class <span class="typeNameLabel">SessionManager</span>
122extends <a href="../../../genius/core/listener/DefaultListenable.html" title="class in genius.core.listener">DefaultListenable</a>&lt;<a href="../../../genius/core/events/NegotiationEvent.html" title="interface in genius.core.events">NegotiationEvent</a>&gt;
123implements java.lang.Runnable</pre>
124<div class="block">The <a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><code>SessionManager</code></a> is responsible for enforcing the
125 <a href="../../../genius/core/protocol/MultilateralProtocol.html" title="interface in genius.core.protocol"><code>MultilateralProtocol</code></a> during the <a href="../../../genius/core/session/Session.html" title="class in genius.core.session"><code>Session</code></a>. This is the entry
126 point for the negotiation algorithm. The protocol and session parameters are
127 passed on from the GUI.
128
129 This logs all events to the <a href="../../../genius/core/listener/Listener.html" title="interface in genius.core.listener"><code>Listener</code></a>. You need to subscribe to hear
130 the log events, eg for display or for writing to file.</div>
131<dl>
132<dt><span class="simpleTagLabel">Author:</span></dt>
133<dd>David Festen</dd>
134</dl>
135</li>
136</ul>
137</div>
138<div class="summary">
139<ul class="blockList">
140<li class="blockList">
141<!-- ======== CONSTRUCTOR SUMMARY ======== -->
142<ul class="blockList">
143<li class="blockList"><a name="constructor.summary">
144<!-- -->
145</a>
146<h3>Constructor Summary</h3>
147<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
148<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
149<tr>
150<th class="colOne" scope="col">Constructor and Description</th>
151</tr>
152<tr class="altColor">
153<td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionManager.html#SessionManager-genius.core.session.SessionConfiguration-java.util.List-genius.core.session.Session-genius.core.session.ExecutorWithTimeout-">SessionManager</a></span>(<a href="../../../genius/core/session/SessionConfiguration.html" title="class in genius.core.session">SessionConfiguration</a>&nbsp;config,
154 java.util.List&lt;<a href="../../../genius/core/parties/NegotiationPartyInternal.html" title="class in genius.core.parties">NegotiationPartyInternal</a>&gt;&nbsp;theparties,
155 <a href="../../../genius/core/session/Session.html" title="class in genius.core.session">Session</a>&nbsp;session,
156 <a href="../../../genius/core/session/ExecutorWithTimeout.html" title="class in genius.core.session">ExecutorWithTimeout</a>&nbsp;exec)</code>
157<div class="block">Initializes a new instance of the <a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><code>SessionManager</code></a> object.</div>
158</td>
159</tr>
160</table>
161</li>
162</ul>
163<!-- ========== METHOD SUMMARY =========== -->
164<ul class="blockList">
165<li class="blockList"><a name="method.summary">
166<!-- -->
167</a>
168<h3>Method Summary</h3>
169<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
170<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>
171<tr>
172<th class="colFirst" scope="col">Modifier and Type</th>
173<th class="colLast" scope="col">Method and Description</th>
174</tr>
175<tr id="i0" class="altColor">
176<td class="colFirst"><code>void</code></td>
177<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionManager.html#run--">run</a></span>()</code>
178<div class="block">Run and wait for completion.</div>
179</td>
180</tr>
181<tr id="i1" class="rowColor">
182<td class="colFirst"><code>void</code></td>
183<td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/session/SessionManager.html#runAndWait--">runAndWait</a></span>()</code>
184<div class="block">Runs the negotiation session and wait for it to complete.</div>
185</td>
186</tr>
187</table>
188<ul class="blockList">
189<li class="blockList"><a name="methods.inherited.from.class.genius.core.listener.DefaultListenable">
190<!-- -->
191</a>
192<h3>Methods inherited from class&nbsp;genius.core.listener.<a href="../../../genius/core/listener/DefaultListenable.html" title="class in genius.core.listener">DefaultListenable</a></h3>
193<code><a href="../../../genius/core/listener/DefaultListenable.html#addListener-genius.core.listener.Listener-">addListener</a>, <a href="../../../genius/core/listener/DefaultListenable.html#notifyChange-TYPE-">notifyChange</a>, <a href="../../../genius/core/listener/DefaultListenable.html#removeListener-genius.core.listener.Listener-">removeListener</a></code></li>
194</ul>
195<ul class="blockList">
196<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
197<!-- -->
198</a>
199<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
200<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
201</ul>
202</li>
203</ul>
204</li>
205</ul>
206</div>
207<div class="details">
208<ul class="blockList">
209<li class="blockList">
210<!-- ========= CONSTRUCTOR DETAIL ======== -->
211<ul class="blockList">
212<li class="blockList"><a name="constructor.detail">
213<!-- -->
214</a>
215<h3>Constructor Detail</h3>
216<a name="SessionManager-genius.core.session.SessionConfiguration-java.util.List-genius.core.session.Session-genius.core.session.ExecutorWithTimeout-">
217<!-- -->
218</a>
219<ul class="blockListLast">
220<li class="blockList">
221<h4>SessionManager</h4>
222<pre>public&nbsp;SessionManager(<a href="../../../genius/core/session/SessionConfiguration.html" title="class in genius.core.session">SessionConfiguration</a>&nbsp;config,
223 java.util.List&lt;<a href="../../../genius/core/parties/NegotiationPartyInternal.html" title="class in genius.core.parties">NegotiationPartyInternal</a>&gt;&nbsp;theparties,
224 <a href="../../../genius/core/session/Session.html" title="class in genius.core.session">Session</a>&nbsp;session,
225 <a href="../../../genius/core/session/ExecutorWithTimeout.html" title="class in genius.core.session">ExecutorWithTimeout</a>&nbsp;exec)</pre>
226<div class="block">Initializes a new instance of the <a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><code>SessionManager</code></a> object. After
227 initialization this <a href="../../../genius/core/session/SessionManager.html" title="class in genius.core.session"><code>SessionManager</code></a> can be <a href="../../../genius/core/session/SessionManager.html#run--"><code>run()</code></a>.</div>
228<dl>
229<dt><span class="paramLabel">Parameters:</span></dt>
230<dd><code>theparties</code> - The parties to use in this session (including agents and
231 optionally mediators)</dd>
232<dd><code>session</code> - A session object containing preset information (can also be a
233 new instance)</dd>
234<dd><code>exec</code> - the executor to use when running</dd>
235</dl>
236</li>
237</ul>
238</li>
239</ul>
240<!-- ============ METHOD DETAIL ========== -->
241<ul class="blockList">
242<li class="blockList"><a name="method.detail">
243<!-- -->
244</a>
245<h3>Method Detail</h3>
246<a name="run--">
247<!-- -->
248</a>
249<ul class="blockList">
250<li class="blockList">
251<h4>run</h4>
252<pre>public&nbsp;void&nbsp;run()</pre>
253<div class="block">Run and wait for completion. Can be used from a thread. Throws from the
254 underlying call are wrapped in a <code>RuntimeException</code> because
255 <a href="../../../genius/core/session/SessionManager.html#run--"><code>run()</code></a> doesn't allow throwing checked exceptions.</div>
256<dl>
257<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
258<dd><code>run</code>&nbsp;in interface&nbsp;<code>java.lang.Runnable</code></dd>
259</dl>
260</li>
261</ul>
262<a name="runAndWait--">
263<!-- -->
264</a>
265<ul class="blockListLast">
266<li class="blockList">
267<h4>runAndWait</h4>
268<pre>public&nbsp;void&nbsp;runAndWait()</pre>
269<div class="block">Runs the negotiation session and wait for it to complete. After the run
270 (or failure) of the session the listeners are notified. All events,
271 success and errors are reported to the listeners. Should not throw any
272 checked exceptions.</div>
273</li>
274</ul>
275</li>
276</ul>
277</li>
278</ul>
279</div>
280</div>
281<!-- ========= END OF CLASS DATA ========= -->
282<!-- ======= START OF BOTTOM NAVBAR ====== -->
283<div class="bottomNav"><a name="navbar.bottom">
284<!-- -->
285</a>
286<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
287<a name="navbar.bottom.firstrow">
288<!-- -->
289</a>
290<ul class="navList" title="Navigation">
291<li><a href="../../../overview-summary.html">Overview</a></li>
292<li><a href="package-summary.html">Package</a></li>
293<li class="navBarCell1Rev">Class</li>
294<li><a href="class-use/SessionManager.html">Use</a></li>
295<li><a href="package-tree.html">Tree</a></li>
296<li><a href="../../../deprecated-list.html">Deprecated</a></li>
297<li><a href="../../../index-all.html">Index</a></li>
298<li><a href="../../../help-doc.html">Help</a></li>
299</ul>
300</div>
301<div class="subNav">
302<ul class="navList">
303<li><a href="../../../genius/core/session/SessionConfiguration.html" title="class in genius.core.session"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
304<li><a href="../../../genius/core/session/TournamentManager.html" title="class in genius.core.session"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
305</ul>
306<ul class="navList">
307<li><a href="../../../index.html?genius/core/session/SessionManager.html" target="_top">Frames</a></li>
308<li><a href="SessionManager.html" target="_top">No&nbsp;Frames</a></li>
309</ul>
310<ul class="navList" id="allclasses_navbar_bottom">
311<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
312</ul>
313<div>
314<script type="text/javascript"><!--
315 allClassesLink = document.getElementById("allclasses_navbar_bottom");
316 if(window==top) {
317 allClassesLink.style.display = "block";
318 }
319 else {
320 allClassesLink.style.display = "none";
321 }
322 //-->
323</script>
324</div>
325<div>
326<ul class="subNavList">
327<li>Summary:&nbsp;</li>
328<li>Nested&nbsp;|&nbsp;</li>
329<li>Field&nbsp;|&nbsp;</li>
330<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
331<li><a href="#method.summary">Method</a></li>
332</ul>
333<ul class="subNavList">
334<li>Detail:&nbsp;</li>
335<li>Field&nbsp;|&nbsp;</li>
336<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
337<li><a href="#method.detail">Method</a></li>
338</ul>
339</div>
340<a name="skip.navbar.bottom">
341<!-- -->
342</a></div>
343<!-- ======== END OF BOTTOM NAVBAR ======= -->
344</body>
345</html>
Note: See TracBrowser for help on using the repository browser.