Plan/all/com/djrapitops/plan/delivery/webserver/ResponseResolver.html

212 lines
20 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ResponseResolver (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.webserver, class: ResponseResolver">
<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.6.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:&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="sub-nav-list">
<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>
<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>&nbsp;<a href="package-summary.html">com.djrapitops.plan.delivery.webserver</a></div>
<h1 title="Class ResponseResolver" class="title">Class ResponseResolver</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">com.djrapitops.plan.delivery.webserver.ResponseResolver</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations">@Singleton
</span><span class="modifiers">public class </span><span class="element-name type-name-label">ResponseResolver</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Resolves All URLs.
<p>
- Some URLs are resolved with other PageResolvers pointed at pages.
- Some URLs point to resources that are resolved differently, those implementations are in this file.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.djrapitops.plan.delivery.web.ResolverSvc,com.djrapitops.plan.delivery.webserver.ResponseFactory,dagger.Lazy,com.djrapitops.plan.delivery.webserver.resolver.QueryPageResolver,com.djrapitops.plan.delivery.webserver.resolver.PlayersPageResolver,com.djrapitops.plan.delivery.webserver.resolver.PlayerPageResolver,com.djrapitops.plan.delivery.webserver.resolver.ServerPageResolver,com.djrapitops.plan.delivery.webserver.resolver.RootPageResolver,com.djrapitops.plan.delivery.webserver.resolver.json.RootJSONResolver,com.djrapitops.plan.delivery.webserver.resolver.StaticResourceResolver,com.djrapitops.plan.delivery.webserver.resolver.PublicHtmlResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LoginPageResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.RegisterPageResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LoginResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LogoutResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.RegisterResolver,com.djrapitops.plan.delivery.webserver.resolver.ErrorsPageResolver,com.djrapitops.plan.delivery.webserver.resolver.swagger.SwaggerJsonResolver,com.djrapitops.plan.delivery.webserver.resolver.swagger.SwaggerPageResolver,com.djrapitops.plan.utilities.logging.ErrorLogger)" class="member-name-link">ResponseResolver</a><wbr>(<a href="../web/ResolverSvc.html" title="class in com.djrapitops.plan.delivery.web">ResolverSvc</a>&nbsp;resolverService,
<a href="ResponseFactory.html" title="class in com.djrapitops.plan.delivery.webserver">ResponseFactory</a>&nbsp;responseFactory,
dagger.Lazy&lt;<a href="http/WebServer.html" title="interface in com.djrapitops.plan.delivery.webserver.http">WebServer</a>&gt;&nbsp;webServer,
<a href="resolver/QueryPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">QueryPageResolver</a>&nbsp;queryPageResolver,
<a href="resolver/PlayersPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayersPageResolver</a>&nbsp;playersPageResolver,
<a href="resolver/PlayerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayerPageResolver</a>&nbsp;playerPageResolver,
<a href="resolver/ServerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ServerPageResolver</a>&nbsp;serverPageResolver,
<a href="resolver/RootPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">RootPageResolver</a>&nbsp;rootPageResolver,
<a href="resolver/json/RootJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">RootJSONResolver</a>&nbsp;rootJSONResolver,
<a href="resolver/StaticResourceResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">StaticResourceResolver</a>&nbsp;staticResourceResolver,
<a href="resolver/PublicHtmlResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PublicHtmlResolver</a>&nbsp;publicHtmlResolver,
<a href="resolver/auth/LoginPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginPageResolver</a>&nbsp;loginPageResolver,
<a href="resolver/auth/RegisterPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterPageResolver</a>&nbsp;registerPageResolver,
<a href="resolver/auth/LoginResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginResolver</a>&nbsp;loginResolver,
<a href="resolver/auth/LogoutResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LogoutResolver</a>&nbsp;logoutResolver,
<a href="resolver/auth/RegisterResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterResolver</a>&nbsp;registerResolver,
<a href="resolver/ErrorsPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ErrorsPageResolver</a>&nbsp;errorsPageResolver,
<a href="resolver/swagger/SwaggerJsonResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerJsonResolver</a>&nbsp;swaggerJsonResolver,
<a href="resolver/swagger/SwaggerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerPageResolver</a>&nbsp;swaggerPageResolver,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="../web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getResponse(com.djrapitops.plan.delivery.web.resolver.request.Request)" class="member-name-link">getResponse</a><wbr>(<a href="../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#registerPages()" class="member-name-link">registerPages</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(com.djrapitops.plan.delivery.web.ResolverSvc,com.djrapitops.plan.delivery.webserver.ResponseFactory,dagger.Lazy,com.djrapitops.plan.delivery.webserver.resolver.QueryPageResolver,com.djrapitops.plan.delivery.webserver.resolver.PlayersPageResolver,com.djrapitops.plan.delivery.webserver.resolver.PlayerPageResolver,com.djrapitops.plan.delivery.webserver.resolver.ServerPageResolver,com.djrapitops.plan.delivery.webserver.resolver.RootPageResolver,com.djrapitops.plan.delivery.webserver.resolver.json.RootJSONResolver,com.djrapitops.plan.delivery.webserver.resolver.StaticResourceResolver,com.djrapitops.plan.delivery.webserver.resolver.PublicHtmlResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LoginPageResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.RegisterPageResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LoginResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.LogoutResolver,com.djrapitops.plan.delivery.webserver.resolver.auth.RegisterResolver,com.djrapitops.plan.delivery.webserver.resolver.ErrorsPageResolver,com.djrapitops.plan.delivery.webserver.resolver.swagger.SwaggerJsonResolver,com.djrapitops.plan.delivery.webserver.resolver.swagger.SwaggerPageResolver,com.djrapitops.plan.utilities.logging.ErrorLogger)">
<h3>ResponseResolver</h3>
<div class="member-signature"><span class="annotations">@Inject
</span><span class="modifiers">public</span>&nbsp;<span class="element-name">ResponseResolver</span><wbr><span class="parameters">(<a href="../web/ResolverSvc.html" title="class in com.djrapitops.plan.delivery.web">ResolverSvc</a>&nbsp;resolverService,
<a href="ResponseFactory.html" title="class in com.djrapitops.plan.delivery.webserver">ResponseFactory</a>&nbsp;responseFactory,
dagger.Lazy&lt;<a href="http/WebServer.html" title="interface in com.djrapitops.plan.delivery.webserver.http">WebServer</a>&gt;&nbsp;webServer,
<a href="resolver/QueryPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">QueryPageResolver</a>&nbsp;queryPageResolver,
<a href="resolver/PlayersPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayersPageResolver</a>&nbsp;playersPageResolver,
<a href="resolver/PlayerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PlayerPageResolver</a>&nbsp;playerPageResolver,
<a href="resolver/ServerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ServerPageResolver</a>&nbsp;serverPageResolver,
<a href="resolver/RootPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">RootPageResolver</a>&nbsp;rootPageResolver,
<a href="resolver/json/RootJSONResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.json">RootJSONResolver</a>&nbsp;rootJSONResolver,
<a href="resolver/StaticResourceResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">StaticResourceResolver</a>&nbsp;staticResourceResolver,
<a href="resolver/PublicHtmlResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">PublicHtmlResolver</a>&nbsp;publicHtmlResolver,
<a href="resolver/auth/LoginPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginPageResolver</a>&nbsp;loginPageResolver,
<a href="resolver/auth/RegisterPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterPageResolver</a>&nbsp;registerPageResolver,
<a href="resolver/auth/LoginResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LoginResolver</a>&nbsp;loginResolver,
<a href="resolver/auth/LogoutResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">LogoutResolver</a>&nbsp;logoutResolver,
<a href="resolver/auth/RegisterResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.auth">RegisterResolver</a>&nbsp;registerResolver,
<a href="resolver/ErrorsPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver">ErrorsPageResolver</a>&nbsp;errorsPageResolver,
<a href="resolver/swagger/SwaggerJsonResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerJsonResolver</a>&nbsp;swaggerJsonResolver,
<a href="resolver/swagger/SwaggerPageResolver.html" title="class in com.djrapitops.plan.delivery.webserver.resolver.swagger">SwaggerPageResolver</a>&nbsp;swaggerPageResolver,
<a href="../../utilities/logging/ErrorLogger.html" title="interface in com.djrapitops.plan.utilities.logging">ErrorLogger</a>&nbsp;errorLogger)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="registerPages()">
<h3>registerPages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">registerPages</span>()</div>
</section>
</li>
<li>
<section class="detail" id="getResponse(com.djrapitops.plan.delivery.web.resolver.request.Request)">
<h3>getResponse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../web/resolver/Response.html" title="class in com.djrapitops.plan.delivery.web.resolver">Response</a></span>&nbsp;<span class="element-name">getResponse</span><wbr><span class="parameters">(<a href="../web/resolver/request/Request.html" title="class in com.djrapitops.plan.delivery.web.resolver.request">Request</a>&nbsp;request)</span></div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>