hawat.blueprints.dnsr package

Description

This pluggable module provides access to DNS service. It is implemented upon custom mentat.services.dnsr module.

Provided endpoints

/dnsr/search

Endpoint providing search form for querying DNS service and formating result as HTML page.

  • Authentication: login required

  • Methods: GET

/api/dnsr/search

Endpoint providing API search form for querying DNS service and formating result as JSON document.

  • Authentication: login required

  • Authorization: any role

  • Methods: GET, POST

/snippet/dnsr/search

Endpoint providing API search form for querying DNS service and formating result as JSON document containing HTML snippets.

  • Authentication: login required

  • Authorization: any role

  • Methods: GET, POST

class hawat.blueprints.dnsr.APISearchView[source]

Bases: hawat.base.AJAXMixin, hawat.blueprints.dnsr.AbstractSearchView

View responsible for querying DNS service and presenting the results in the form of JSON document.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

methods = ['GET', 'POST']
class hawat.blueprints.dnsr.AbstractSearchView[source]

Bases: hawat.base.RenderableView

Application view providing base search capabilities for DNS service.

The resolving is implemented using mentat.services.dnsr module.

authentication = True
authorization = [<Permission needs={Need(method='role', value='developer'), Need(method='role', value='maintainer'), Need(method='role', value='user'), Need(method='role', value='admin')} excludes=set()>]
dispatch_request()[source]

Mandatory interface required by the flask.views.View.dispatch_request(). Will be called by the Flask framework to service the request.

classmethod get_menu_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_menu_title().

classmethod get_view_title(**kwargs)[source]

Implementation of hawat.base.BaseView.get_view_title().

hawat.blueprints.dnsr.BLUEPRINT_NAME = 'dnsr'

Name of the blueprint as module global constant.

class hawat.blueprints.dnsr.DnsrBlueprint(name, import_name, **kwargs)[source]

Bases: hawat.base.HawatBlueprint

Hawat pluggable module - DNS service.

classmethod get_module_title()[source]

Implementation of hawat.base.HawatBlueprint.get_module_title().

register_app(app)[source]

Callback method. Will be called from hawat.base.HawatApp.register_blueprint() method and can be used to customize the Flask application object. Possible use cases:

  • application menu customization

Parameters

app (hawat.base.HawatApp) – Flask application to be customize.

class hawat.blueprints.dnsr.SearchView[source]

Bases: hawat.base.HTMLMixin, hawat.blueprints.dnsr.AbstractSearchView

View responsible for querying DNS service and presenting the results in the form of HTML page.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

methods = ['GET']
class hawat.blueprints.dnsr.SnippetSearchView[source]

Bases: hawat.base.SnippetMixin, hawat.blueprints.dnsr.AbstractSearchView

View responsible for querying DNS service and presenting the results in the form of JSON document containing ready to use HTML page snippets.

classmethod get_view_name()[source]

Implementation of hawat.base.BaseView.get_view_name().

methods = ['GET', 'POST']
process_response_context()[source]

Implementation of hawat.base.SnippetMixin.process_response_context().

renders = ['label', 'full']
snippets = ['hostnames']
hawat.blueprints.dnsr.get_blueprint()[source]

Mandatory interface and factory function. This function must return a valid instance of hawat.base.HawatBlueprint or flask.Blueprint.