<!DOCTYPE HTML> <html lang="en"> <head> <!-- Generated by javadoc (17) --> <title>Resolver (Plan 5.5-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="description" content="declaration: package: com.djrapitops.plan.delivery.web.resolver, interface: Resolver"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> <script type="text/javascript" src="../../../../../../script.js"></script> <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var evenRowColor = "even-row-color"; var oddRowColor = "odd-row-color"; var tableTab = "table-tab"; var activeTableTab = "active-table-tab"; var pathtoroot = "../../../../../../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"> <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="../../../../../../index.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">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#class">Help</a></li> </ul> </div> <div class="sub-nav"> <div> <ul class="sub-nav-list"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method-summary">Method</a></li> </ul> <ul class="sub-nav-list"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method-detail">Method</a></li> </ul> </div> <div class="nav-list-search"><label for="search-input">SEARCH:</label> <input type="text" id="search-input" value="search" disabled="disabled"> <input type="reset" id="reset-button" value="reset" disabled="disabled"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.djrapitops.plan.delivery.web.resolver</a></div> <h1 title="Interface Resolver" class="title">Interface Resolver</h1> </div> <section class="class-description" id="class-description"> <dl class="notes"> <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 class="notes"> <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/ErrorsJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">ErrorsJSONResolver</a></code>, <code><a href="../../webserver/resolver/ErrorsPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ErrorsPageResolver</a></code>, <code><a href="../../webserver/resolver/json/ExtensionJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">ExtensionJSONResolver</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="FunctionalResolverWrapper.html" title="class in com.djrapitops.plan.delivery.web.resolver">FunctionalResolverWrapper</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/json/LocaleJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">LocaleJSONResolver</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/MetadataJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">MetadataJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/NetworkMetadataJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">NetworkMetadataJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/NetworkPerformanceJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">NetworkPerformanceJSONResolver</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/json/ServerIdentityJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">ServerIdentityJSONResolver</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>, <code><a href="../../webserver/resolver/swagger/SwaggerJsonResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerJsonResolver</a></code>, <code><a href="../../webserver/resolver/swagger/SwaggerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerPageResolver</a></code>, <code><a href="../../webserver/resolver/json/VersionJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">VersionJSONResolver</a></code>, <code><a href="../../webserver/resolver/json/WhoAmIJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">WhoAmIJSONResolver</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Resolver</span></div> <div class="block">Interface for resolving requests of Plan webserver.</div> <dl class="notes"> <dt>See Also:</dt> <dd> <ul class="see-list-long"> <li><a href="NoAuthResolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>if resource is always accessible regardless of user.</code></a></li> </ul> </dd> </dl> </section> <section class="summary"> <ul class="summary-list"> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Method Summary</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <div class="table-header col-first">Modifier and Type</div> <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)" class="member-name-link">canAccess</a><wbr>(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Implement access control if authorization is enabled.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#newResponseBuilder()" class="member-name-link">newResponseBuilder</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)" class="member-name-link">requiresAuth</a><wbr>(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>></code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" class="member-name-link">resolve</a><wbr>(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> <div class="block">Implement request resolution.</div> </div> </div> </div> </div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Method Details</h2> <ul class="member-list"> <li> <section class="detail" id="canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)"> <h3>canAccess</h3> <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">canAccess</span><wbr><span class="parameters">(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</span></div> <div class="block">Implement access control if authorization is enabled. <p> Is not called when access control is not active.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>request</code> - HTTP request, contains all information necessary to check access.</dd> <dt>Returns:</dt> <dd>true if allowed or invalid target, false if response should be 403 (forbidden)</dd> <dt>See Also:</dt> <dd> <ul class="see-list-long"> <li><a href="request/Request.html#getUser()"><code>for WebUser that has access permissions.</code></a></li> </ul> </dd> </dl> </section> </li> <li> <section class="detail" id="resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)"> <h3>resolve</h3> <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a>></span> <span class="element-name">resolve</span><wbr><span class="parameters">(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</span></div> <div class="block">Implement request resolution.</div> <dl class="notes"> <dt>Parameters:</dt> <dd><code>request</code> - HTTP request, contains all information necessary to resolve the request.</dd> <dt>Returns:</dt> <dd>Response or empty if the response should be 404 (not found).</dd> <dt>See Also:</dt> <dd> <ul class="see-list-long"> <li><a href="Response.html" title="class in com.djrapitops.plan.delivery.web.resolver"><code>for return value</code></a></li> <li><a href="request/Request.html#getPath()"><code>for path /example/path etc</code></a></li> <li><a href="request/Request.html#getQuery()"><code>for parameters ?param=value etc</code></a></li> </ul> </dd> </dl> </section> </li> <li> <section class="detail" id="newResponseBuilder()"> <h3>newResponseBuilder</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ResponseBuilder.html" title="class in com.djrapitops.plan.delivery.web.resolver">ResponseBuilder</a></span> <span class="element-name">newResponseBuilder</span>()</div> </section> </li> <li> <section class="detail" id="requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)"> <h3>requiresAuth</h3> <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name">requiresAuth</span><wbr><span class="parameters">(<a href="request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a> request)</span></div> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>