<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ResolverService (Plan 5.4-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="ResolverService (Plan 5.4-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":1,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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><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 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</a></div>
<h2 title="Interface ResolverService" class="title">Interface ResolverService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<pre>public interface <span class="typeNameLabel">ResolverService</span></pre>
<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>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ResolverService.Holder.html" title="class in com.djrapitops.plan.delivery.web">ResolverService.Holder</a></span></code></th>
<td class="colLast"> </td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== 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="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>static <a href="ResolverService.html" title="interface in com.djrapitops.plan.delivery.web">ResolverService</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance()">getInstance</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Optional<<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResolver(java.lang.String)">getResolver</a></span>​(java.lang.String target)</code></th>
<td class="colLast">
<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>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.List<<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResolvers(java.lang.String)">getResolvers</a></span>​(java.lang.String target)</code></th>
<td class="colLast">
<div class="block">Obtain all Resolvers that match the target.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerResolver(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)">registerResolver</a></span>​(java.lang.String pluginName,
java.lang.String start,
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</code></th>
<td class="colLast">
<div class="block">Register a new resolver.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerResolverForMatches(java.lang.String,java.util.regex.Pattern,com.djrapitops.plan.delivery.web.resolver.Resolver)">registerResolverForMatches</a></span>​(java.lang.String pluginName,
java.util.regex.Pattern pattern,
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</code></th>
<td class="colLast">
<div class="block">Register a new resolver with regex that matches start of target.</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="getInstance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">static <a href="ResolverService.html" title="interface in com.djrapitops.plan.delivery.web">ResolverService</a> getInstance()</pre>
</li>
</ul>
<a id="registerResolver(java.lang.String,java.lang.String,com.djrapitops.plan.delivery.web.resolver.Resolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerResolver</h4>
<pre class="methodSignature">void registerResolver​(java.lang.String pluginName,
java.lang.String start,
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</pre>
<div class="block">Register a new resolver.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If pluginName is null or empty.</dd>
</dl>
</li>
</ul>
<a id="registerResolverForMatches(java.lang.String,java.util.regex.Pattern,com.djrapitops.plan.delivery.web.resolver.Resolver)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerResolverForMatches</h4>
<pre class="methodSignature">void registerResolverForMatches​(java.lang.String pluginName,
java.util.regex.Pattern pattern,
<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a> resolver)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If pluginName is null or empty.</dd>
</dl>
</li>
</ul>
<a id="getResolver(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResolver</h4>
<pre class="methodSignature">java.util.Optional<<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>> getResolver​(java.lang.String target)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - "/example/target"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Resolver if registered or empty.</dd>
</dl>
</li>
</ul>
<a id="getResolvers(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getResolvers</h4>
<pre class="methodSignature">java.util.List<<a href="resolver/Resolver.html" title="interface in com.djrapitops.plan.delivery.web.resolver">Resolver</a>> getResolvers​(java.lang.String target)</pre>
<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>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - "/example/target"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>List of Resolvers if registered or empty list.</dd>
</dl>
</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><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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>