#include <otsdaq-utilities/Logbook/LogbookSupervisor.h>

Inheritance diagram for ots::LogbookSupervisor:

Collaboration diagram for ots::LogbookSupervisor:

Public Member Functions
	XDAQ_INSTANTIATOR ()

	LogbookSupervisor (xdaq::ApplicationStub *s)

void	init (void)

void	destroy (void)

virtual void	defaultPage (xgi::Input in, xgi::Output out) override

virtual void	request (const std::string &requestType, cgicc::Cgicc &cgiIn, HttpXmlDocument &xmlOut, const WebUsers::RequestUserInfo &userInfo) override

virtual void	nonXmlRequest (const std::string &requestType, cgicc::Cgicc &cgiIn, std::ostream &out, const WebUsers::RequestUserInfo &userInfo) override

virtual void	setSupervisorPropertyDefaults (void) override
	override to control supervisor specific defaults More...

virtual void	forceSupervisorPropertyValues (void) override
	override to force supervisor property values (and ignore user settings) More...

xoap::MessageReference	MakeSystemLogEntry (xoap::MessageReference msg)
	External Supervisor XOAP handlers. More...

Public Member Functions inherited from ots::CoreSupervisorBase
virtual std::string	getStatusProgressDetail (void)

void	stateMachineXgiHandler (xgi::Input in, xgi::Output out)

void	sendAsyncExceptionToGateway (const std::string &errMsg, bool isPauseException, bool isStopException)

virtual void	stateInitial (toolbox::fsm::FiniteStateMachine &fsm)

virtual void	statePaused (toolbox::fsm::FiniteStateMachine &fsm)

virtual void	stateRunning (toolbox::fsm::FiniteStateMachine &fsm)

virtual void	stateHalted (toolbox::fsm::FiniteStateMachine &fsm)

virtual void	stateConfigured (toolbox::fsm::FiniteStateMachine &fsm)

virtual void	transitionHalting (toolbox::Event::Reference event)

virtual void	transitionInitializing (toolbox::Event::Reference event)

Public Member Functions inherited from ots::SOAPMessenger
std::string	send (XDAQ_CONST_CALL xdaq::ApplicationDescriptor *d, xoap::MessageReference message)

Public Member Functions inherited from ots::CorePropertySupervisorBase
XDAQ_CONST_CALL xdaq::ApplicationDescriptor *	getGatewaySupervisorDescriptor (void)

void	getRequestUserInfo (WebUsers::RequestUserInfo &requestUserInfo)

ConfigurationTree	getSupervisorTreeNode (void)

void	loadUserSupervisorProperties (void)

std::string	getSupervisorProperty (const std::string &propertyName)

std::string	getSupervisorProperty (const std::string &propertyName, const std::string &defaultValue)

WebUsers::permissionLevel_t	getSupervisorPropertyUserPermissionsThreshold (const std::string &requestType)

Public Member Functions inherited from ots::RunControlStateMachine
virtual void	stateShutdown (toolbox::fsm::FiniteStateMachine &)

xoap::MessageReference	runControlMessageHandler (xoap::MessageReference message)

Additional Inherited Members
Static Public Member Functions inherited from ots::CorePropertySupervisorBase
static void	extractPermissionsMapFromString (const std::string &permissionsString, std::map< std::string, WebUsers::permissionLevel_t > &permissionsMap)

static bool	doPermissionsGrantAccess (std::map< std::string, WebUsers::permissionLevel_t > &permissionLevelsMap, std::map< std::string, WebUsers::permissionLevel_t > &permissionThresholdsMap)

Protected Attributes inherited from ots::CoreSupervisorBase
std::vector< bool >	stateMachinesIterationDone_

Protected Attributes inherited from ots::CorePropertySupervisorBase
ITRACEController *	theTRACEController_

Detailed Description

LogbookSupervisor This class handles the write and read requests for web users interfacing to the web desktop Logbook

Definition at line 12 of file LogbookSupervisor.h.

Member Function Documentation

◆ forceSupervisorPropertyValues()

void LogbookSupervisor::forceSupervisorPropertyValues ( void )

overridevirtual

override to force supervisor property values (and ignore user settings)

forceSupervisorPropertyValues override to force supervisor property values (and ignore user settings)

Reimplemented from ots::CorePropertySupervisorBase.

Definition at line 199 of file LogbookSupervisor.cc.

◆ MakeSystemLogEntry()

xoap::MessageReference LogbookSupervisor::MakeSystemLogEntry ( xoap::MessageReference msg )

External Supervisor XOAP handlers.

xoap::MakeSystemLogEntry make a system logbook entry into active category's logbook from Supervisor only TODO: (how to enforce?)

Definition at line 431 of file LogbookSupervisor.cc.

◆ nonXmlRequest()

void LogbookSupervisor::nonXmlRequest	(	const std::string &	requestType,
		cgicc::Cgicc &	cgiIn,
		std::ostream &	out,
		const WebUsers::RequestUserInfo &	userInfo
	)

overridevirtual

request Handles Web Interface requests to Logbook supervisor. Does not refresh cookie for automatic update checks.

Reimplemented from ots::CoreSupervisorBase.

Definition at line 393 of file LogbookSupervisor.cc.

◆ request()

void LogbookSupervisor::request	(	const std::string &	requestType,
		cgicc::Cgicc &	cgiIn,
		HttpXmlDocument &	xmlOut,
		const WebUsers::RequestUserInfo &	userInfo
	)

overridevirtual

request Handles Web Interface requests to Logbook supervisor. Does not refresh cookie for automatic update checks.

Reimplemented from ots::CoreSupervisorBase.

Definition at line 216 of file LogbookSupervisor.cc.

◆ setSupervisorPropertyDefaults()

void LogbookSupervisor::setSupervisorPropertyDefaults ( void )

overridevirtual

override to control supervisor specific defaults

setSupervisorPropertyDefaults override to set defaults for supervisor property values (before user settings override)

Reimplemented from ots::CorePropertySupervisorBase.

Definition at line 186 of file LogbookSupervisor.cc.

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

otsdaq-utilities/otsdaq-utilities/Logbook/LogbookSupervisor.h
otsdaq-utilities/otsdaq-utilities/Logbook/LogbookSupervisor.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ forceSupervisorPropertyValues()

◆ MakeSystemLogEntry()

◆ nonXmlRequest()

◆ request()

◆ setSupervisorPropertyDefaults()