2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
< html lang = "en" >
2020-03-21 15:43:05 +01:00
< head >
2022-06-10 15:30:56 +02:00
<!-- Generated by javadoc (17) -->
2021-06-12 09:24:49 +02:00
< title > Resolver (api 5.4-SNAPSHOT API)< / title >
2021-07-24 13:27:37 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2021-07-24 13:27:37 +02:00
< meta name = "description" content = "declaration: package: com.djrapitops.plan.delivery.web.resolver, interface: Resolver" >
< meta name = "generator" content = "javadoc/ClassWriterImpl" >
2020-03-21 15:43:05 +01:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../../stylesheet.css" title = "Style" >
2021-07-24 13:27:37 +02:00
< 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" >
2020-03-21 15:43:05 +01:00
< script type = "text/javascript" src = "../../../../../../script.js" > < / script >
2021-07-24 13:27:37 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / head >
2021-07-24 13:27:37 +02:00
< body class = "class-declaration-page" >
< script type = "text/javascript" > v a r e v e n R o w C o l o r = " e v e n - r o w - c o l o r " ;
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
2021-03-10 09:12:21 +01:00
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');< / script >
2020-03-21 15:43:05 +01:00
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
2021-07-24 13:27:37 +02:00
< div class = "flex-box" >
< header role = "banner" class = "flex-header" >
2021-03-10 09:12:21 +01:00
< nav role = "navigation" >
2020-03-21 15:43:05 +01:00
<!-- ========= START OF TOP NAVBAR ======= -->
2022-06-10 15:30:56 +02:00
< 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" >
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 >
2021-07-24 13:27:37 +02:00
< li class = "nav-bar-cell1-rev" > Class< / li >
2020-03-21 15:43:05 +01:00
< 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 >
2022-06-10 15:30:56 +02:00
< li > < a href = "../../../../../../help-doc.html#class" > Help< / a > < / li >
2020-03-21 15:43:05 +01:00
< / ul >
< / div >
2021-07-24 13:27:37 +02:00
< div class = "sub-nav" >
2020-03-21 15:43:05 +01:00
< div >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2020-03-21 15:43:05 +01:00
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-summary" > Method< / a > < / li >
2020-03-21 15:43:05 +01:00
< / ul >
2021-07-24 13:27:37 +02:00
< ul class = "sub-nav-list" >
2020-03-21 15:43:05 +01:00
< li > Detail: < / li >
< li > Field | < / li >
< li > Constr | < / li >
2022-06-10 15:30:56 +02:00
< li > < a href = "#method-detail" > Method< / a > < / li >
2020-03-21 15:43:05 +01:00
< / ul >
< / div >
2022-06-10 15:30:56 +02:00
< 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" >
2021-03-10 09:12:21 +01:00
< / div >
2021-07-24 13:27:37 +02:00
< / div >
<!-- ========= END OF TOP NAVBAR ========= -->
2022-06-10 15:30:56 +02:00
< span class = "skip-nav" id = "skip-navbar-top" > < / span > < / nav >
2021-03-10 09:12:21 +01:00
< / header >
2021-07-24 13:27:37 +02:00
< div class = "flex-content" >
2021-03-10 09:12:21 +01:00
< main role = "main" >
2021-07-24 13:27:37 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2020-03-21 15:43:05 +01:00
< div class = "header" >
2021-07-24 13:27:37 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / div >
2022-06-10 15:30:56 +02:00
< section class = "class-description" id = "class-description" >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2020-03-21 15:43:05 +01:00
< dt > All Known Subinterfaces:< / dt >
2021-03-10 09:12:21 +01:00
< dd > < code > < a href = "NoAuthResolver.html" title = "interface in com.djrapitops.plan.delivery.web.resolver" > NoAuthResolver< / a > < / code > < / dd >
2020-03-21 15:43:05 +01:00
< / dl >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
2020-03-21 15:43:05 +01:00
< dt > All Known Implementing Classes:< / dt >
2021-10-11 19:29:35 +02:00
< dd > < code > < a href = "CompositeResolver.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > CompositeResolver< / a > < / code > , < code > < a href = "FunctionalResolverWrapper.html" title = "class in com.djrapitops.plan.delivery.web.resolver" > FunctionalResolverWrapper< / a > < / code > < / dd >
2020-03-21 15:43:05 +01:00
< / dl >
< hr >
2021-07-24 13:27:37 +02:00
< div class = "type-signature" > < span class = "modifiers" > public interface < / span > < span class = "element-name type-name-label" > Resolver< / span > < / div >
2020-03-21 15:43:05 +01:00
< div class = "block" > Interface for resolving requests of Plan webserver.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > See Also:< / dt >
2022-06-10 15:30:56 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "summary" >
< ul class = "summary-list" >
2020-03-21 15:43:05 +01:00
<!-- ========== METHOD SUMMARY =========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-summary" id = "method-summary" >
2021-07-24 13:27:37 +02:00
< 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 >
2022-06-10 15:30:56 +02:00
< 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" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement access control if authorization is enabled.< / div >
2021-07-24 13:27:37 +02:00
< / div >
2022-06-10 15:30:56 +02:00
< 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" >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement request resolution.< / div >
2021-07-24 13:27:37 +02:00
< / div >
< / div >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
< section class = "details" >
< ul class = "details-list" >
2020-03-21 15:43:05 +01:00
<!-- ============ METHOD DETAIL ========== -->
2021-07-24 13:27:37 +02:00
< li >
2022-06-10 15:30:56 +02:00
< section class = "method-details" id = "method-detail" >
2021-07-24 13:27:37 +02:00
< 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 >
2022-06-10 15:30:56 +02:00
< 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 >
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 >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Parameters:< / dt >
2020-03-21 15:43:05 +01:00
< dd > < code > request< / code > - HTTP request, contains all information necessary to check access.< / dd >
2021-07-24 13:27:37 +02:00
< dt > Returns:< / dt >
2020-03-21 15:43:05 +01:00
< dd > true if allowed or invalid target, false if response should be 403 (forbidden)< / dd >
2021-07-24 13:27:37 +02:00
< dt > See Also:< / dt >
2022-06-10 15:30:56 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "resolve(com.djrapitops.plan.delivery.web.resolver.request.Request)" >
< h3 > resolve< / h3 >
2022-06-10 15:30:56 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< div class = "block" > Implement request resolution.< / div >
2021-07-24 13:27:37 +02:00
< dl class = "notes" >
< dt > Parameters:< / dt >
2020-03-21 15:43:05 +01:00
< dd > < code > request< / code > - HTTP request, contains all information necessary to resolve the request.< / dd >
2021-07-24 13:27:37 +02:00
< dt > Returns:< / dt >
2020-03-21 15:43:05 +01:00
< dd > Response or empty if the response should be 404 (not found).< / dd >
2021-07-24 13:27:37 +02:00
< dt > See Also:< / dt >
2022-06-10 15:30:56 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / dl >
2021-07-24 13:27:37 +02:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
2021-07-24 13:27:37 +02:00
< 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 >
2020-03-21 15:43:05 +01:00
< / li >
2021-07-24 13:27:37 +02:00
< li >
< section class = "detail" id = "requiresAuth(com.djrapitops.plan.delivery.web.resolver.request.Request)" >
< h3 > requiresAuth< / h3 >
2022-06-10 15:30:56 +02:00
< 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 >
2021-07-24 13:27:37 +02:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-03-21 15:43:05 +01:00
< / li >
< / ul >
2021-07-24 13:27:37 +02:00
< / section >
2020-03-21 15:43:05 +01:00
<!-- ========= END OF CLASS DATA ========= -->
2021-07-24 13:27:37 +02:00
< / main >
2020-03-21 15:43:05 +01:00
< / div >
< / div >
< / body >
< / html >
