acme.plugins.bindings.http.HttpWebUI.HttpWebUI

class documentation

class HttpWebUI:

View In Hierarchy

Plugin class to add the Web UI functionality to the HTTP server.

The web UI is registered at the root of the HTTP server or at the path specified in the configuration under the endpoint "webui".

Method configure Configure the plugin based on the configuration settings.
Method startWebUI Start the web UI plugin.
Method validate Validate the plugin configuration.
Class Variable httpServer The injected HttpServer plugin instance is injected by the PluginManager based on the declared dependency. The plugin will only be loaded if the HttpServer plugin is loaded.
Instance Variable webui The web UI instance.
Instance Variable webuiDirectory The directory where the web UI is located.
def configure(self, config: Configuration):

Configure the plugin based on the configuration settings.

Parameters
config:ConfigurationThe configuration object.
def startWebUI(self):

Start the web UI plugin.

def validate(self, config: Configuration):

Validate the plugin configuration.

Parameters
config:ConfigurationThe configuration object.
httpServer: HttpServer =

The injected HttpServer plugin instance is injected by the PluginManager based on the declared dependency. The plugin will only be loaded if the HttpServer plugin is loaded.

webui: WebUI | None =

The web UI instance.

webuiDirectory: str | None =

The directory where the web UI is located.