2021-03-10 09:12:21 +01:00
<!DOCTYPE HTML>
2020-06-21 19:24:04 +02:00
<!-- NewPage -->
2021-03-10 09:12:21 +01:00
< html lang = "en" >
2020-06-21 19:24:04 +02:00
< head >
<!-- Generated by javadoc -->
2021-04-25 10:31:38 +02:00
< title > Addresses (Plan 5.3-SNAPSHOT API)< / title >
2021-03-10 09:12:21 +01:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2020-06-21 19:24:04 +02: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-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2021-04-25 10:31:38 +02:00
parent.document.title="Addresses (Plan 5.3-SNAPSHOT API)";
2020-06-21 19:24:04 +02:00
}
}
catch(err) {
}
//-->
2021-03-10 09:12:21 +01:00
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
2020-06-21 19:24:04 +02:00
var tabs = {65535:["t0","All 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-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
<!-- ========= START OF TOP NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< div class = "topNav" > < a id = "navbar.top" >
2020-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2020-06-21 19:24:04 +02: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-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / 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-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
<!-- ======== START OF CLASS DATA ======== -->
2021-03-10 09:12:21 +01:00
< main role = "main" >
2020-06-21 19:24:04 +02: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.webserver< / a > < / div >
2020-06-21 19:24:04 +02:00
< h2 title = "Class Addresses" class = "title" > Class Addresses< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > com.djrapitops.plan.delivery.webserver.Addresses< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< pre > @Singleton
public class < span class = "typeNameLabel" > Addresses< / span >
extends java.lang.Object< / pre >
< div class = "block" > In charge of address management.
< p >
Possible scenarios (problem domain):
- IP in server properties is 0.0.0.0 which is invalid
- IP in server properties is empty string, which is invalid
- Alternative IP is set in the Plan config
- Proxy server is used as main webserver, this address has highest priority
- Webserver is disabled, external webserver address in config should be used
- Webserver uses either http or https
- Webserver always has a port, but Alternative IP can be used to remove the port from the address
< p >
What are the addresses used in:
- Given as links to commands
- Redirection
- Storing proxy server address in database< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-06-21 19:24:04 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "constructor.summary" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2020-06-21 19:24:04 +02:00
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
2021-03-10 09:12:21 +01:00
< th class = "colFirst" scope = "col" > Constructor< / th >
< th class = "colLast" scope = "col" > Description< / th >
2020-06-21 19:24:04 +02:00
< / tr >
< tr class = "altColor" >
2021-03-10 09:12:21 +01:00
< th class = "colConstructorName" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#%3Cinit%3E(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,dagger.Lazy,dagger.Lazy)" > Addresses< / a > < / span > ​ (< a href = "../../settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
< a href = "../../storage/database/DBSystem.html" title = "class in com.djrapitops.plan.storage.database" > DBSystem< / a > dbSystem,
dagger.Lazy< < a href = "../../identification/properties/ServerProperties.html" title = "class in com.djrapitops.plan.identification.properties" > ServerProperties< / a > > serverProperties,
dagger.Lazy< < a href = "WebServer.html" title = "class in com.djrapitops.plan.delivery.webserver" > WebServer< / a > > webserver)< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / tr >
< / table >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-06-21 19:24:04 +02:00
<!-- ========== METHOD SUMMARY =========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-06-21 19:24:04 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.summary" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
2021-03-10 09:12:21 +01:00
< table class = "memberSummary" >
2020-06-21 19:24:04 +02:00
< caption > < span id = "t0" class = "activeTableTab" > < span > All Methods< / 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-06-21 19:24:04 +02:00
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > java.util.Optional< java.lang.String> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getAccessAddress()" > getAccessAddress< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getFallbackLocalhostAddress()" > getFallbackLocalhostAddress< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > java.util.Optional< java.lang.String> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getMainAddress()" > getMainAddress< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > java.util.Optional< java.lang.String> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getProxyServerAddress()" > getProxyServerAddress< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > java.util.Optional< java.lang.String> < / code > < / td >
2021-03-10 09:12:21 +01:00
< th class = "colSecond" scope = "row" > < code > < span class = "memberNameLink" > < a href = "#getServerPropertyIP()" > getServerPropertyIP< / a > < / span > ()< / code > < / th >
< td class = "colLast" > < / td >
2020-06-21 19:24:04 +02:00
< / 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-06-21 19:24:04 +02: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 >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-06-21 19:24:04 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "constructor.detail" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "<init>(com.djrapitops.plan.settings.config.PlanConfig,com.djrapitops.plan.storage.database.DBSystem,dagger.Lazy,dagger.Lazy)" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > Addresses< / h4 >
< pre > @Inject
2021-03-10 09:12:21 +01:00
public Addresses​ (< a href = "../../settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
< a href = "../../storage/database/DBSystem.html" title = "class in com.djrapitops.plan.storage.database" > DBSystem< / a > dbSystem,
dagger.Lazy< < a href = "../../identification/properties/ServerProperties.html" title = "class in com.djrapitops.plan.identification.properties" > ServerProperties< / a > > serverProperties,
dagger.Lazy< < a href = "WebServer.html" title = "class in com.djrapitops.plan.delivery.webserver" > WebServer< / a > > webserver)< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-06-21 19:24:04 +02:00
<!-- ============ METHOD DETAIL ========== -->
2021-03-10 09:12:21 +01:00
< section role = "region" >
2020-06-21 19:24:04 +02:00
< ul class = "blockList" >
2021-03-10 09:12:21 +01:00
< li class = "blockList" > < a id = "method.detail" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
2021-03-10 09:12:21 +01:00
< a id = "getMainAddress()" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getMainAddress< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.util.Optional< java.lang.String> getMainAddress()< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getAccessAddress()" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getAccessAddress< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.util.Optional< java.lang.String> getAccessAddress()< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getFallbackLocalhostAddress()" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getFallbackLocalhostAddress< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.lang.String getFallbackLocalhostAddress()< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getProxyServerAddress()" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getProxyServerAddress< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.util.Optional< java.lang.String> getProxyServerAddress()< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< a id = "getServerPropertyIP()" >
2020-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getServerPropertyIP< / h4 >
2021-03-10 09:12:21 +01:00
< pre class = "methodSignature" > public java.util.Optional< java.lang.String> getServerPropertyIP()< / pre >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
< / li >
< / ul >
2021-03-10 09:12:21 +01:00
< / section >
2020-06-21 19:24:04 +02:00
< / li >
< / ul >
< / div >
< / div >
2021-03-10 09:12:21 +01:00
< / main >
2020-06-21 19:24:04 +02:00
<!-- ========= END OF CLASS DATA ========= -->
2021-03-10 09:12:21 +01:00
< footer role = "contentinfo" >
< nav role = "navigation" >
2020-06-21 19:24:04 +02:00
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2021-03-10 09:12:21 +01:00
< div class = "bottomNav" > < a id = "navbar.bottom" >
2020-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
2021-03-10 09:12:21 +01:00
< li > < a href = "../../../../../index.html" > Overview< / a > < / li >
2020-06-21 19:24:04 +02: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-06-21 19:24:04 +02: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-06-21 19:24:04 +02:00
< / div >
< div >
< ul class = "subNavList" >
< li > Summary: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / 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-06-21 19:24:04 +02:00
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2021-03-10 09:12:21 +01:00
< / nav >
< / footer >
2020-06-21 19:24:04 +02:00
< / body >
< / html >
