mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-01 16:29:31 +01:00
331 lines
16 KiB
HTML
331 lines
16 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 -->
|
||
|
|
<title>CompositeResolver (Plan 5.1-SNAPSHOT API)</title>
|
||
|
|
<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="CompositeResolver (Plan 5.1-SNAPSHOT API)";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
catch(err) {
|
||
|
|
}
|
||
|
|
//-->
|
||
|
|
var methods = {"i0":9,"i1":10,"i2":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>Prev Class</li>
|
||
|
|
<li><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/CompositeResolver.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="CompositeResolver.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><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.top">
|
||
|
|
<!-- -->
|
||
|
|
</a></div>
|
||
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="subTitle">com.djrapitops.plan.delivery.web.resolver</div>
|
||
|
|
<h2 title="Class CompositeResolver" class="title">Class CompositeResolver</h2>
|
||
|
|
</div>
|
||
|
|
<div class="contentContainer">
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>java.lang.Object</li>
|
||
|
|
<li>
|
||
|
|
<ul class="inheritance">
|
||
|
|
<li>com.djrapitops.plan.delivery.web.resolver.CompositeResolver</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="description">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<dl>
|
||
|
|
<dt>All Implemented Interfaces:</dt>
|
||
|
|
<dd><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></dd>
|
||
|
|
</dl>
|
||
|
|
<hr>
|
||
|
|
<br>
|
||
|
|
<pre>public final class <span class="typeNameLabel">CompositeResolver</span>
|
||
|
|
extends java.lang.Object
|
||
|
|
implements <a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></pre>
|
||
|
|
<div class="block">Utility Resolver for organizing resolution in a tree-like structure.
|
||
|
|
<p>
|
||
|
|
CompositeResolver removes first part of the target with <a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/URIPath.html#omitFirst--"><code>URIPath.omitFirst()</code></a>
|
||
|
|
before calling the child Resolvers.
|
||
|
|
<p>
|
||
|
|
Example: <code>resolverService.registerResolver("/test/", compositeResolver);</code>
|
||
|
|
The Resolvers added to CompositeResolver will be given Request with URIPath "/".</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="summary">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="nested.class.summary">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Nested Class Summary</h3>
|
||
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
|
||
|
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
||
|
|
<tr>
|
||
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
|
<th class="colLast" scope="col">Class and Description</th>
|
||
|
|
</tr>
|
||
|
|
<tr class="altColor">
|
||
|
|
<td class="colFirst"><code>static class </code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</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>static <a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.html#builder--">builder</a></span>()</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i1" class="rowColor">
|
||
|
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.html#canAccess-com.djrapitops.plan.delivery.web.resolver.request.Request-">canAccess</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code>
|
||
|
|
<div class="block">Implement access control if authorization is enabled.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr id="i2" class="altColor">
|
||
|
|
<td class="colFirst"><code>java.util.Optional<<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>></code></td>
|
||
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.html#resolve-com.djrapitops.plan.delivery.web.resolver.request.Request-">resolve</a></span>(<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code>
|
||
|
|
<div class="block">Implement request resolution.</div>
|
||
|
|
</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>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.djrapitops.plan.delivery.web.resolver.Resolver">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Methods inherited from interface com.djrapitops.plan.delivery.web.resolver.<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a></h3>
|
||
|
|
<code><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html#newResponseBuilder--">newResponseBuilder</a>, <a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html#requiresAuth-com.djrapitops.plan.delivery.web.resolver.request.Request-">requiresAuth</a></code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="details">
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList"><a name="method.detail">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<h3>Method Detail</h3>
|
||
|
|
<a name="builder--">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>builder</h4>
|
||
|
|
<pre>public static <a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver">CompositeResolver.Builder</a> builder()</pre>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="canAccess-com.djrapitops.plan.delivery.web.resolver.request.Request-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockList">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>canAccess</h4>
|
||
|
|
<pre>public boolean canAccess(<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</pre>
|
||
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../com/djrapitops/plan/delivery/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="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html#canAccess-com.djrapitops.plan.delivery.web.resolver.request.Request-">canAccess</a></code> in interface <code><a href="../../../../../../com/djrapitops/plan/delivery/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="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getUser--"><code>for {@link WebUser} that has access permissions.</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<a name="resolve-com.djrapitops.plan.delivery.web.resolver.request.Request-">
|
||
|
|
<!-- -->
|
||
|
|
</a>
|
||
|
|
<ul class="blockListLast">
|
||
|
|
<li class="blockList">
|
||
|
|
<h4>resolve</h4>
|
||
|
|
<pre>public java.util.Optional<<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>> resolve(<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</pre>
|
||
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../com/djrapitops/plan/delivery/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="../../../../../../com/djrapitops/plan/delivery/web/resolver/Resolver.html#resolve-com.djrapitops.plan.delivery.web.resolver.request.Request-">resolve</a></code> in interface <code><a href="../../../../../../com/djrapitops/plan/delivery/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="../../../../../../com/djrapitops/plan/delivery/web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>for return value</code></a>,
|
||
|
|
<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getPath--"><code>for path /example/path etc</code></a>,
|
||
|
|
<a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/request/Request.html#getQuery--"><code>for parameters ?param=value etc</code></a></dd>
|
||
|
|
</dl>
|
||
|
|
</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>Prev Class</li>
|
||
|
|
<li><a href="../../../../../../com/djrapitops/plan/delivery/web/resolver/CompositeResolver.Builder.html" title="class in com.djrapitops.plan.delivery.web.resolver"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="navList">
|
||
|
|
<li><a href="../../../../../../index.html?com/djrapitops/plan/delivery/web/resolver/CompositeResolver.html" target="_top">Frames</a></li>
|
||
|
|
<li><a href="CompositeResolver.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><a href="#nested.class.summary">Nested</a> | </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 name="skip.navbar.bottom">
|
||
|
|
<!-- -->
|
||
|
|
</a></div>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
</body>
|
||
|
|
</html>
|