Plan/all/com/djrapitops/plan/delivery/webserver/auth/ActiveCookieStore.html

459 lines
17 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML>
2020-06-21 19:24:04 +02:00
<!-- NewPage -->
<html lang="en">
2020-06-21 19:24:04 +02:00
<head>
<!-- Generated by javadoc -->
<title>ActiveCookieStore (Plan 5.2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2020-06-21 19:24:04 +02:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery/jquery-ui.css" title="Style">
2020-06-21 19:24:04 +02:00
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../jquery/jquery-ui.js"></script>
2020-06-21 19:24:04 +02:00
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ActiveCookieStore (Plan 5.2-SNAPSHOT API)";
2020-06-21 19:24:04 +02:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
2020-06-21 19:24:04 +02:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
2020-06-21 19:24:04 +02:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
2020-06-21 19:24:04 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
2020-06-21 19:24:04 +02:00
<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" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
2020-06-21 19:24:04 +02:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-06-21 19:24:04 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
2020-06-21 19:24:04 +02:00
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
2020-06-21 19:24:04 +02:00
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
2020-06-21 19:24:04 +02:00
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
2020-06-21 19:24:04 +02:00
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
2020-06-21 19:24:04 +02:00
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.delivery.webserver.auth</a></div>
2020-06-21 19:24:04 +02:00
<h2 title="Class ActiveCookieStore" class="title">Class ActiveCookieStore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.webserver.auth.ActiveCookieStore</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
2020-06-21 19:24:04 +02:00
<hr>
<pre>@Singleton
public class <span class="typeNameLabel">ActiveCookieStore</span>
extends java.lang.Object
implements <a href="../../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></pre>
2020-06-21 19:24:04 +02:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cookieExpiresAfter">cookieExpiresAfter</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,net.playeranalytics.plugin.scheduling.RunnableFactory,com.djrapitops.plan.processing.Processing)">ActiveCookieStore</a></span>&#8203;(<a href="../../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../../../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
net.playeranalytics.plugin.scheduling.RunnableFactory&nbsp;runnableFactory,
<a href="../../../processing/Processing.html" title="class in com.djrapitops.plan.processing">Processing</a>&nbsp;processing)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
2020-06-21 19:24:04 +02:00
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
2020-06-21 19:24:04 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.summary">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>
2020-06-21 19:24:04 +02:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2020-06-21 19:24:04 +02:00
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../../domain/auth/User.html" title="class in com.djrapitops.plan.delivery.domain.auth">User</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkCookie(java.lang.String)">checkCookie</a></span>&#8203;(java.lang.String&nbsp;cookie)</code></th>
<td class="colLast">&nbsp;</td>
2020-06-21 19:24:04 +02:00
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#disable()">disable</a></span>()</code></th>
<td class="colLast">
<div class="block">Performs disable actions for the subsystem</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enable()">enable</a></span>()</code></th>
<td class="colLast">
<div class="block">Performs enable actions for the subsystem.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#generateNewCookie(com.djrapitops.plan.delivery.domain.auth.User)">generateNewCookie</a></span>&#8203;(<a href="../../domain/auth/User.html" title="class in com.djrapitops.plan.delivery.domain.auth">User</a>&nbsp;user)</code></th>
<td class="colLast">&nbsp;</td>
2020-06-21 19:24:04 +02:00
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeAll()">removeAll</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
2020-06-21 19:24:04 +02:00
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeCookie(java.lang.String)">removeCookie</a></span>&#8203;(java.lang.String&nbsp;cookie)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
2020-06-21 19:24:04 +02:00
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeUserCookie(java.lang.String)">removeUserCookie</a></span>&#8203;(java.lang.String&nbsp;username)</code></th>
<td class="colLast">&nbsp;</td>
2020-06-21 19:24:04 +02:00
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
2020-06-21 19:24:04 +02:00
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="cookieExpiresAfter">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cookieExpiresAfter</h4>
<pre>public static&nbsp;long cookieExpiresAfter</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,net.playeranalytics.plugin.scheduling.RunnableFactory,com.djrapitops.plan.processing.Processing)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ActiveCookieStore</h4>
<pre>@Inject
public&nbsp;ActiveCookieStore&#8203;(<a href="../../../settings/config/PlanConfig.html" title="class in com.djrapitops.plan.settings.config">PlanConfig</a>&nbsp;config,
<a href="../../../storage/database/DBSystem.html" title="class in com.djrapitops.plan.storage.database">DBSystem</a>&nbsp;dbSystem,
net.playeranalytics.plugin.scheduling.RunnableFactory&nbsp;runnableFactory,
<a href="../../../processing/Processing.html" title="class in com.djrapitops.plan.processing">Processing</a>&nbsp;processing)</pre>
</li>
</ul>
</li>
</ul>
</section>
2020-06-21 19:24:04 +02:00
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
2020-06-21 19:24:04 +02:00
<ul class="blockList">
<li class="blockList"><a id="method.detail">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="removeUserCookie(java.lang.String)">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeUserCookie</h4>
<pre class="methodSignature">public static&nbsp;void&nbsp;removeUserCookie&#8203;(java.lang.String&nbsp;username)</pre>
2020-06-21 19:24:04 +02:00
</li>
</ul>
<a id="enable()">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../SubSystem.html#enable()">SubSystem</a></code></span></div>
<div class="block">Performs enable actions for the subsystem.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../SubSystem.html#enable()">enable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
2020-06-21 19:24:04 +02:00
</li>
</ul>
<a id="disable()">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;disable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../SubSystem.html#disable()">SubSystem</a></code></span></div>
<div class="block">Performs disable actions for the subsystem</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../SubSystem.html#disable()">disable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../SubSystem.html" title="interface in com.djrapitops.plan">SubSystem</a></code></dd>
</dl>
2020-06-21 19:24:04 +02:00
</li>
</ul>
<a id="checkCookie(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkCookie</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;<a href="../../domain/auth/User.html" title="class in com.djrapitops.plan.delivery.domain.auth">User</a>&gt;&nbsp;checkCookie&#8203;(java.lang.String&nbsp;cookie)</pre>
</li>
</ul>
<a id="generateNewCookie(com.djrapitops.plan.delivery.domain.auth.User)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateNewCookie</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;generateNewCookie&#8203;(<a href="../../domain/auth/User.html" title="class in com.djrapitops.plan.delivery.domain.auth">User</a>&nbsp;user)</pre>
</li>
</ul>
<a id="removeCookie(java.lang.String)">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="blockList">
2020-06-21 19:24:04 +02:00
<li class="blockList">
<h4>removeCookie</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeCookie&#8203;(java.lang.String&nbsp;cookie)</pre>
2020-06-21 19:24:04 +02:00
</li>
</ul>
<a id="removeAll()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeAll</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;removeAll()</pre>
</li>
</ul>
2020-06-21 19:24:04 +02:00
</li>
</ul>
</section>
2020-06-21 19:24:04 +02:00
</li>
</ul>
</div>
</div>
</main>
2020-06-21 19:24:04 +02:00
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
2020-06-21 19:24:04 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
2020-06-21 19:24:04 +02:00
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
2020-06-21 19:24:04 +02:00
<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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses.html">All&nbsp;Classes</a></li>
2020-06-21 19:24:04 +02:00
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2020-06-21 19:24:04 +02:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
2020-06-21 19:24:04 +02:00
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
2020-06-21 19:24:04 +02:00
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
2020-06-21 19:24:04 +02:00
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
2020-06-21 19:24:04 +02:00
</body>
</html>