EManagementHandler Class Reference

Pure virtual base class for an administrative management interface handler. More...

#include <emgmt.h>

Public Types
enum	HttpMethod { HttpMethod::httpGet, HttpMethod::httpPost, HttpMethod::httpPut, HttpMethod::httpDelete }
	Represents the type of the handler. More...

Public Member Functions
	EManagementHandler (HttpMethod mthd, cpStr pth, ELogger &audit)
	Class constructor. More...
	EManagementHandler (HttpMethod mthd, const std::string &pth, ELogger &audit)
	Class constructor. More...
virtual Void	process (const Pistache::Http::Request &request, Pistache::Http::ResponseWriter &response)=0
	Pure virtual method that will be called by handler() to perform the processing. More...
Void	handler (const Pistache::Http::Request &request, Pistache::Http::ResponseWriter response)
	HTTP handler that will be called by the Pistache framework. More...
const EString &	path ()
	Returns the route path for this HTTP handler. More...
HttpMethod	httpMethod ()
	Returns the HTTP method for this HTTP handler. More...

Protected Member Functions
Pistache::Rest::Route::Handler	getHandler ()

Friends
class	EManagementEndpoint

Detailed Description

Pure virtual base class for an administrative management interface handler.

Member Enumeration Documentation

HttpMethod

enum EManagementHandler::HttpMethod

strong

Represents the type of the handler.

Enumerator
httpGet	HTTP GET.
httpPost	HTTP POST.
httpPut	HTTP PUT.
httpDelete	HTTP DELETE.

Constructor & Destructor Documentation

EManagementHandler() [1/2]

EManagementHandler::EManagementHandler	(	HttpMethod	mthd,
		cpStr	pth,
		ELogger &	audit
	)

Class constructor.

Parameters

mthd	HTTP method associated with this handler.
pth	the HTTP route for this handler.
audit	a reference to the ELogger object that will log all management operations.

EManagementHandler() [2/2]

EManagementHandler::EManagementHandler	(	HttpMethod	mthd,
		const std::string &	pth,
		ELogger &	audit
	)

Class constructor.

Parameters

mthd	HTTP method associated with this handler.
pth	the HTTP route for this handler.
audit	a reference to the ELogger object that will log all management operations.

Member Function Documentation

getHandler()

Pistache::Rest::Route::Handler EManagementHandler::getHandler ( )

protected

handler()

Void EManagementHandler::handler	(	const Pistache::Http::Request &	request,
		Pistache::Http::ResponseWriter	response
	)

HTTP handler that will be called by the Pistache framework.

Parameters

request	HTTP request object.
response	HTTP response object.

httpMethod()

HttpMethod EManagementHandler::httpMethod ( )

inline

Returns the HTTP method for this HTTP handler.

path()

const EString& EManagementHandler::path ( )

inline

Returns the route path for this HTTP handler.

process()

virtual Void EManagementHandler::process ( const Pistache::Http::Request &  request, Pistache::Http::ResponseWriter &  response  )

pure virtual

Pure virtual method that will be called by handler() to perform the processing.

Parameters

request	HTTP request object.
response	HTTP response object.

Friends And Related Function Documentation

EManagementEndpoint

friend class EManagementEndpoint

friend

---

The documentation for this class was generated from the following files:

• /home/vagrant/share/code/epctools/include/epc/emgmt.h
• /home/vagrant/share/code/epctools/src/emgmt.cpp