Dokumentace třídy Httpd::AbstractController

Virtuální třída pro vyřizování unifikovaných Http požadavků na server API. ...

#include <abstractcontroller.h>

Diagram dědičnosti pro třídu Httpd::AbstractController:

Veřejné metody
	AbstractController (HobrasoftHttpd::HttpConnection *parent)
	Konstruktor.
virtual void	service (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Obsluha požadavku.
void	setCheckId (bool x)
	Nastavuje kontrolu položky ID v datech při PUT a POST.
void	setAuthorizer (RequestAuthorizer *authorizer)
AuthenticatedUser *	authenticatedUser () const
bool	checkId () const
	Vrací stav kontroly položky ID v datech při PUT a POST.
Db::Database *	db ()

Chráněné metody
virtual bool	exists (const QString &id)
	Kontrola existence zadaného ID.
virtual bool	exists (HobrasoftHttpd::HttpRequest *request, const QString &id)
	Kontrola existence zadaného ID.
virtual void	serviceOK (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data=QVariant())
	Pošle odpověď 200 OK.
virtual void	serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString &error, const QVariantMap &data)
	Pošle chybovou odpověď
virtual void	serviceList (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.
virtual void	serviceEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response)
	Pošle v odpovědi kompletní seznam všech objektů ve třídě a následně
virtual void	serviceIdEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle v odpovědi proud událostí spojených se všemi objekty ve třídě
virtual void	serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle odpověď na požadavek konkrétního ID metodou GET.
virtual void	serviceIdDelete (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString &id)
	Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.
virtual void	serviceIdPut (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data)
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
virtual void	serviceIdPost (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariantMap &data)
	Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.
virtual void	serviceEvent (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QVariant &data)
	Pošle do otevřeného proudu událostí jednu událost.
virtual bool	isAuthorized (Security::Permissions::Permission)
HobrasoftHttpd::HttpRequest *	request () const
	Vrací ukazatel na aktuální request.
HobrasoftHttpd::HttpConnection *	connection () const
	Vrací ukazatel na aktuální connection.

Statické chráněné metody
static QVariantMap	putKey (const QVariant &key)

Detailní popis

Virtuální třída pro vyřizování unifikovaných Http požadavků na server API.

Třída vytváří šablonu pro tvorbu unifikovaných HTTP požadavků podle specifikace api. Požadavky jsou tvořené s pevnou strukturou, například:

http://localhost:8086/room
http://localhost:8086/room/events
http://localhost:8086/room/e40f2af7ea281baba30381db700311f7
http://localhost:8086/room/e40f2af7ea281baba30381db700311f7/events

Cesta je složená z několika komponent:

• /room - modul, kterého se týká. Pokud neuvedu další části cesty, vrací taková adresa okamžitý seznam všech objektů (zde pokojů)
• e40f2af7ea281baba30381db700311f7 - id objektu, který chci obsluhovat
• events - pokud se přidá na konec cesty slovo events, otevře se proud událostí, do kterého se začnou vypisovat všechny změny ve sledovaných objektech. Pokud je objektem celý seznam, vypisují se změny každého objektu v seznamu (zde změny na všech pokojích). Pokud je objektem konkrétní objekt, vypisují se pouze jeho změny (zde změny na konkrétním pokoji).

Pro obsluhu cest se volají různé metody:

• /room - serviceList()
• /room/events - serviceEvents()
• /room/e40f2af7ea281baba30381db700311f7 - podle HTTP metody požadavku se volá některá z metod serviceIdGet(), serviceIdDelete(), serviceIdPut(), serviceIdPost().
• /room/e40f2af7ea281baba30381db700311f7/events - volá se metoda serviceEvent()

Implementace odvozených tříd

Defaultní implementace vrací chybu 501. V odvozené třídě se musí implementovat všechny metody, které mají vracet užitečná data. Může být důležité implementovat i metodu exists() - tato metoda vrací bool hodnotu true, pokud dotazované ID existuje. Pokud metoda exists() vrátí false, defaultní implementace třídy vrátí jako odpověď na http požadavek chybu 404. Implementace konkrétní metody se tak nemusí starat o odesílání chybových stavů, například:

