dxlconsole.app module

class dxlconsole.app.OpenDxlConsole(config_dir, unique_id=None)

Bases: dxlbootstrap.app.Application

The "OpenDXL Console" application class.

Constructor parameters:

Parameters:
  • config_dir -- The location of the configuration files for the application
  • unique_id -- The unique identifier of the console (optional)
GENERAL_CONFIG_SECTION = 'General'

The name of the "General" section within the application configuration file

GENERAL_LOCAL_BROKER_PROP = 'localBroker'

Whether the console is embedded in the broker

GENERAL_PASSWORD_PROP = 'password'

The console password

GENERAL_PORT_CONFIG_PROP = 'port'

The web server port property

GENERAL_USERNAME_PROP = 'username'

The console user name

client

The DXL client used by the application to communicate with the DXL fabric

client_config_path
config

The application configuration (as read from the "dxlconsole.config" file)

console_name

Returns the console name (title)

Returns:The console name (title)
local_broker

Returns whether the console is for managing an OpenDXL broker

Returns:Whether the console is for managing an OpenDXL broker
on_dxl_connect()

Invoked after the client associated with the application has connected to the DXL fabric.

on_load_configuration(config)

Invoked after the application-specific configuration has been loaded

This callback provides the opportunity for the application to parse additional configuration properties.

Parameters:config -- The application configuration
on_run()

Invoked when the application has started running.

password

Returns the console password

Returns:The console password
port

Returns the console port

Returns:The console port

Returns the cookie name to use for the user

Returns:The cookie name to use for the user
username

Returns the console user name

Returns:The console username