2019-08-05 11:13:19 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "fi" >
< head >
2019-10-05 10:27:37 +02:00
<!-- Generated by javadoc (1.8.0_201) on Sat Oct 05 11:26:16 EEST 2019 -->
< title > WebServer (Plan 5.0 build %buildNumber% API)< / title >
< meta name = "date" content = "2019-10-05" >
2019-08-05 11:13:19 +02:00
< link rel = "stylesheet" type = "text/css" href = "../../../../../stylesheet.css" title = "Style" >
< script type = "text/javascript" src = "../../../../../script.js" > < / script >
< / head >
< body >
< script type = "text/javascript" > < ! - -
try {
if (location.href.indexOf('is-external=true') == -1) {
2019-10-05 10:27:37 +02:00
parent.document.title="WebServer (Plan 5.0 build %buildNumber% API)";
2019-08-05 11:13:19 +02:00
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
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";
< / script >
< noscript >
< div > JavaScript is disabled on your browser.< / div >
< / noscript >
<!-- ========= START OF TOP NAVBAR ======= -->
< div class = "topNav" > < a name = "navbar.top" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.top" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.top.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.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" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/ResponseHandler.html" title = "class in com.djrapitops.plan.delivery.webserver" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServerSystem.html" title = "class in com.djrapitops.plan.delivery.webserver" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/delivery/webserver/WebServer.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "WebServer.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../../allclasses-noframe.html" > All Classes< / a > < / 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 >
< / 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 >
< a name = "skip.navbar.top" >
<!-- -->
< / a > < / div >
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
< div class = "header" >
2019-10-05 10:27:37 +02:00
< div class = "subTitle" > com.djrapitops.plan.delivery.webserver< / div >
2019-08-05 11:13:19 +02:00
< h2 title = "Class WebServer" class = "title" > Class WebServer< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
2019-10-05 10:27:37 +02:00
< li > com.djrapitops.plan.delivery.webserver.WebServer< / li >
2019-08-05 11:13:19 +02:00
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< dl >
< dt > All Implemented Interfaces:< / dt >
2019-10-05 10:27:37 +02:00
< dd > < a href = "../../../../../com/djrapitops/plan/SubSystem.html" title = "interface in com.djrapitops.plan" > SubSystem< / a > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< hr >
< br >
< pre > @Singleton
public class < span class = "typeNameLabel" > WebServer< / span >
extends java.lang.Object
2019-10-05 10:27:37 +02:00
implements < a href = "../../../../../com/djrapitops/plan/SubSystem.html" title = "interface in com.djrapitops.plan" > SubSystem< / a > < / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.summary" >
<!-- -->
< / a >
< h3 > Constructor Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Constructor Summary table, listing constructors, and an explanation" >
< caption > < span > Constructors< / span > < span class = "tabEnd" > < / span > < / caption >
< tr >
< th class = "colOne" scope = "col" > Constructor and Description< / th >
< / tr >
< tr class = "altColor" >
2019-10-05 10:27:37 +02:00
< td class = "colOne" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#WebServer-com.djrapitops.plan.settings.locale.Locale-com.djrapitops.plan.storage.file.PlanFiles-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plan.identification.ServerInfo-com.djrapitops.plugin.logging.console.PluginLogger-com.djrapitops.plugin.logging.error.ErrorHandler-com.djrapitops.plan.delivery.webserver.RequestHandler-" > WebServer< / a > < / span > (< a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > locale,
< a href = "../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > PlanFiles< / a > files,
< a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
< a href = "../../../../../com/djrapitops/plan/identification/ServerInfo.html" title = "class in com.djrapitops.plan.identification" > ServerInfo< / a > serverInfo,
2019-08-05 11:13:19 +02:00
com.djrapitops.plugin.logging.console.PluginLogger logger,
com.djrapitops.plugin.logging.error.ErrorHandler errorHandler,
2019-10-05 10:27:37 +02:00
< a href = "../../../../../com/djrapitops/plan/delivery/webserver/RequestHandler.html" title = "class in com.djrapitops.plan.delivery.webserver" > RequestHandler< / a > requestHandler)< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< / li >
< / ul >
<!-- ========== METHOD SUMMARY =========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.summary" >
<!-- -->
< / a >
< h3 > Method Summary< / h3 >
< table class = "memberSummary" border = "0" cellpadding = "3" cellspacing = "0" summary = "Method Summary table, listing methods, and an explanation" >
< 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 >
< th class = "colLast" scope = "col" > Method and Description< / th >
< / tr >
< tr id = "i0" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#disable--" > disable< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Shuts down the server - Async thread is closed with shutdown boolean.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#enable--" > enable< / a > < / span > ()< / code >
2019-08-05 11:13:19 +02:00
< div class = "block" > Performs enable actions for the subsystem.< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#getAccessAddress--" > getAccessAddress< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > java.lang.String< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#getProtocol--" > getProtocol< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#isAuthRequired--" > isAuthRequired< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#isEnabled--" > isEnabled< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< tr id = "i6" class = "altColor" >
< td class = "colFirst" > < code > boolean< / code > < / td >
2019-10-05 10:27:37 +02:00
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServer.html#isUsingHTTPS--" > isUsingHTTPS< / a > < / span > ()< / code > < / td >
2019-08-05 11:13:19 +02:00
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods.inherited.from.class.java.lang.Object" >
<!-- -->
< / 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 >
< / li >
< / ul >
< / div >
< div class = "details" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ========= CONSTRUCTOR DETAIL ======== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "constructor.detail" >
<!-- -->
< / a >
< h3 > Constructor Detail< / h3 >
2019-10-05 10:27:37 +02:00
< a name = "WebServer-com.djrapitops.plan.settings.locale.Locale-com.djrapitops.plan.storage.file.PlanFiles-com.djrapitops.plan.settings.config.PlanConfig-com.djrapitops.plan.identification.ServerInfo-com.djrapitops.plugin.logging.console.PluginLogger-com.djrapitops.plugin.logging.error.ErrorHandler-com.djrapitops.plan.delivery.webserver.RequestHandler-" >
2019-08-05 11:13:19 +02:00
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > WebServer< / h4 >
< pre > @Inject
2019-10-05 10:27:37 +02:00
public WebServer(< a href = "../../../../../com/djrapitops/plan/settings/locale/Locale.html" title = "class in com.djrapitops.plan.settings.locale" > Locale< / a > locale,
< a href = "../../../../../com/djrapitops/plan/storage/file/PlanFiles.html" title = "class in com.djrapitops.plan.storage.file" > PlanFiles< / a > files,
< a href = "../../../../../com/djrapitops/plan/settings/config/PlanConfig.html" title = "class in com.djrapitops.plan.settings.config" > PlanConfig< / a > config,
< a href = "../../../../../com/djrapitops/plan/identification/ServerInfo.html" title = "class in com.djrapitops.plan.identification" > ServerInfo< / a > serverInfo,
2019-08-05 11:13:19 +02:00
com.djrapitops.plugin.logging.console.PluginLogger logger,
com.djrapitops.plugin.logging.error.ErrorHandler errorHandler,
2019-10-05 10:27:37 +02:00
< a href = "../../../../../com/djrapitops/plan/delivery/webserver/RequestHandler.html" title = "class in com.djrapitops.plan.delivery.webserver" > RequestHandler< / a > requestHandler)< / pre >
2019-08-05 11:13:19 +02:00
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "enable--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > enable< / h4 >
< pre > public void enable()
2019-10-05 10:27:37 +02:00
throws < a href = "../../../../../com/djrapitops/plan/exceptions/EnableException.html" title = "class in com.djrapitops.plan.exceptions" > EnableException< / a > < / pre >
< div class = "block" > < span class = "descfrmTypeLabel" > Description copied from interface: < code > < a href = "../../../../../com/djrapitops/plan/SubSystem.html#enable--" > SubSystem< / a > < / code > < / span > < / div >
2019-08-05 11:13:19 +02:00
< div class = "block" > Performs enable actions for the subsystem.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Specified by:< / span > < / dt >
2019-10-05 10:27:37 +02:00
< dd > < code > < a href = "../../../../../com/djrapitops/plan/SubSystem.html#enable--" > enable< / a > < / code > in interface < code > < a href = "../../../../../com/djrapitops/plan/SubSystem.html" title = "interface in com.djrapitops.plan" > SubSystem< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
2019-10-05 10:27:37 +02:00
< dd > < code > < a href = "../../../../../com/djrapitops/plan/exceptions/EnableException.html" title = "class in com.djrapitops.plan.exceptions" > EnableException< / a > < / code > - If an error occurred during enable and it is fatal to the subsystem.< / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< a name = "isEnabled--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isEnabled< / h4 >
< pre > public boolean isEnabled()< / pre >
< dl >
< dt > < span class = "returnLabel" > Returns:< / span > < / dt >
< dd > if the WebServer is enabled< / dd >
< / dl >
< / li >
< / ul >
< a name = "disable--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > disable< / h4 >
< pre > public void disable()< / pre >
< div class = "block" > Shuts down the server - Async thread is closed with shutdown boolean.< / div >
< dl >
< dt > < span class = "overrideSpecifyLabel" > Specified by:< / span > < / dt >
2019-10-05 10:27:37 +02:00
< dd > < code > < a href = "../../../../../com/djrapitops/plan/SubSystem.html#disable--" > disable< / a > < / code > in interface < code > < a href = "../../../../../com/djrapitops/plan/SubSystem.html" title = "interface in com.djrapitops.plan" > SubSystem< / a > < / code > < / dd >
2019-08-05 11:13:19 +02:00
< / dl >
< / li >
< / ul >
< a name = "getProtocol--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > getProtocol< / h4 >
< pre > public java.lang.String getProtocol()< / pre >
< / li >
< / ul >
< a name = "isUsingHTTPS--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isUsingHTTPS< / h4 >
< pre > public boolean isUsingHTTPS()< / pre >
< / li >
< / ul >
< a name = "isAuthRequired--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > isAuthRequired< / h4 >
< pre > public boolean isAuthRequired()< / pre >
< / li >
< / ul >
< a name = "getAccessAddress--" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > getAccessAddress< / h4 >
< pre > public java.lang.String getAccessAddress()< / pre >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< div class = "bottomNav" > < a name = "navbar.bottom" >
<!-- -->
< / a >
< div class = "skipNav" > < a href = "#skip.navbar.bottom" title = "Skip navigation links" > Skip navigation links< / a > < / div >
< a name = "navbar.bottom.firstrow" >
<!-- -->
< / a >
< ul class = "navList" title = "Navigation" >
< li > < a href = "../../../../../overview-summary.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" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/ResponseHandler.html" title = "class in com.djrapitops.plan.delivery.webserver" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../../com/djrapitops/plan/delivery/webserver/WebServerSystem.html" title = "class in com.djrapitops.plan.delivery.webserver" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
2019-08-05 11:13:19 +02:00
< / ul >
< ul class = "navList" >
2019-10-05 10:27:37 +02:00
< li > < a href = "../../../../../index.html?com/djrapitops/plan/delivery/webserver/WebServer.html" target = "_top" > Frames< / a > < / li >
2019-08-05 11:13:19 +02:00
< li > < a href = "WebServer.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../../allclasses-noframe.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 >
< / 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 >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >
