ConfigRPC_Callback Class Reference

#include <ConfigRPC.h>

Inheritance diagram for ConfigRPC_Callback:

List of all members.

---

Detailed Description

Base class for callbacks from ConfigRPC.

The facility whose configuration is being accessed using XML-RPC through ConfigRPC may derive a class from this that implements additional actions.

The default actions provided by the base class are to allow no access and no-ops for the modified and deleted callbacks.

Note:

This base class may be useful during debugging, because it imposes no security, but it should not be used in released code.

Public Types
enum	Method {   Version,   Get,   Set,   Delete,   NumMethods }
	Method identifiers for accessAllowed. More...
Public Member Functions
	ConfigRPC_Callback ()
virtual XmlRpcMethod::ExecutionStatus	accessAllowed (const HttpRequestContext &requestContext, Method method) const
	Access check function.
virtual void	modified ()
	Invoked after the database has been modified.
virtual	~ConfigRPC_Callback ()
Protected Member Functions
const char *	methodName (Method method) const
Private Member Functions
	ConfigRPC_Callback (const ConfigRPC_Callback &nocopy)
	no copy constructor
ConfigRPC_Callback &	operator= (const ConfigRPC_Callback &noassignment)
	no assignment operator

---

Member Enumeration Documentation

enum Method

Method identifiers for accessAllowed.

Enumerator:

Version	configurationParameter.version
Get	configurationParameter.get
Set	configurationParameter.set
Delete	configurationParameter.delete
NumMethods

---

Constructor & Destructor Documentation

ConfigRPC_Callback

(

)

~ConfigRPC_Callback

(

)

[virtual]

ConfigRPC_Callback

(

const ConfigRPC_Callback &

nocopy

)

[private]

no copy constructor

---

Member Function Documentation

XmlRpcMethod::ExecutionStatus accessAllowed	(	const HttpRequestContext &	requestContext,
		Method	method
	)			const [virtual]

Access check function.

Returns:

• XmlRpcMethod::OK if allowed
• XmlRpcMethod::FAILED if not allowed,
• XmlRpcMethod::REQUIRE_AUTHENTICATION if authentication is missing or invalid.

Reimplemented in ConfigRPC_InDomainCallback.

void modified

(

)

[virtual]

Invoked after the database has been modified.

const char* methodName

(

Method

method

)

const [protected]

ConfigRPC_Callback& operator=

(

const ConfigRPC_Callback &

noassignment

)

[private]

no assignment operator