Harpseal API Server

WebServer

The web server is based on aiohttp package.

class harpseal.web.WebServer(parent)

Bases: object

Harpseal WebServer Class

Parameters:parent – Harpseal instance

authenticate_middleware(app, handler)

Deny if key is set and does not match with key parameter given.

execute()

Start a web server.

jsonp_middleware(app, handler)

Retrurn data as JSONP callback format when callback parameter given.

parent = None

(harpseal.app.Harpseal) Harpseal instance

router = None

(harpseal.web.router.Router) Web router

whitelist = None

(list) IP whitelist

whitelist_middleware(app, handler)

Deny if user’s ipaddress is not in the whitelist.

Web Classes

class harpseal.web.classes.Response(body=None, status=200, reason=None, headers=None)

Bases: aiohttp.web_reqrep.StreamResponse

Response object.

body

(byte) Response content (utf-8 data)

write_eof()

class harpseal.web.classes.MockRequest(get, match_info)

Bases: object

Mock object for aiohttp.web.Request.

Web Router

class harpseal.web.router.Router(app, plugins)

Bases: object

Router object

add_routes()

Add a route that will redirect request to a suitable method of the handler.

Web Handler

class harpseal.web.handler.Handler(plugins)

Bases: object

Handler object.

get_plugin_list(withdetails=False)

Get plugin list.

Parameters:withdetails (bool) – True if you want to get plugin list with details.

get_plugin_logs(name, gte, lte=None)

Get plugin logs.

Parameters:

• name (str) – Plugin name
• gte – Greater than or equal to (created time)
• lte – Less than or equal to (created time)

parse_comptarget(req)

Prase GET fragments that would includes optional arguments such as gte and lte.

plugin_handler(req)

plugin_list_handler(req)

Return plugin list.

plugins_handler(req)

Return all plugin logs.

raise_error(reason='')

Create an dict that represents error during the handling of the request.

websocket_handler(req)

Handling websocket connections.