Automated REST Method Dispatching. More...
#include <Cutelyst/Actions/REST/ActionREST>
Inheritance diagram for Cutelyst::ActionREST:
Public Member Functions | |
| ActionREST (QObject *parent=nullptr) | |
 Public Member Functions inherited from Cutelyst::Action | |
| Action (QObject *parent=nullptr) | |
| QString | attribute (const QString &name, const QString &defaultValue=QString()) const |
| QMap< QString, QString > | attributes () const |
| QString | className () const |
| Controller * | controller () const |
| bool | dispatch (Context *c) |
| virtual bool | match (int numberOfArgs) const |
| virtual bool | matchCaptures (int numberOfCaptures) const |
| virtual Modifiers | modifiers () const override |
| QString | ns () const |
| virtual qint8 | numberOfArgs () const |
| virtual qint8 | numberOfCaptures () const |
| void | setAttributes (const QMap< QString, QString > &attributes) |
| Public Member Functions inherited from Cutelyst::Component | |
| Component (QObject *parent=nullptr) | |
| bool | execute (Context *c) |
| virtual bool | init (Application *application, const QVariantHash &args) |
| QString | name () const |
| QString | reverse () const |
| void | setName (const QString &name) |
| void | setReverse (const QString &reverse) |
| Public Member Functions inherited from QObject | |
| QObject (QObject *parent) | |
| bool | blockSignals (bool block) |
| const QObjectList & | children () const |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
| void | deleteLater () |
| void | destroyed (QObject *obj) |
| bool | disconnect (const char *signal, const QObject *receiver, const char *method) const |
| bool | disconnect (const QObject *receiver, const char *method) const |
| void | dumpObjectInfo () |
| void | dumpObjectTree () |
| QList< QByteArray > | dynamicPropertyNames () const |
| virtual bool | event (QEvent *e) |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| T | findChild (const QString &name, Qt::FindChildOptions options) const |
| QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const |
| QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const |
| QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const |
| bool | inherits (const char *className) const |
| void | installEventFilter (QObject *filterObj) |
| bool | isWidgetType () const |
| bool | isWindowType () const |
| void | killTimer (int id) |
| virtual const QMetaObject * | metaObject () const |
| void | moveToThread (QThread *targetThread) |
| QString | objectName () const |
| void | objectNameChanged (const QString &objectName) |
| QObject * | parent () const |
| QVariant | property (const char *name) const |
| void | removeEventFilter (QObject *obj) |
| void | setObjectName (const QString &name) |
| void | setParent (QObject *parent) |
| bool | setProperty (const char *name, const QVariant &value) |
| bool | signalsBlocked () const |
| int | startTimer (int interval, Qt::TimerType timerType) |
| QThread * | thread () const |
Protected Member Functions | |
| bool | doExecute (Context *c) override |
| Protected Member Functions inherited from Cutelyst::Action | |
| Action (ActionPrivate *ptr, QObject *parent=nullptr) | |
| A derived class using pimpl should call this constructor, to reduce the number of memory allocations. | |
| void | setController (Controller *controller) |
| void | setMethod (const QMetaMethod &method) |
| void | setupAction (const QVariantHash &args, Application *app) |
| Protected Member Functions inherited from Cutelyst::Component | |
| Component (ComponentPrivate *d, QObject *parent=nullptr) | |
| A derived class using pimpl should call this constructor, to reduce the number of memory allocations. | |
| virtual bool | afterExecute (Context *c) |
| void | applyRoles (const QStack< Component * > &roles) |
| virtual bool | aroundExecute (Context *c, QStack< Component * > stack) |
| virtual bool | beforeExecute (Context *c) |
| virtual bool | dispatcherReady (const Dispatcher *dispatch, Controller *controller) |
| Protected Member Functions inherited from QObject | |
| virtual void | childEvent (QChildEvent *event) |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | customEvent (QEvent *event) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| int | receivers (const char *signal) const |
| QObject * | sender () const |
| int | senderSignalIndex () const |
| virtual void | timerEvent (QTimerEvent *event) |
Additional Inherited Members | |
| Public Types inherited from Cutelyst::Component | |
| enum | Modifier { None, OnlyExecute, BeforeExecute, AroundExecute, AfterExecute } |
| Static Public Member Functions inherited from QObject | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
| QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
| QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
| QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
| QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
| bool | disconnect (const QMetaObject::Connection &connection) |
| bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
| bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
| bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
| QString | tr (const char *sourceText, const char *disambiguation, int n) |
| QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
| Properties inherited from QObject | |
| objectName | |
Detailed Description
C_ATTR(foo, :Local :ActionClass(REST))
void foo(Context *c); // do setup for HTTP method specific handlers
C_ATTR(foo_GET, :Private)
void foo_GET(Context *c); // do something for GET requests
C_ATTR(foo_PUT, :Private)
void foo_PUT(Context *c); // do something for PUT requests
This Action handles doing automatic method dispatching for REST requests. It takes a normal Cutelyst action, and changes the dispatch to append an underscore and method name. First it will try dispatching to an action with the generated name, and failing that it will try to dispatch to a regular method.
For example, in the synopsis above, calling GET on "/foo" would result in the foo_GET method being dispatched.
If a method is requested that is not implemented, this action will return a status 405 (Method Not Found). It will populate the "Allow" header with the list of implemented request methods. You can override this behavior by implementing a custom 405 handler like so:
C_ATTR(foo_not_implemented, :Private)
void foo_not_implemented(Context *c); // handle not implemented methods
If you do not provide an _OPTIONS method, we will automatically respond with a 200 OK. The "Allow" header will be populated with the list of implemented request methods. If you do not provide an _HEAD either, we will auto dispatch to the _GET one in case it exists.
Definition at line 28 of file actionrest.h.
Constructor & Destructor Documentation
|
explicit |
Constructs a new ActionREST object with the given parent.
Definition at line 62 of file actionrest.cpp.
Member Function Documentation
|
overrideprotectedvirtual |
Execute this action against
Reimplemented from Cutelyst::Action.
Definition at line 66 of file actionrest.cpp.
References Cutelyst::Action::doExecute().
