2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2020-03-21 15:43:05 +01:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2020-03-21 15:43:05 +01:00
< head >
<!-- Generated by javadoc -->
2021-03-10 09:12:21 +01:00
< title > CompositeResolver (api 5.2-SNAPSHOT API)< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2020-03-21 15:43:05 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../../stylesheet.css" title = "Style" >
2021-03-10 09:12:21 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../../jquery/jquery-ui.css" title = "Style" >
2020-03-21 15:43:05 +01:00
< script type = "text/javascript" src = "../../../../../../script.js" > < / script >
2021-03-10 09:12:21 +01:00
< 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 >
2020-03-21 15:43:05 +01:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-03-10 09:12:21 +01:00
parent.document.title="CompositeResolver (api 5.2-SNAPSHOT API)";
2020-03-21 15:43:05 +01:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":9,"i1":10,"i2":10};
2020-03-21 15:43:05 +01:00
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";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');< / script >
2020-03-21 15:43:05 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-03-10 09:12:21 +01:00
< header role = "banner" >
< nav role = "navigation" >
< div class = "fixedNav" >
2020-03-21 15:43:05 +01:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.top.firstrow" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../index.html" > Overview< / a > < / li >
2020-03-21 15:43:05 +01:00
< 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" >
2021-03-10 09:12:21 +01:00
< 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 >
2020-03-21 15:43:05 +01:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2020-03-21 15:43:05 +01:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.top" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2021-03-10 09:12:21 +01:00
< / div >
< div class = "navPadding" > < / div >
< script type = "text/javascript" > < ! - -
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
< / script >
< / nav >
< / header >
2020-03-21 15:43:05 +01:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2020-03-21 15:43:05 +01:00
< div class = "header" >
2021-03-10 09:12:21 +01:00
< div class = "subTitle" > < span class = "packageLabelInType" > Package< / span > < a href = "package-summary.html" > com.djrapitops.plan.delivery.web.resolver< / a > < / div >
2020-03-21 15:43:05 +01:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "Resolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > Resolver< / a > < / code > < / dd >
2020-03-21 15:43:05 +01:00
< / dl >
< hr >
< pre > public final class < span class = "typeNameLabel" > CompositeResolver< / span >
extends java.lang.Object
2021-03-10 09:12:21 +01:00
implements < a href = "Resolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > Resolver< / a > < / pre >
2020-03-21 15:43:05 +01:00
< div class = "block" > Utility Resolver for organizing resolution in a tree-like structure.
< p >
2021-03-10 09:12:21 +01:00
CompositeResolver removes first part of the target with < a href = "request/URIPath.html#omitFirst()" > < code > URIPath.omitFirst()< / code > < / a >
2020-03-21 15:43:05 +01:00
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 ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "nested.class.summary" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Nested Class Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2020-03-21 15:43:05 +01:00
< caption > < span > Nested Classes< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colFirst" scope = "col" > Modifier and Type< / th >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Class< / th >
< th class = "colLast" scope = "col" > Description< / th >
2020-03-21 15:43:05 +01:00
< / tr >
< tr class = "altColor" >
< td class = "colFirst" > < code > static class < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "CompositeResolver.Builder.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > CompositeResolver.Builder< / a > < / span > < / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2020-03-21 15:43:05 +01:00
< 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 >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "col" > Method< / th >
< th class = "colLast" scope = "col" > Description< / th >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i0" class = "altColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > static < a href = "CompositeResolver.Builder.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > CompositeResolver.Builder< / a > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#builder()" > builder< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-03-21 15:43:05 +01:00
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)" > canAccess< / a > < / span > ​ (< a href = "request/Request.html" title = "class in com.djrapitops.plan.delivery.web.resolver.request" > Request< / a > request)< / code > < / th >
< td class = "colLast" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement access control if authorization is enabled.< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
2021-03-10 09:12:21 +01:00
< td class = "colFirst" > < code > java.util.Optional< < a href = "Response.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > Response< / a > > < / code > < / td >
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" > resolve< / a > < / span > ​ (< a href = "request/Request.html" title = "class in com.djrapitops.plan.delivery.web.resolver.request" > Request< / a > request)< / code > < / th >
< td class = "colLast" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement request resolution.< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "methods.inherited.from.class.java.lang.Object" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / 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" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "methods.inherited.from.class.com.djrapitops.plan.delivery.web.resolver.Resolver" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
2021-03-10 09:12:21 +01:00
< h3 > Methods inherited from interface com.djrapitops.plan.delivery.web.resolver.< a href = "Resolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > Resolver< / a > < / h3 >
< code > < a href = "Resolver.html#newResponseBuilder()" > newResponseBuilder< / a > , < a href = "Resolver.html#requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)" > requiresAuth< / a > < / code > < / li >
2020-03-21 15:43:05 +01:00
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-03-21 15:43:05 +01:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "builder()" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > builder< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public static < a href = "CompositeResolver.Builder.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > CompositeResolver.Builder< / a > builder()< / pre >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > canAccess< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public boolean canAccess​ (< a href = "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 = "Resolver.html#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)" > Resolver< / a > < / code > < / span > < / div >
2020-03-21 15:43:05 +01:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "Resolver.html#canAccess(com.djrapitops.plan.delivery.web.resolver.request.Request)" > canAccess< / a > < / code > in interface < code > < a href = "Resolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > Resolver< / a > < / code > < / dd >
2020-03-21 15:43:05 +01:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > < a href = "request/Request.html#getUser()" > < code > for that has access permissions.< / code > < / a > < / dd >
2020-03-21 15:43:05 +01:00
< / dl >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > resolve< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.util.Optional< < a href = "Response.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > Response< / a > > resolve​ (< a href = "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 = "Resolver.html#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" > Resolver< / a > < / code > < / span > < / div >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement request resolution.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Specified by:< / span > < / dt >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "Resolver.html#resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" > resolve< / a > < / code > in interface < code > < a href = "Resolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > Resolver< / a > < / code > < / dd >
2020-03-21 15:43:05 +01:00
< 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 >
2021-03-10 09:12:21 +01:00
< dd > < a href = "Response.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > < code > for return value< / code > < / a > ,
< a href = "request/Request.html#getPath()" > < code > for path /example/path etc< / code > < / a > ,
< a href = "request/Request.html#getQuery()" > < code > for parameters ?param=value etc< / code > < / a > < / dd >
2020-03-21 15:43:05 +01:00
< / dl >
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2020-03-21 15:43:05 +01:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2020-03-21 15:43:05 +01:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
2021-03-10 09:12:21 +01:00
< a id = "navbar.bottom.firstrow" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../index.html" > Overview< / a > < / li >
2020-03-21 15:43:05 +01:00
< 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" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../../allclasses.html" > All Classes< / a > < / li >
2020-03-21 15:43:05 +01:00
< / 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 >
2021-03-10 09:12:21 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2020-03-21 15:43:05 +01:00
< / 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 >
2021-03-10 09:12:21 +01:00
< a id = "skip.navbar.bottom" >
2020-03-21 15:43:05 +01:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2020-03-21 15:43:05 +01:00
< / body >
< / html >