void ControllerRoom::serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString& id) {
    Pokoj *pokoj = SEZNAMPOKOJU->pokoj(id);
    if (pokoj == NULL) {
        // Pokoj neexistuje, chybu už nahlásila abstraktní třída
        // Kontrola zde je zbytečná, ale je riskantní test neprovádět
        return;
        }
    serviceOK(request, response, pokoj->webStatus());
}

Kontrola na existenci ID proběhla už v abstraktní třídě AbstractController, takže je v kódu zbytečná - k podobnému stavu by nemělo nikdy dojít. Kontrola je zde pouze pro jistoru, aby server nespadnul při nepředvídatelných událostech. Dobrodružné povahy mohou s velkou porcí jistoty zkrátit celou implementaci metody takto:

void ControllerRoom::serviceIdGet (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString& id) {
    serviceOK(request, response, SEZNAMPOKOJU->pokoj(id)->webStatus());
}

Implementace proudu událostí

Implementace proudu událostí se dá zjednodušit použitím metody serviceEvent(). Tato metoda posílá v odpovědi předaná data zformátovaná jako událost - postará se o správné zformátování a potlačí odeslání hlaviček. Implementace proudu událostí pak může vypadat takto (pro stručnost jsou vyházené kontroly):

void ControllerRoom::serviceEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response) {
    connect (SEZNAMPOKOJU, SIGNAL( statusChanged(const SkupinaJednotek *)),
             this,           SLOT(slotSendUpdate(const SkupinaJednotek *)));
 
    QList<SkupinaJednotek *> list = SEZNAMPOKOJU->skupiny().toList();
    for (int i=0; i<list.size(); i++) {
        slotSendUpdate(qobject_cast<Pokoj *>(list[i]));
        }
}
 
void ControllerRoom::serviceIdEvents (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, const QString& id) {
    connect(pokoj, SIGNAL(statusChanged(const SkupinaJednotek *)),
             this,   SLOT(slotSendUpdate(const SkupinaJednotek *)));
 
    slotSendUpdate(pokoj);
}
 
void ControllerRoom::slotSendUpdate(const SkupinaJednotek *skupina) {
    serviceEvent(NULL, NULL, pokoj->webStatusPresenceAndCall());
}

Viz také

API pro přístup k datům přes webový server

Definice je uvedena na řádku 132 v souboru abstractcontroller.h.

Dokumentace konstruktoru a destruktoru

AbstractController()

AbstractController::AbstractController

(

HobrasoftHttpd::HttpConnection *

parent

)

Konstruktor.

Definice je uvedena na řádku 20 v souboru abstractcontroller.cpp.

                                                                           : HobrasoftHttpd::HttpRequestHandler(parent) {
    m_authorizer = NULL;
    m_connection = parent;
    m_checkId = false;
}

Dokumentace členských funkcí

authenticatedUser()

AuthenticatedUser * Httpd::AbstractController::authenticatedUser ( ) const

inline

Definice je uvedena na řádku 153 v souboru abstractcontroller.h.

{ return m_authorizer->authenticatedUser(); }

checkId()

bool Httpd::AbstractController::checkId ( ) const

inline

Vrací stav kontroly položky ID v datech při PUT a POST.

Definice je uvedena na řádku 158 v souboru abstractcontroller.h.

{ return m_checkId; }

connection()

HobrasoftHttpd::HttpConnection * AbstractController::connection ( ) const

protected

Vrací ukazatel na aktuální connection.

Definice je uvedena na řádku 39 v souboru abstractcontroller.cpp.

                                                                   {
    return m_connection;
}

db()

Db::Database * AbstractController::db

(

)

Definice je uvedena na řádku 27 v souboru abstractcontroller.cpp.

                                   {
    return (authenticatedUser() != nullptr) 
        ? Db::Database::create(this, authenticatedUser())
        : Db::Database::create(this);
}

exists() [1/2]

virtual bool Httpd::AbstractController::exists ( const QString & id )

