The admin node is a VFS_application plugin providing administration tools for the VFS. More...

#include <admin.h>

Inheritance diagram for admin:

Public Member Functions
Q_INVOKABLE	admin (QString authPaths, QString sessions, QString browserURL="")
	admin constructor More...

virtual	~admin ()

Public Member Functions inherited from VFS_application
Q_INVOKABLE	VFS_application (QString settingsRoot="")
	Construct a VFS_application object. More...

virtual	~VFS_application ()

virtual VFS_node *	find (VFS_request *r)
	Check if a resource (path) is available for this application. 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 bool	isContainer ()
	A VFS_node may have children. 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 icon. More...

Protected Member Functions inherited from VFS_application
virtual void	ls (VFS_request *r)
	List the contents of this node. More...

Protected Member Functions inherited from VFS_node
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	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...

Private Member Functions
virtual void	aclDefaults (VFS_request *r)
	Return default values and features associated wth this node. More...

virtual void	metadata (VFS_request *r)
	Return metadata about this node. More...

virtual void	read (VFS_request *r)
	Read the list of admin modules. More...

Additional Inherited Members
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...

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 Slots inherited from VFS_application
virtual void	initialize ()
	The default implementation does nothing. More...

Protected Attributes inherited from VFS_application
QString	_settingsRoot
	The base path for future settings. 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 admin node is a VFS_application plugin providing administration tools for the VFS.

Definition at line 7 of file admin.h.

Constructor & Destructor Documentation

◆ admin()

admin::admin	(	QString	authPaths,
		QString	sessionsPath,
		QString	browserURL = `""`
	)

explicit

admin constructor

Parameters

authPaths	The authorization paths for the sessions instance
sessionsPath	The sessions container for the sessions instance
browserURL	If present and not an empty string, the path for the browser iframe.

Definition at line 25 of file admin.cpp.

◆ ~admin()

admin::~admin ( )

virtual

Definition at line 37 of file admin.cpp.

Member Function Documentation

◆ aclDefaults()

void admin::aclDefaults ( VFS_request * r )

privatevirtual

Return default values and features associated wth this node.

Parameters

r	The VFS_request object

The un-subclassed case will return { "default":true }, which will allow access in all cases.

Note: A subclass that does provide a default in aclDefaults will produce a confusing interface, where the default may be true, but the aclEditor interface will show false until explicitly set.

See also: users_acl

Reimplemented from VFS_node.

Definition at line 92 of file admin.cpp.

◆ icon()

QByteArray admin::icon ( )

protectedvirtual

Return the icon.

Returns: The icon

Reimplemented from VFS_application.

Definition at line 46 of file admin.cpp.

◆ metadata()

void admin::metadata ( VFS_request * r )

privatevirtual

Return metadata about this node.

Parameters

r	The VFS_request object

Reimplemented from VFS_node.

Definition at line 68 of file admin.cpp.

◆ read()

void admin::read ( VFS_request * r )

privatevirtual

Read the list of admin modules.

Parameters

r	The VFS_request object.

Reimplemented from VFS_node.

Definition at line 58 of file admin.cpp.

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

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ admin()

◆ ~admin()

Member Function Documentation

◆ aclDefaults()

◆ icon()

◆ metadata()

◆ read()