dxlurlvoidservice.app module¶

class dxlurlvoidservice.app.UrlVoidApiService(config_dir)¶

Bases: dxlbootstrap.app.Application

The "URLVoid DXL 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 URLVoid API Key in the application configuration file

GENERAL_CONFIG_SECTION = 'General'¶: The name of the "General" section within the application configuration file

REQ_TOPIC_HOST_INFO = '/opendxl-urlvoid/service/urlvapi/host/info'¶: The "host info" DXL request topic

REQ_TOPIC_HOST_RESCAN = '/opendxl-urlvoid/service/urlvapi/host/rescan'¶: The "host rescan" DXL request topic

REQ_TOPIC_HOST_SCAN = '/opendxl-urlvoid/service/urlvapi/host/scan'¶: The "host new scan" DXL request topic

REQ_TOPIC_STATS_REMAINED = '/opendxl-urlvoid/service/urlvapi/stats/remained'¶: The "stats remained" DXL request topic

SERVICE_TYPE = '/opendxl-urlvoid/service/urlvapi'¶: The DXL service type for the URLVoid API

URL_VOID_API_URL_FORMAT = 'http://api.urlvoid.com/api1000/{0}/'¶: The URL format for URLVoid API invocations

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

config¶: The application configuration (as read from the "dxlurlvoidservice.config" file)

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