inlineprotectedvirtual

Kontrola existence zadaného ID.

Návratová hodnota

true pokud zadané ID existuje

V odvozených třídách by měla být metoda reimplementovaná. Na základě výsledků se rozhoduje, jestli se pošle jako odpověď na dotaz chyba 404, nebo se bude volat některá z dalších metod (serviceId(), serviceIdEvents(), serviceIdDelete()).

Definice je uvedena na řádku 174 v souboru abstractcontroller.h.

                                           { 
            Q_UNUSED(id); 
            return true; 
            }

exists() [2/2]

virtual bool Httpd::AbstractController::exists ( HobrasoftHttpd::HttpRequest * request, const QString & id )

inlineprotectedvirtual

Kontrola existence zadaného ID.

Návratová hodnota

true pokud zadané ID existuje

V odvozených třídách by měla být metoda reimplementovaná. Na základě výsledků se rozhoduje, jestli se pošle jako odpověď na dotaz chyba 404, nebo se bude volat některá z dalších metod (serviceId(), serviceIdEvents(), serviceIdDelete()).

Definice je uvedena na řádku 190 v souboru abstractcontroller.h.

                                                                               { 
            Q_UNUSED(request); 
            return exists(id); 
            }

isAuthorized()

bool AbstractController::isAuthorized ( Security::Permissions::Permission permission )

protectedvirtual

Definice je uvedena na řádku 44 v souboru abstractcontroller.cpp.

                                                                              {
    if (m_authorizer == NULL) {
        return true;
        }
    return m_authorizer->isAuthorized(permission);
}

putKey()

static QVariantMap Httpd::AbstractController::putKey ( const QVariant & key )

inlinestaticprotected

Definice je uvedena na řádku 305 v souboru abstractcontroller.h.

                                                   {
        QVariantMap data; 
        data["key"] = key; 
        data["ok"] = true; 
        return data;
        }

request()

HobrasoftHttpd::HttpRequest * AbstractController::request ( ) const

protected

Vrací ukazatel na aktuální request.

Definice je uvedena na řádku 34 v souboru abstractcontroller.cpp.

                                                             { 
    return m_request; 
}

service()

void AbstractController::service ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

virtual

Obsluha požadavku.

Reimplementováno v Httpd::ControllerOverview, Httpd::ControllerTimesheet a Httpd::ControllerUsers.

