mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
329 lines
16 KiB
HTML
329 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc -->
|
|
<title>Resolver (Plan 5.3-SNAPSHOT API)</title>
|
|
<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) {
|
|
parent.document.title="Resolver (Plan 5.3-SNAPSHOT API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":6,"i1":18,"i2":18,"i3":6};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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"> </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> <a href="package-summary.html">com.djrapitops.plan.delivery.web.resolver</a></div>
|
|
<h2 title="Interface Resolver" class="title">Interface Resolver</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Subinterfaces:</dt>
|
|
<dd><code><a href="NoAuthResolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">NoAuthResolver</a></code></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="CompositeResolver.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver</a></code>, <code><a href="../../webserver/resolver/json/FiltersJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">FiltersJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/GraphsJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">GraphsJSONResolver</a></code>, <code><a href="../../webserver/resolver/auth/LoginPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginPageResolver</a></code>, <code><a href="../../webserver/resolver/auth/LoginResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginResolver</a></code>, <code><a href="../../webserver/resolver/auth/LogoutResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LogoutResolver</a></code>, <code><a href="../../webserver/resolver/json/NetworkTabJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">NetworkTabJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/PlayerJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">PlayerJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/PlayerKillsJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">PlayerKillsJSONResolver</a></code>, <code><a href="../../webserver/resolver/PlayerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayerPageResolver</a></code>, <code><a href="../../webserver/resolver/PlayersPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayersPageResolver</a></code>, <code><a href="../../webserver/resolver/json/PlayersTableJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">PlayersTableJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/QueryJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">QueryJSONResolver</a></code>, <code><a href="../../webserver/resolver/QueryPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">QueryPageResolver</a></code>, <code><a href="../../webserver/resolver/auth/RegisterPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterPageResolver</a></code>, <code><a href="../../webserver/resolver/auth/RegisterResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterResolver</a></code>, <code><a href="../../webserver/resolver/RootPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">RootPageResolver</a></code>, <code><a href="../../webserver/resolver/ServerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ServerPageResolver</a></code>, <code><a href="../../webserver/resolver/json/ServerTabJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">ServerTabJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/SessionsJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">SessionsJSONResolver</a></code>, <code><a href="../../webserver/resolver/StaticResourceResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">StaticResourceResolver</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public interface <span class="typeNameLabel">Resolver</span></pre>
|
|
<div class="block">Interface for resolving requests of Plan webserver.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="NoAuthResolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>if resource is always accessible regardless of user.</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </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>​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> 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>default <a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newResponseBuilder()">newResponseBuilder</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>default boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)">requiresAuth</a></span>​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>java.util.Optional<<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>></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>​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Implement request resolution.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ 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">boolean canAccess​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</pre>
|
|
<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="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="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="blockList">
|
|
<li class="blockList">
|
|
<h4>resolve</h4>
|
|
<pre class="methodSignature">java.util.Optional<<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>> resolve​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</pre>
|
|
<div class="block">Implement request resolution.</div>
|
|
<dl>
|
|
<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="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>for return value</code></a>,
|
|
<a href="request/Request.html#getPath()"><code>for path /example/path etc</code></a>,
|
|
<a href="request/Request.html#getQuery()"><code>for parameters ?param=value etc</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a id="newResponseBuilder()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>newResponseBuilder</h4>
|
|
<pre class="methodSignature">default <a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a> newResponseBuilder()</pre>
|
|
</li>
|
|
</ul>
|
|
<a id="requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>requiresAuth</h4>
|
|
<pre class="methodSignature">default boolean requiresAuth​(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</pre>
|
|
</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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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>
|