dxldomaintoolsservice.app module

class dxldomaintoolsservice.app.DomainToolsService(config_dir)

Bases: dxlbootstrap.app.Application

The "DomainTools DXL Python Service" application class.

Constructor parameters:

Parameters:config_dir -- The location of the configuration files for the application
GENERAL_API_KEY_CONFIG_PROP = 'apiKey'

The property used to specify the DomainTools API Key in the application configuration file

GENERAL_API_USER_CONFIG_PROP = 'apiUser'

The property used to specify the DomainTools API User in the application configuration file

GENERAL_CONFIG_SECTION = 'General'

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

SERVICE_TYPE = '/opendxl-domaintools/service/domaintools'

The DXL service type for the DomainTools API

client

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

config

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

domaintools_api

Returns the DomainTools API client

Returns:The DomainTools API client
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_register_services()

Invoked when services should be registered with the application

on_run()

Invoked when the application has started running.