Definice je uvedena na řádku 52 v souboru abstractcontroller.cpp.

                                                                                                         {
    m_request = request;
    QString path = request->path();
    QStringList parts = path.split("/");
 
    if (parts.size() <= 1) {
        serviceError(request, response, 404, "not-found", "Object not found");
        return;
        }
 
    parts.removeFirst();
    if (parts.first() == "api") { parts.removeAt(0); }
    if (parts.first() == "v1") { parts.removeAt(0); }
 
    switch (parts.size()) {
        case 1:
            if (request->method() != "GET") {
                serviceError(request, response, 405, "bad-request", "Method not allowed");
                return;
                }
            serviceList(request, response);
            return;
 
        case 2:
            if (parts[1] == "events") {
                if (request->method() != "GET") {
                    serviceError(request, response, 405, "bad-request", "Method not allowed");
                    return;
                    }
                response->setHeader("Content-Type",      "text/event-stream");
                response->setHeader("Cache-Control",     "no-cache,public");
                response->setHeader("Transfer-Encoding", "chunked");
                if (!request->header("Referer").isEmpty()) {
                    QUrl referer = QUrl::fromUserInput(request->header("Referer"));
                    QUrl allow;
                    allow.setScheme(referer.scheme());
                    allow.setHost(referer.host());
                    allow.setPort(referer.port());
                    response->setHeader("Access-Control-Allow-Origin", allow.toString());
                    }
                response->flushSocket();
                serviceEvents(request, response);
                return;
                }
 
            if (parts[1] != "events") {
                QString id = parts[1];
                if (request->method() == "GET") {
                    if (!exists(request, id)) {
                        serviceError(request, response, 404, "not-found", "Not found");
                        return;
                        }
                    response->setHeader("Content-Type",  "application/json");
                    response->setHeader("Cache-Control", "no-cache,public");
                    serviceIdGet(request, response, id);
                    return;
                    }
                if (request->method() == "PUT") {
 
                    bool ok = false;
                    QVariantMap data = JSON::data(request->body(), &ok).toMap();
                    if (!ok) { 
                        serviceError(request, response, 400, "bad-request", "Could not parse JSON data");
                        return; 
                        }       
 
                    if (m_checkId && !data.contains("id")) {
                        serviceError(request, response, 400, "bad-request", "Data must contain ID");
                        return; 
                        } 
 
                    response->setHeader("Content-Type",  "application/json");
                    response->setHeader("Cache-Control", "no-cache,public");
                    serviceIdPut(request, response, data);
                    return;
                    }
                if (request->method() == "POST") {
 
                    bool ok = false;
                    QVariantMap data = JSON::data(request->body(), &ok).toMap();
                    if (!ok) { 
                        serviceError(request, response, 400, "bad-request", "Could not parse JSON data");
                        return; 
                        }       
 
                    if (m_checkId && !data.contains("id")) {
                        serviceError(request, response, 400, "bad-request", "Data must contain ID");
                        return; 
                        } 
 
                    response->setHeader("Content-Type",  "application/json");
                    response->setHeader("Cache-Control", "no-cache,public");
                    serviceIdPost(request, response, data);
                    return;
                    }
                if (request->method() == "DELETE") {
                    if (!exists(request, id)) {
                        serviceError(request, response, 404, "not-found", "Not found");
                        return;
                        }
                    response->setHeader("Content-Type",  "application/json");
                    response->setHeader("Cache-Control", "no-cache,public");
                    serviceIdDelete(request, response, id);
                    return;
                    }
                }
            return;
 
        case 3:
            if (parts[1] == "events" || parts[2] != "events") {
                serviceError(request, response, 404, "not-found", "Not found");
                return;
                }
 
            if (request->method() != "GET") {
                serviceError(request, response, 405, "bad-request", "Method not allowed");
                return;
                }
 
            if (!exists(request, parts[1])) {
                serviceError(request, response, 404, "not-found", "Not found");
                return;
                }
 
            response->setHeader("Content-Type",      "text/event-stream");
            response->setHeader("Cache-Control",     "no-cache,public");
            response->setHeader("Transfer-Encoding", "chunked");
            if (!request->header("Referer").isEmpty()) {
                QUrl referer = QUrl::fromUserInput(request->header("Referer"));
                QUrl allow;
                allow.setScheme(referer.scheme());
                allow.setHost(referer.host());
                allow.setPort(referer.port());
                response->setHeader("Access-Control-Allow-Origin", allow.toString());
                }
            response->flushSocket();
            serviceIdEvents(request, response, parts[1]);
            return;
 
        default:
            serviceError(request, response, 400, "bad-request", "Request could not be recognized");
            return;
        }
}

serviceError()

void AbstractController::serviceError ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, int code, const QString & error, const QVariantMap & data )

protectedvirtual

Pošle chybovou odpověď

Parametry

code	- chybový kód (například 404)
error	- chybový textový kód
reason	- vysvětlení chyby

Posílá odpověď zformátovanou takto:

Content-Type: application/json
Cache-Control: no-cache,public
 
404 not-found
{ "error" : "not-found", "reason" : "Not found" }

*/ virtual void serviceError (HobrasoftHttpd::HttpRequest *request, HobrasoftHttpd::HttpResponse *response, int code, const QString& error, const QString& reason);

