Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-02 00:39:34 +01:00
Code Issues Projects Releases Wiki Activity
d8b4c347ba
Plan/all/com/djrapitops/plan/delivery/webserver/resolver/json/QueryJSONResolver.html

378 lines
18 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ plan-player-analytics/Plan@a4e2c24dae52e88c713121abf82d3a1dea3395f9 🚀
2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
Deploying to gh-pages from @ plan-player-analytics/Plan@e90606b68afe6b624bd2ae04f7c6a4e71f1225a8 🚀
2021-06-12 09:24:49 +02:00
<title>QueryJSONResolver (Plan 5.4-SNAPSHOT API)</title>
Deploying to gh-pages from @ plan-player-analytics/Plan@a4e2c24dae52e88c713121abf82d3a1dea3395f9 🚀
2021-03-10 09:12:21 +01:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<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>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
Deploying to gh-pages from @ plan-player-analytics/Plan@e90606b68afe6b624bd2ae04f7c6a4e71f1225a8 🚀
2021-06-12 09:24:49 +02:00
parent.document.title="QueryJSONResolver (Plan 5.4-SNAPSHOT API)";
Deploying to gh-pages from @ plan-player-analytics/Plan@a4e2c24dae52e88c713121abf82d3a1dea3395f9 🚀
2021-03-10 09:12:21 +01:00
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.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" 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>
</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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</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>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.djrapitops.plan.delivery.webserver.resolver.json</a></div>
<h2 title="Class QueryJSONResolver" class="title">Class QueryJSONResolver</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.djrapitops.plan.delivery.webserver.resolver.json.QueryJSONResolver</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../../../web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></code></dd>
</dl>
<hr>
<pre>@Singleton
public class <span class="typeNameLabel">QueryJSONResolver</span>
extends java.lang.Object
implements <a href="../../../web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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.storage.database.queries.filter.QueryFilters,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.delivery.webserver.cache.JSONStorage,com.djrapitops.plan.delivery.rendering.json.graphs.GraphJSONCreator,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.delivery.formatting.Formatters)">QueryJSONResolver</a></span>&#8203;(<a href="../../../../storage/database/queries/filter/QueryFilters.html" title="class in com.djrapitops.plan.storage.database.queries.filter">QueryFilters</a>&nbsp;filters,
<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,
<a href="../../../../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo,
<a href="../../cache/JSONStorage.html" title="interface in com.djrapitops.plan.delivery.webserver.cache">JSONStorage</a>&nbsp;jsonStorage,
<a href="../../../rendering/json/graphs/GraphJSONCreator.html" title="class in com.djrapitops.plan.delivery.rendering.json.graphs">GraphJSONCreator</a>&nbsp;graphJSONCreator,
<a href="../../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="../../../formatting/Formatters.html" title="class in com.djrapitops.plan.delivery.formatting">Formatters</a>&nbsp;formatters)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</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="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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)">canAccess</a></span>&#8203;(<a href="../../../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Implement access control if authorization is enabled.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Optional&lt;<a href="../../../web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)">resolve</a></span>&#8203;(<a href="../../../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block">Implement request resolution.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.djrapitops.plan.delivery.web.resolver.Resolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;com.djrapitops.plan.delivery.web.resolver.<a href="../../../web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></h3>
<code><a href="../../../web/resolver/Resolver.html#newResponseBuilder()">newResponseBuilder</a>, <a href="../../../web/resolver/Resolver.html#requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)">requiresAuth</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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.storage.database.queries.filter.QueryFilters,com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,com.djrapitops.plan.identification.ServerInfo,com.djrapitops.plan.delivery.webserver.cache.JSONStorage,com.djrapitops.plan.delivery.rendering.json.graphs.GraphJSONCreator,com.djrapitops.plan.settings.locale.Locale,com.djrapitops.plan.delivery.formatting.Formatters)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>QueryJSONResolver</h4>
<pre>@Inject
public&nbsp;QueryJSONResolver&#8203;(<a href="../../../../storage/database/queries/filter/QueryFilters.html" title="class in com.djrapitops.plan.storage.database.queries.filter">QueryFilters</a>&nbsp;filters,
<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,
<a href="../../../../identification/ServerInfo.html" title="class in com.djrapitops.plan.identification">ServerInfo</a>&nbsp;serverInfo,
<a href="../../cache/JSONStorage.html" title="interface in com.djrapitops.plan.delivery.webserver.cache">JSONStorage</a>&nbsp;jsonStorage,
<a href="../../../rendering/json/graphs/GraphJSONCreator.html" title="class in com.djrapitops.plan.delivery.rendering.json.graphs">GraphJSONCreator</a>&nbsp;graphJSONCreator,
<a href="../../../../settings/locale/Locale.html" title="class in com.djrapitops.plan.settings.locale">Locale</a>&nbsp;locale,
<a href="../../../formatting/Formatters.html" title="class in com.djrapitops.plan.delivery.formatting">Formatters</a>&nbsp;formatters)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canAccess</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canAccess&#8203;(<a href="../../../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../web/resolver/Resolver.html#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)">Resolver</a></code></span></div>
<div class="block">Implement access control if authorization is enabled.
<p>
Is not called when access control is not active.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../web/resolver/Resolver.html#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)">canAccess</a></code>&nbsp;in interface&nbsp;<code><a href="../../../web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - HTTP request, contains all information necessary to check access.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if allowed or invalid target, false if response should be 403 (forbidden)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../web/resolver/request/Request.html#getUser()"><code>for that has access permissions.</code></a></dd>
</dl>
</li>
</ul>
<a id="resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>resolve</h4>
<pre class="methodSignature">public&nbsp;java.util.Optional&lt;<a href="../../../web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>&gt;&nbsp;resolve&#8203;(<a href="../../../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../web/resolver/Resolver.html#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)">Resolver</a></code></span></div>
<div class="block">Implement request resolution.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../web/resolver/Resolver.html#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)">resolve</a></code>&nbsp;in interface&nbsp;<code><a href="../../../web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - HTTP request, contains all information necessary to resolve the request.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Response or empty if the response should be 404 (not found).</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>for return value</code></a>,
<a href="../../../web/resolver/request/Request.html#getPath()"><code>for path /example/path etc</code></a>,
<a href="../../../web/resolver/request/Request.html#getQuery()"><code>for parameters ?param=value etc</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in New Issue Copy Permalink