VFS_auth Class Reference

The base class for authenticating users. More...

#include <VFS_auth.h>

Inheritance diagram for VFS_auth:

Public Slots
virtual void	executeRequest (VFS_request *t)
	Execute a VFS_request. More...
Public Slots inherited from VFS_node
virtual void	applyDiff (VFS_request *r)
	Apply a diff received via subscription. More...
virtual void	executeRequest (VFS_request *t)
	Based on the VFS_request::requestType, execute the function associated with an operation. More...
void	notifySubscribers (VFS_node *origin, VFS_request *t)
	Propagate a diff to subscribers. More...
virtual void	receiveResponse (VFS_request *t)
	Once a VFS_request has been completed, a response will be issued back to its _origin. More...
void	remove (bool andDelete)
	Remove a child node. More...
virtual void	remove (VFS_node *node=nullptr, QString *name=nullptr, QString user="server")
	Remove a child node from this node. More...
virtual void	subtreeRequest (VFS_request *t)
	find() the target of a VFS_request, and execute the request More...
virtual void	unsubscribeAll (VFS_node *n)
	Remove all references to a subscriber from this node. More...

Public Member Functions
	VFS_auth ()
virtual	~VFS_auth ()
virtual VFS_node *	find (VFS_request *r)
	Find a node using a VFS_request. More...
virtual bool	isContainer ()
	A VFS_auth node cannot contain children. More...
Public Member Functions inherited from VFS_node
Q_INVOKABLE	VFS_node ()
	The VFS_node constructor will add its instance to the VFS_node::__allNodes global node registry, observing thread safety rules. More...
virtual	~VFS_node ()
	VFS_node destructor. More...
virtual VFS_node *	append (QString name, VFS_node *node, bool containerCheck=true, QString user="server")
	Append a VFS_node as a child of this node. More...
QString	className ()
	Return the class name of a node. More...
virtual VFS_request *	createRequest (VFS_request::requestType type, QString path, QString user="unknown", QJsonDocument data=QJsonDocument(), QJsonObject metadata=QJsonObject(), bool dontDelete=false)
	Create a new VFS_request with this object as _origin. More...
VFS_node *	find (QString path)
	Find a node by string path. More...
VFS_node *	findChildWithName (QString name)
	Check if a child with a given name exists. More...
virtual VFS_node *	mount ()
	Mount this node. More...
virtual QString	reportDetails ()
	Additional details for a generated report. More...
QString	uniqueChildName (QString name)
	Generate a unique child name. More...
virtual VFS_node *	unmount ()
	Unmount this node. More...
virtual bool	validChildName (QString name)
	Check if a node name is valid. More...

Protected Member Functions
virtual QByteArray	icon ()
	Return the users icon from VFS_icons. More...
Protected Member Functions inherited from VFS_node
virtual void	aclDefaults (VFS_request *r)
	Return default values and features associated wth this node. More...
void	addACLDefault (QJsonObject &acl, bool value, QString description="")
	Add a default value to the acl object. More...
void	addACLFeature (QJsonObject &acl, QString feature, bool value, QString description="")
	Add a feature to the acl object. More...
void	addACLFeatureGroup (QJsonObject &acl, QString feature, QString group, bool value)
	Add a feature group to the acl object. More...
void	addACLFeatureUser (QJsonObject &acl, QString feature, QString user, bool value)
	Add a feature user to the acl object. More...
void	addACLGroup (QJsonObject &acl, QString group, bool value)
	Add a group to the acl object. More...
void	addACLUser (QJsonObject &acl, QString user, bool value)
	Add a user to the acl object. More...
virtual void	issueRequest (VFS_node *target, VFS_request *t)
	Issue a VFS_request to its target. More...
virtual void	issueRequest (VFS_request *t)
	A convenience function. More...
virtual void	issueResponse (VFS_request *t)
	Once a request has been completed, issue a response. More...
