acme.plugins.bindings.http.HttpStructure.HttpStructure

class documentation

class HttpStructure:

View In Hierarchy

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

The structure endpoint is registered at "__structure__".

Method configure Configure the plugin based on the configuration settings.
Method handleStructure Handle a structure request. Return a description of the CSE's current resource and registrar / registree deployment. An optional parameter 'lvl=<int>' can limit the generated resource tree's depth.
Method startStructure Start the structure plugin.
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.
Class Variable managementSupport Injected ManagementSupport instance.
def configure(self, config: Configuration):

Configure the plugin based on the configuration settings.

Parameters
config:ConfigurationThe configuration object.
def handleStructure(self, path: str | None = 'puml') -> Response:

Handle a structure request. Return a description of the CSE's current resource and registrar / registree deployment. An optional parameter 'lvl=<int>' can limit the generated resource tree's depth.

def startStructure(self):

Start the structure plugin.

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.

managementSupport: ManagementSupport =

Injected ManagementSupport instance.