Automated REST method dispatching. More...

Inheritance diagram for Cutelyst::ActionREST:

[legend]

Public Member Functions
	ActionREST (QObject *parent=nullptr)
Public Member Functions inherited from Cutelyst::Action
	Action (QObject *parent=nullptr)
virtual	~Action () override=default
QString	attribute (const QString &name, const QString &defaultValue={}) const
ParamsMultiMap	attributes () const noexcept
QString	className () const noexcept
Controller *	controller () const noexcept
bool	dispatch (Context *c)
virtual bool	match (int numberOfArgs) const noexcept
virtual bool	matchCaptures (int numberOfCaptures) const noexcept
virtual Modifiers	modifiers () const override
QString	ns () const noexcept
virtual qint8	numberOfArgs () const
virtual qint8	numberOfCaptures () const
void	setAttributes (const ParamsMultiMap &attributes)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
virtual	~Component () override
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
QString	name () const noexcept
QString	reverse () const noexcept
void	setName (const QString &name)
void	setReverse (const QString &reverse)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char signal, const QObject receiver, const char *method) const const
bool	disconnect (const QObject receiver, const char method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject watched, QEvent event)
T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const
T	findChild (Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQmlExposed () const const
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
void	killTimer (Qt::TimerId id)
virtual const QMetaObject *	metaObject () const const
bool	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
bool	doExecute (Context *c) override
Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate ptr, QObject parent=nullptr)
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)
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 const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }
Public Types inherited from QObject
enum	TimerId
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 context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)
bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)
QString	tr (const char sourceText, const char disambiguation, int n)
Public Attributes inherited from QObject
	Invalid
typedef	QObjectList
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 14 of file actionrest.h.

Constructor & Destructor Documentation

◆ ActionREST()

ActionREST::ActionREST ( QObject * parent = nullptr )

explicit

Constructs a new ActionREST object with the given parent.

Definition at line 55 of file actionrest.cpp.

References Cutelyst::Action::Action(), QObject::QObject(), and QObject::parent().

Referenced by doExecute().

Member Function Documentation

◆ doExecute()

bool ActionREST::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against context c.

Reimplemented from Cutelyst::Action.

Definition at line 60 of file actionrest.cpp.

References Cutelyst::Action::Action(), ActionREST(), Cutelyst::Action::doExecute(), Cutelyst::Context::execute(), and Cutelyst::Context::request.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ActionREST()

Member Function Documentation

◆ doExecute()