mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
384 lines
15 KiB
HTML
384 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="fi">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_201) on Mon Aug 05 12:13:15 EEST 2019 -->
|
|
<title>SessionCache (Plan 4.9.1 API)</title>
|
|
<meta name="date" content="2019-08-05">
|
|
<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="SessionCache (Plan 4.9.1 API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":9,"i2":10,"i3":9,"i4":9,"i5":9,"i6":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="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="../../../../../com/djrapitops/plan/system/cache/NicknameCache.html" title="class in com.djrapitops.plan.system.cache"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/djrapitops/plan/system/cache/SessionCache.html" target="_top">Frames</a></li>
|
|
<li><a href="SessionCache.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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">com.djrapitops.plan.system.cache</div>
|
|
<h2 title="Class SessionCache" class="title">Class SessionCache</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.djrapitops.plan.system.cache.SessionCache</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>@Singleton
|
|
public class <span class="typeNameLabel">SessionCache</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">This class is used to store active sessions of players in memory.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== 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"> </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="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#SessionCache--">SessionCache</a></span>()</code> </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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#cacheSession-java.util.UUID-com.djrapitops.plan.data.container.Session-">cacheSession</a></span>(java.util.UUID playerUUID,
|
|
<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a> session)</code>
|
|
<div class="block">Cache a new session.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#clear--">clear</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#endSession-java.util.UUID-long-">endSession</a></span>(java.util.UUID playerUUID,
|
|
long time)</code>
|
|
<div class="block">End a session and save it to database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>static java.util.Map<java.util.UUID,<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#getActiveSessions--">getActiveSessions</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>static java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#getCachedSession-java.util.UUID-">getCachedSession</a></span>(java.util.UUID playerUUID)</code>
|
|
<div class="block">Used to get the Session of the player in the sessionCache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#refreshActiveSessionsState--">refreshActiveSessionsState</a></span>()</code> </td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/djrapitops/plan/system/cache/SessionCache.html#removeSessionFromCache-java.util.UUID-">removeSessionFromCache</a></span>(java.util.UUID playerUUID)</code> </td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SessionCache--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SessionCache</h4>
|
|
<pre>@Inject
|
|
public SessionCache()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getActiveSessions--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getActiveSessions</h4>
|
|
<pre>public static java.util.Map<java.util.UUID,<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>> getActiveSessions()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="clear--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>clear</h4>
|
|
<pre>public static void clear()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="refreshActiveSessionsState--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>refreshActiveSessionsState</h4>
|
|
<pre>public static void refreshActiveSessionsState()</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="getCachedSession-java.util.UUID-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCachedSession</h4>
|
|
<pre>public static java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>> getCachedSession(java.util.UUID playerUUID)</pre>
|
|
<div class="block">Used to get the Session of the player in the sessionCache.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Optional with the session inside it if found.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="cacheSession-java.util.UUID-com.djrapitops.plan.data.container.Session-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>cacheSession</h4>
|
|
<pre>public java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>> cacheSession(java.util.UUID playerUUID,
|
|
<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a> session)</pre>
|
|
<div class="block">Cache a new session.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player</dd>
|
|
<dd><code>session</code> - Session to cache.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Optional: previous session. Recipients of this object should decide if it needs to be saved.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="endSession-java.util.UUID-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>endSession</h4>
|
|
<pre>public java.util.Optional<<a href="../../../../../com/djrapitops/plan/data/container/Session.html" title="class in com.djrapitops.plan.data.container">Session</a>> endSession(java.util.UUID playerUUID,
|
|
long time)</pre>
|
|
<div class="block">End a session and save it to database.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>playerUUID</code> - UUID of the player.</dd>
|
|
<dd><code>time</code> - Time the session ended.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Optional: ended session. Recipients of this object should decide if it needs to be saved.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeSessionFromCache-java.util.UUID-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>removeSessionFromCache</h4>
|
|
<pre>protected void removeSessionFromCache(java.util.UUID playerUUID)</pre>
|
|
</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="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="../../../../../com/djrapitops/plan/system/cache/NicknameCache.html" title="class in com.djrapitops.plan.system.cache"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/djrapitops/plan/system/cache/SessionCache.html" target="_top">Frames</a></li>
|
|
<li><a href="SessionCache.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|