virtual void	ls (VFS_request *r)
	List the contents of this node. More...
virtual void	metadata (VFS_request *r)
	Fetch the metadata of this node. More...
virtual void	read (VFS_request *r)
	Return the data contents of this node, or if it's a container call ls() More...
virtual void	releaseLock (VFS_request *r)
	Release a lock on this node. More...
virtual void	report (VFS_request *r)
	Report debugging information about the current state of this node. More...
virtual void	requestLock (VFS_request *r)
	Request a lock on this node. More...
virtual void	rm (VFS_request *r)
	Remove a child entry from a node, or the node itself. More...
virtual void	submit (VFS_request *r)
	Submit a diff to a node. More...
virtual void	subscribe (VFS_request *r)
	Add an entry to this node's _subscription list. More...
virtual void	unsubscribe (VFS_request *r)
	Remove an entry from this node's _subscription list. More...
virtual void	unsubscribePath (QString path)
	Unsubscribe all references to a subpath. More...
virtual void	write (VFS_request *r)
	Write data to this node. More...

Additional Inherited Members
Signals inherited from VFS_node
void	diff (VFS_node *origin, VFS_request *t)
	Emit a diff, which will trigger notifySubscribers() for a mounted node. More...
void	finished (bool andDelete=false)
	Emitted if a thread fails to create its node, or a node is rm()'d, or any other reason a node has completed its lifecycle. It is deleted if andDelete==true. More...
void	mounted ()
	Emitted when a node is mount()ed. More...
void	unmounted (VFS_node *self)
	Emitted when a node is unmount()ed. More...
Static Public Member Functions inherited from VFS_node
static bool	__isNode (VFS_node *)
	Check to see if a node is in the global registry. More...
static QString	code (QString nodename, QString libname, QString &error)
	Fetch code or any other resource from a node. More...
Protected Attributes inherited from VFS_node
VFS_children	_children
	This node's children. More...
QMutex	_lock
	A recursive mutex that is local to this node. More...
VFS_subscriptionType	_subscribers
	This node's subscribers. These subscribers will receive diff notifications. More...

Detailed Description

The base class for authenticating users.

All authenticator types should inherit from this class.

A node wanting to authenticate will read from an auth node and will provide credentials in the data of the request.

The success (or failure) of the read will determine if the user is authenticated.

Definition at line 6 of file VFS_auth.h.

Constructor & Destructor Documentation

VFS_auth()

VFS_auth::VFS_auth ( )

explicit

Definition at line 18 of file VFS_auth.cpp.

~VFS_auth()

VFS_auth::~VFS_auth ( )

virtual

Definition at line 23 of file VFS_auth.cpp.

Member Function Documentation

executeRequest

void VFS_auth::executeRequest ( VFS_request *  t )

virtualslot

Execute a VFS_request.

Parameters

t	The VFS_request object

An auth node can only perform metadata(), read(), ls(), and report(). All other VFS functions are disabled in this subclass.

Todo:

write() will be added in the future to support the ability to change or add user information.

Definition at line 73 of file VFS_auth.cpp.

find()

VFS_node * VFS_auth::find ( VFS_request *  r )

virtual

Find a node using a VFS_request.

Parameters

r	The VFS_request object

Returns

Always returns this.

This can be subclassed for special cases.

See also

VFS_node::find(VFS_request *r)

Reimplemented from VFS_node.

Definition at line 47 of file VFS_auth.cpp.

icon()

QByteArray VFS_auth::icon ( )

protectedvirtual

Return the users icon from VFS_icons.

Returns

The users icon

Reimplemented from VFS_node.

Definition at line 32 of file VFS_auth.cpp.

isContainer()

bool VFS_auth::isContainer ( )

virtual

A VFS_auth node cannot contain children.

Returns

false

Reimplemented from VFS_node.

Definition at line 59 of file VFS_auth.cpp.

---

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

• VFS_auth.h
• VFS_auth.cpp