acme.plugins.bindings.http.HttpUpperTester.HttpUpperTester

class documentation

class HttpUpperTester:

Plugin class to add the Upper Tester functionality to the HTTP server.

See TS-0019 for details about the Upper Tester specification.

The upper tester endpoint is registered at "__ut__".

Method	`configure`	Configure the plugin based on the configuration settings.
Method	`handleUpperTester`	Handle a Upper Tester request. See TS-0019 for details.
Method	`startUpperTester`	Start the upper tester plugin.
Class Variable	`httpServer`	The 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	`requestManager`	Injected RequestManager instance.
Class Variable	`script`	InjectedScriptManager instance.

@configure

def configure(self, config: Configuration): ¶

Configure the plugin based on the configuration settings.

Parameters
config:`Configuration`	The configuration object.

def handleUpperTester(self, path: str | None = None) -> Response: ¶

Handle a Upper Tester request. See TS-0019 for details.

Parameters
path:`str \| None`	The path of the request.

Returns
`Response`	A response object.

@start

def startUpperTester(self): ¶

Start the upper tester plugin.

httpServer: HttpServer = ¶

The 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.

requestManager: RequestManager = ¶

Injected RequestManager instance.

script: ScriptManager = ¶

InjectedScriptManager instance.