mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-12-28 12:07:35 +01:00
249 lines
18 KiB
HTML
249 lines
18 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (16) -->
|
|
<title>ResolverService (Plan 5.4-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, interface: ResolverService">
|
|
<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">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<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="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">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" 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</a></div>
|
|
<h1 title="Interface ResolverService" class="title">Interface ResolverService</h1>
|
|
</div>
|
|
<section class="description">
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="ResolverSvc.html" title="class in com.djrapitops.plan.delivery.web">ResolverSvc</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ResolverService</span></div>
|
|
<div class="block">Service for modifying webserver request resolution.
|
|
<p>
|
|
It is recommended to use plugin based namespace in your custom targets,
|
|
eg. "/flyplugin/flying" to avoid collisions with other plugins.
|
|
You can also use <a href="#getResolver(java.lang.String)"><code>getResolver(String)</code></a> to check if target already has a resolver.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li>
|
|
<section class="nested-class-summary" id="nested.class.summary">
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="caption"><span>Nested Classes</span></div>
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Interface</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color"><code>static class </code></div>
|
|
<div class="col-second even-row-color"><code><span class="member-name-link"><a href="ResolverService.Holder.html" title="class in com.djrapitops.plan.delivery.web">ResolverService.Holder</a></span></code></div>
|
|
<div class="col-last even-row-color"> </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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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></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-tab1 method-summary-table"><code>static <a href="ResolverService.html" title="interface in com.djrapitops.plan.delivery.web">ResolverService</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab1 method-summary-table"><code><span class="member-name-link"><a href="#getInstance()">getInstance</a></span>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab1 method-summary-table"> </div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getResolver(java.lang.String)">getResolver</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
|
|
<div class="block">Obtain a <a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>Resolver</code></a> for a target.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getResolvers(java.lang.String)">getResolvers</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
|
|
<div class="block">Obtain all Resolvers that match the target.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#registerResolver(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)">registerResolver</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pluginName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> start,
|
|
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
|
|
<div class="block">Register a new resolver.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#registerResolverForMatches(java.lang.String,java.util.regex.Pattern,com.djrapitops.plan.delivery.web.resolver.Resolver)">registerResolverForMatches</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pluginName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> pattern,
|
|
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</code></div>
|
|
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
|
|
<div class="block">Register a new resolver with regex that matches start of target.</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="getInstance()">
|
|
<h3>getInstance</h3>
|
|
<div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="ResolverService.html" title="interface in com.djrapitops.plan.delivery.web">ResolverService</a></span> <span class="element-name">getInstance</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerResolver(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)">
|
|
<h3>registerResolver</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">registerResolver</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pluginName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> start,
|
|
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</span></div>
|
|
<div class="block">Register a new resolver.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>pluginName</code> - Name of the plugin that is registering (For error messages)</dd>
|
|
<dd><code>start</code> - Start of the target to match against, eg "/example" will send "/example/target" etc to the Resolver.</dd>
|
|
<dd><code>resolver</code> - <a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>Resolver</code></a> to use for this</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If pluginName is null or empty.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="registerResolverForMatches(java.lang.String,java.util.regex.Pattern,com.djrapitops.plan.delivery.web.resolver.Resolver)">
|
|
<h3>registerResolverForMatches</h3>
|
|
<div class="member-signature"><span class="return-type">void</span> <span class="element-name">registerResolverForMatches</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pluginName,
|
|
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/regex/Pattern.html" title="class or interface in java.util.regex" class="external-link">Pattern</a> pattern,
|
|
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</span></div>
|
|
<div class="block">Register a new resolver with regex that matches start of target.
|
|
<p>
|
|
NOTICE: It is recommended to avoid too generic regex like "/.*" to not override existing resolvers.
|
|
<p>
|
|
Parameters (?param=value) are not included in the regex matching.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>pluginName</code> - Name of the plugin that is registering (For error messages)</dd>
|
|
<dd><code>pattern</code> - Regex Pattern, "/example.*" will send "/exampletarget" etc to the Resolver.</dd>
|
|
<dd><code>resolver</code> - <a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>Resolver</code></a> to use for this.</dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - If pluginName is null or empty.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getResolver(java.lang.String)">
|
|
<h3>getResolver</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></span> <span class="element-name">getResolver</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target)</span></div>
|
|
<div class="block">Obtain a <a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver"><code>Resolver</code></a> for a target.
|
|
<p>
|
|
First matching resolver will be returned.
|
|
<a href="#registerResolver(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)"><code>registerResolver(java.lang.String, java.lang.String, com.djrapitops.plan.delivery.web.resolver.Resolver)</code></a> resolvers have higher priority than <a href="#registerResolverForMatches(java.lang.String,java.util.regex.Pattern,com.djrapitops.plan.delivery.web.resolver.Resolver)"><code>registerResolverForMatches(java.lang.String, java.util.regex.Pattern, com.djrapitops.plan.delivery.web.resolver.Resolver)</code></a>.
|
|
<p>
|
|
Can be used when making Resolver middleware.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>target</code> - "/example/target"</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>Resolver if registered or empty.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getResolvers(java.lang.String)">
|
|
<h3>getResolvers</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></span> <span class="element-name">getResolvers</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> target)</span></div>
|
|
<div class="block">Obtain all Resolvers that match the target.
|
|
<p>
|
|
If first returns Optional.empty next one should be used.
|
|
<p>
|
|
Requires Capability PAGE_EXTENSION_RESOLVERS_LIST.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>target</code> - "/example/target"</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>List of Resolvers if registered or empty list.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|