acme.plugins.bindings.http.HttpManagement.HttpManagement

class documentation

class HttpManagement:

Plugin class to add the Management functionality to the HTTP server.

The management endpoint is registered at "__mgmt__".

The plugin depends on the HttpServer.HttpServer plugin, which is injected into this plugin by the acme.runtime.PluginManager.PluginManager. The management endpoint will only be registered if the HttpServer.HttpServer plugin is loaded and the dependency can be resolved.

Method	`configure`	Configure the plugin based on the configuration settings.
Method	`handleManagement`	Handle a management request. This is used to control the CSE.
Method	`startManagement`	Start the management plugin.
Class Variable	`httpServer`	The injected `HttpServer.HttpServer` plugin instance is injected by the `acme.runtime.PluginManager.PluginManager` based on the declared dependency. The plugin will only be loaded if the `HttpServer.HttpServer`...
Class Variable	`managementSupport`	Injected `ManagementSupport` instance.

def configure(self, config: Configuration): ¶

Configure the plugin based on the configuration settings.

Parameters
config:`Configuration`	The configuration object.

def handleManagement(self, command: str | None = None, param: str | None = None) -> Response: ¶

Handle a management request. This is used to control the CSE.

Parameters
command:`str \| None`	The management command to execute. If None, the request is rejected.
param:`str \| None`	An optional parameter for the management command.

Returns
`Response`	A response object.

def startManagement(self): ¶

Start the management plugin.

httpServer: HttpServer = ¶

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

managementSupport: ManagementSupport = ¶

Injected ManagementSupport instance.