/**

Pošle chybovou odpověď

Parametry

code	- chybový kód (například 404)
error	- chybový textový kód, píše se do HTTP statutu
reason	- vysvětlení chyby

Posílá odpověď zformátovanou takto:

Content-Type: application/json
Cache-Control: no-cache,public
 
404 text v parametru error
{ ..... }

Definice je uvedena na řádku 198 v souboru abstractcontroller.cpp.

                               {
 
    Q_UNUSED(request);
 
    QVariantMap data;
    data["error"]  = error;
    data["reason"] = reason;
 
    HobrasoftHttpd::HttpResponse *r = (response == nullptr) ? new HobrasoftHttpd::HttpResponse(connection()) : response;
    r->clearHeaders();
    r->setHeader("Content-Type",  "application/json");
    r->setHeader("Cache-Control", "no-cache,public");
    r->setStatus(code, error);
    r->write( JSON::json(data) );
    r->flush();
//  connection()->deleteLater();
}

serviceEvent()

void AbstractController::serviceEvent ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariant & data )

protectedvirtual

Pošle do otevřeného proudu událostí jednu událost.

I když je možné reimplementovat, obvykle pro to není důvod. Posílá do proudu událostí jednu událost.

Definice je uvedena na řádku 260 v souboru abstractcontroller.cpp.

                              { 
    Q_UNUSED(request);
    Q_UNUSED(response);
 
    // Pozor! Hlavička se neposílá, ale je potřeba
    // Skutečná hlavička se posílá v metodě service()
    HobrasoftHttpd::HttpResponse *lresponse = HttpRequestHandler::response();
    lresponse->setHeader("Transfer-Encoding", "chunked");
    lresponse->setHeader("Content-Type",      "text/event-stream");
    lresponse->setHeader("Cache-Control",     "no-cache,public");
    lresponse->setSendHeaders(false);
    
    QByteArray datagram;
    datagram += "event: status\n";
    datagram += "data: ";
    datagram += JSON::json(data);
    datagram += "\n";
    datagram += "\n";
    lresponse->write(datagram);
    lresponse->flushSocket();
    lresponse->flushAndDelete();
 
}

serviceEvents()

void AbstractController::serviceEvents ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

protectedvirtual

Pošle v odpovědi kompletní seznam všech objektů ve třídě a následně

Defaultní implementace posílá chybu 501 Not Implemented

Definice je uvedena na řádku 292 v souboru abstractcontroller.cpp.

                                                                                                                   {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceIdDelete()

void AbstractController::serviceIdDelete ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou DELETE - obvykle objekt smaže.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementováno v Httpd::ControllerCategories, Httpd::ControllerOverview, Httpd::ControllerStatuses, Httpd::ControllerStatusOrder, Httpd::ControllerTicketFiles, Httpd::ControllerTickets, Httpd::ControllerTicketStatus, Httpd::ControllerTicketsVw, Httpd::ControllerTicketTimesheets, Httpd::ControllerTicketValues, Httpd::ControllerUsers a Httpd::ControllerUsersCategories.

Definice je uvedena na řádku 302 v souboru abstractcontroller.cpp.

                                                                                                                                   {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceIdEvents()

void AbstractController::serviceIdEvents ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle v odpovědi proud událostí spojených se všemi objekty ve třídě

Obvyklá implementace pošle na začátku seznam všech objektů (jako události) a potom posílá už jen změny

Defaultní implementace posílá chybu 501 Not Implemented

Definice je uvedena na řádku 297 v souboru abstractcontroller.cpp.

                                                                                                                                   {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceIdGet()

void AbstractController::serviceIdGet ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QString & id )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou GET.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementováno v Httpd::ControllerCategories, Httpd::ControllerCategoriesSiblings, Httpd::ControllerCategoriesToRoot, Httpd::ControllerCategoriesTree, Httpd::ControllerOverview, Httpd::ControllerOverviewPublic, Httpd::ControllerServer, Httpd::ControllerStatuses, Httpd::ControllerStatusOrder, Httpd::ControllerStatusTemplates, Httpd::ControllerTicketFiles, Httpd::ControllerTickets, Httpd::ControllerTicketStatus, Httpd::ControllerTicketsVw, Httpd::ControllerTicketTimesheets, Httpd::ControllerTicketValues, Httpd::ControllerUsers a Httpd::ControllerUsersCategories.

Definice je uvedena na řádku 307 v souboru abstractcontroller.cpp.

                                                                                                                                   {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceIdPost()

void AbstractController::serviceIdPost ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementováno v Httpd::ControllerCategories, Httpd::ControllerServer, Httpd::ControllerStatuses, Httpd::ControllerStatusOrder, Httpd::ControllerTicketFiles, Httpd::ControllerTickets, Httpd::ControllerTicketStatus, Httpd::ControllerTicketsVw, Httpd::ControllerTicketTimesheets, Httpd::ControllerTicketValues, Httpd::ControllerUsers a Httpd::ControllerUsersCategories.

Definice je uvedena na řádku 317 v souboru abstractcontroller.cpp.

                                                                                                                                       {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceIdPut()

void AbstractController::serviceIdPut ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariantMap & data )

protectedvirtual

Pošle odpověď na požadavek konkrétního ID metodou PUT - obvykle vloží nový objekt nebo přepíše existující objekt.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementováno v Httpd::ControllerCategories, Httpd::ControllerServer, Httpd::ControllerStatuses, Httpd::ControllerStatusOrder, Httpd::ControllerTicketFiles, Httpd::ControllerTickets, Httpd::ControllerTicketStatus, Httpd::ControllerTicketsVw, Httpd::ControllerTicketTimesheets, Httpd::ControllerTicketValues, Httpd::ControllerUsers a Httpd::ControllerUsersCategories.

Definice je uvedena na řádku 312 v souboru abstractcontroller.cpp.

                                                                                                                                       {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceList()

void AbstractController::serviceList ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response )

protectedvirtual

Měl by poslat v odpovědi kompletní seznam všech objektů ve třídě a ukončit se.

Defaultní implementace posílá chybu 501 Not Implemented

Reimplementováno v Httpd::ControllerCategories, Httpd::ControllerCategoriesSiblings, Httpd::ControllerCategoriesTree, Httpd::ControllerOverview, Httpd::ControllerStatuses, Httpd::ControllerStatusOrder, Httpd::ControllerStatusTemplates, Httpd::ControllerTicketFiles, Httpd::ControllerTickets, Httpd::ControllerTicketStatus, Httpd::ControllerTicketsVw, Httpd::ControllerTicketTimesheets, Httpd::ControllerTicketValues, Httpd::ControllerUsers a Httpd::ControllerUsersCategories.

Definice je uvedena na řádku 287 v souboru abstractcontroller.cpp.

                                                                                                                   {
    serviceError(request, response, 501, "not-implemeted", "Method not implemented");
}

serviceOK()

void AbstractController::serviceOK ( HobrasoftHttpd::HttpRequest * request, HobrasoftHttpd::HttpResponse * response, const QVariant & data = QVariant() )

protectedvirtual

Pošle odpověď 200 OK.

Parametry

data	- pokud je zadaný, pošle se místo defaultního '{ "ok" : true }'

Definice je uvedena na řádku 242 v souboru abstractcontroller.cpp.

                              {
 
    Q_UNUSED(request);
 
    QVariantMap okdata;
    okdata["ok"] = true;
 
    if (!response->containsHeader("Content-Type"))  { response->setHeader("Content-Type",  "application/json"); }
    if (!response->containsHeader("Cache-Control")) { response->setHeader("Cache-Control", "no-cache,public"); }
    response->setStatus(200, "OK");
    response->write( JSON::json( (!data.isValid() || data.isNull()) ? okdata : data) );
    response->flush();
}

setAuthorizer()

void Httpd::AbstractController::setAuthorizer ( RequestAuthorizer * authorizer )

inline

Definice je uvedena na řádku 151 v souboru abstractcontroller.h.

{ m_authorizer = authorizer; }

setCheckId()

void Httpd::AbstractController::setCheckId ( bool x )

inline

Nastavuje kontrolu položky ID v datech při PUT a POST.

Definice je uvedena na řádku 149 v souboru abstractcontroller.h.

{ m_checkId = x; }

---

Dokumentace pro tuto třídu byla vygenerována z následujících souborů:

• httpd/abstractcontroller.h
• httpd/abstractcontroller.cpp