ServerSettings Class Reference

#include <Authentication/Common/serversettings.h>

Inheritance diagram for ServerSettings:

Public Member Functions
	ServerSettings (const QString &organisation, const QString &application, QSettings::Scope scope)
	ServerSettings (const ServerSettings &)=delete
	~ServerSettings () override
AuthenticatedEntities &	getAuthenticatedEntities ()
const AuthenticatedEntities &	getAuthenticatedEntities () const
bool	getRemoteSchedulerEnabled (const QString &typeId) const
bool	load (bool needAuthentication=true)
ServerSettings &	operator= (const ServerSettings &)=delete
bool	save ()
void	setRemoteSchedulerEnabled (const QString &typeId, bool enable)
Public Member Functions inherited from SettingContainer
	SettingContainer (const QString &organisation, const QString &application, QSettings::Scope scope)
	SettingContainer (const SettingContainer &)=delete
virtual	~SettingContainer ()
void	add (const bool &defaultValue, const QString &key, const SettingItem< bool > &tag)
void	add (const int &defaultValue, const QString &key, const SettingItem< int > &tag)
void	add (const QString &defaultValue, const QString &key, const SettingItem< QString > &tag)
void	addNested (const QString &key)
SettingContainer &	getNested (const QString &key)
QSettings::Scope	getScope () const
bool	getValue (const SettingItem< bool > &tag, QPair< bool, bool > defaultValue=qMakePair(false, false)) const
int	getValue (const SettingItem< int > &tag, QPair< bool, int > defaultValue=qMakePair(false, 0)) const
QString	getValue (const SettingItem< QString > &tag, QPair< bool, QString > defaultValue=qMakePair(false, QString())) const
void	inherit (const SettingItem< bool > &tag)
void	inherit (const SettingItem< int > &tag)
void	inherit (const SettingItem< QString > &tag)
bool	isInherited (const SettingItem< bool > &tag) const
bool	isInherited (const SettingItem< int > &tag) const
bool	isInherited (const SettingItem< QString > &tag) const
bool	isMissing (const SettingItem< bool > &tag) const
bool	isMissing (const SettingItem< int > &tag) const
bool	isMissing (const SettingItem< QString > &tag) const
bool	isWritable ()
bool	load ()
bool	load (QSettings &settings)
SettingContainer &	operator= (const SettingContainer &)=delete
bool	save () const
bool	save (QSettings &settings) const
void	setValue (const SettingItem< bool > &tag, bool value)
void	setValue (const SettingItem< int > &tag, int value)
void	setValue (const SettingItem< QString > &tag, QString value)

Static Public Attributes
static const SettingItem< QString >	defaultWorkingDirectory
static const SettingItem< QString >	enabledRemoteSchedulers
static const SettingItem< QString >	logFilePath
static const SettingItem< int >	maxConcurrentWorkspace
static const SettingItem< bool >	serverLoggingEnabled

Protected Member Functions
QString	getSystemFileSpec () const
bool	loadAuthenticatedEntities ()
bool	loadSystemDefinedSettings ()
bool	saveAuthenticatedEntities ()
bool	saveSystemDefinedSettings ()

Detailed Description

Manages settings associated with an authentication server.

Constructor & Destructor Documentation

ServerSettings() [1/2]

ServerSettings	(	const QString &	organisation,
		const QString &	application,
		QSettings::Scope	scope
	)

ServerSettings() [2/2]

ServerSettings ( const ServerSettings &  )

delete

~ServerSettings()

~ServerSettings ( )

overridedefault

Destructor.

Member Function Documentation

getAuthenticatedEntities() [1/2]

AuthenticatedEntities & getAuthenticatedEntities ( )

inline

getAuthenticatedEntities() [2/2]

const AuthenticatedEntities & getAuthenticatedEntities

(

)

const

Returns the set of pre-authenticated entities.

Returns

Returns the set of pre-authenticated entities.

getRemoteSchedulerEnabled()

bool getRemoteSchedulerEnabled

(

const QString &

typeId

)

const

Parameters

typeId

TypeId of AbstractRemoteScheduler

Returns

True if the remote scheduler is enabled.

getSystemFileSpec()

QString getSystemFileSpec ( ) const

protected

Returns the name of the system settings area.

Returns

the name of the system settings area.

load()

bool load

(

bool

needAuthentication = true

)

Loads the server settings from the settings area.

Returns

Returns true if the settings were successfully loaded.

loadAuthenticatedEntities()

bool loadAuthenticatedEntities ( )

protected

Loads the authenticated entities list from the settings store.

Returns

Returns true if the settings were loaded successfully.

loadSystemDefinedSettings()

bool loadSystemDefinedSettings ( )

protected

Loads settings from system settings store.

Returns

Returns true if the settings were loaded successfully.

operator=()

ServerSettings & operator= ( const ServerSettings &  )

delete

save()

bool save

(

)

Saves the settings to the settings store.

Returns

Returns true if the settings were saved successfully.

saveAuthenticatedEntities()

bool saveAuthenticatedEntities ( )

protected

Save the authenticated entities list to the setting store.

Returns

Returns true if the settings were saved successfully.

saveSystemDefinedSettings()

bool saveSystemDefinedSettings ( )

protected

Saves the system defined settings to the system settings store.

Returns

Returns true if the settings were saved successfully.

setRemoteSchedulerEnabled()

void setRemoteSchedulerEnabled	(	const QString &	typeId,
		bool	enable
	)

Parameters

typeId	TypeId of AbstractRemoteScheduler
enable	True to enable the remote scheduler.

Enable/disable remote schedulers.

Member Data Documentation

defaultWorkingDirectory

const SettingItem< QString > defaultWorkingDirectory

static

enabledRemoteSchedulers

const SettingItem< QString > enabledRemoteSchedulers

static

logFilePath

const SettingItem< QString > logFilePath

static

maxConcurrentWorkspace

const SettingItem< int > maxConcurrentWorkspace

static

serverLoggingEnabled

const SettingItem< bool > serverLoggingEnabled

static