XmlRpcMethod Class Reference

A XmlRpcMethod is a dynamically loaded object that is invoked by the XmlRpcDispatch during the runtime. More...

#include <XmlRpcMethod.h>

Inheritance diagram for XmlRpcMethod:

Public Types
enum	ExecutionStatus {   OK,   FAILED,   REQUIRE_AUTHENTICATION }
typedef enum XmlRpcMethod::ExecutionStatus	ExecutionStatus
typedef XmlRpcMethod *	Get()

Public Member Functions
virtual	~XmlRpcMethod ()
	Destructor. More...
virtual bool	execute (const HttpRequestContext &requestContext, UtlSList &params, void *userData, XmlRpcResponse &response, ExecutionStatus &status)=0
	Execute the method. Subclasses must provide a definition for this method. More...

Static Public Member Functions
static XmlRpcMethod *	get ()
	Get the instance of this method. Subclasses must provide a definition for this method. More...

Protected Member Functions
	XmlRpcMethod ()
	Constructor. More...

Detailed Description

A XmlRpcMethod is a dynamically loaded object that is invoked by the XmlRpcDispatch during the runtime.

This class is the abstract base from which all XML-RPC methods must inherit. Two methods must be implemented by the subclasses:

• get() is for XmlRpcDispatch to instantiate the subclass during the runtime. It is not a singleton class. The XmlRpcMethod derived objects will be deleted after each use in XmlRpcDispatch.
• execute() is for XmlRpcDispatch to execute the XML-RPC request and send back the XmlRpcResponse to the client side.

All the params in the XML-RPC request are stored in a UtlSList and passed to the service in execute(). All the param values are stored in UtlContainable types. The mapping between XML-RPC value types and UtlContainable types is:

• <i4> or <int> is UtlInt
• <i8> is UtlLongLongInt
• <boolean> is UtlBool
• <string> is UtlString
• <dateTime.iso8601> is UtlDateTime
• <array> is UtlSList
• <struct> is UtlHashMap

<i8> is a SIPfoundry extension to XML-RPC that is not compatible with other XML-RPC implementations. <double> and <base64> are currently not supported.

Member Typedef Documentation

typedef enum XmlRpcMethod::ExecutionStatus ExecutionStatus

typedef XmlRpcMethod* Get()

Member Enumeration Documentation

enum ExecutionStatus

Enumerator
OK
FAILED
REQUIRE_AUTHENTICATION

Constructor & Destructor Documentation

~XmlRpcMethod ( )

virtual

Destructor.

XmlRpcMethod ( )

protected

Constructor.

Member Function Documentation

XmlRpcMethod * get ( void  )

static

Get the instance of this method. Subclasses must provide a definition for this method.

virtual bool execute ( const HttpRequestContext &  requestContext, UtlSList &  params, void *  userData, XmlRpcResponse &  response, ExecutionStatus &  status  )

pure virtual

Execute the method. Subclasses must provide a definition for this method.

execution status

Parameters

requestContext	request context
params	request param list
userData	user data
response	request response

Implemented in ProvisioningAgentXmlRpcAction, ProvisioningAgentXmlRpcGet, ProvisioningAgentXmlRpcSet, ProvisioningAgentXmlRpcDelete, and ProvisioningAgentXmlRpcCreate.