acme.webui.webUI.WebUI

class documentation

class WebUI(object):

Constructor: WebUI(app, defaultRI, defaultOriginator, root, ...)

View In Hierarchy

The web user interface for the ACME CSE.

Method __init__ Initialize the web user interface.
Method addEndpoint Add an endpoint to the web UI.
Method getVersion Get the version of the web UI.
Method handleWebUIGET Handle a GET request for the web GUI.
Method proxy Proxy a request to another server.
Method redirectRoot Redirect request to / to webui.
Instance Variable defaultOriginator The default originator.
Instance Variable defaultRI The default CSE RI.
Instance Variable flaskApp The flask app.
Instance Variable httpExternalRoot The non-local root for the HTTP server.
Instance Variable httpRoot The root for the HTTP server.
Instance Variable oauthToken The oauth token.
Instance Variable redirectURL The URL to redirect to.
Instance Variable version The version of the web UI.
Instance Variable webuiDirectory The directory for the web UI.
Instance Variable webuiRoot The root for the web UI.
def __init__(self, app: Flask, defaultRI: str, defaultOriginator: str, root: str | None = '/webui', webuiDirectory: str | None = '.', redirectURL: str | None = None, version: str | None = '', httpRoot: str | None = '', externalRoot: str | None = ''):

Initialize the web user interface.

Parameters
app:FlaskThe flask app.
defaultRI:strThe default CSE RI.
defaultOriginator:strThe default originator.
root:str | NoneThe root for the web UI.
webuiDirectory:str | NoneThe directory for the web UI.
redirectURL:str | NoneThe URL to redirect to.
version:str | NoneThe version of the web UI.
httpRoot:str | NoneThe root for the HTTP server.
externalRoot:str | NoneThe external root for the HTTP server.
def addEndpoint(self, endpoint: str | None = None, endpoint_name: str | None = None, handler: FlaskHandler | None = None, methods: list[str] | None = None, strictSlashes: bool | None = True):

Add an endpoint to the web UI.

Parameters
endpoint:str | NoneThe endpoint.
endpoint_name:str | NoneThe name of the endpoint.
handler:FlaskHandler | NoneThe handler for the endpoint.
methods:list[str] | NoneThe methods for the endpoint.
strictSlashes:bool | NoneWhether to use strict slashes.
def getVersion(self, path: str = None) -> Response:

Get the version of the web UI.

Parameters
path:strThe path.
Returns
ResponseThe response.
def handleWebUIGET(self, path: str = None) -> Response:

Handle a GET request for the web GUI.

Parameters
path:strThe path.
Returns
ResponseThe response.
def proxy(self, *args, **kwargs) -> Response:

Proxy a request to another server.

Parameters
*argsThe arguments.
**kwargsThe keyword arguments.
Returns
ResponseThe response.
def redirectRoot(self, path: str = None) -> Response:

Redirect request to / to webui.

Parameters
path:strThe path.
Returns
ResponseThe response.
defaultOriginator =

The default originator.

defaultRI =

The default CSE RI.

flaskApp =

The flask app.

httpExternalRoot =

The non-local root for the HTTP server.

httpRoot =

The root for the HTTP server.

oauthToken: Token =

The oauth token.

redirectURL =

The URL to redirect to.

version =

The version of the web UI.

webuiDirectory =

The directory for the web UI.

webuiRoot =

The root for the web UI.