sipxtacklib  Version 3.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
XmlRpcMethod Class Referenceabstract

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

#include <XmlRpcMethod.h>

Inheritance diagram for XmlRpcMethod:
Inheritance graph
[legend]

Public Types

enum  ExecutionStatus {
  OK,
  FAILED,
  REQUIRE_AUTHENTICATION
}
 
typedef enum XmlRpcMethod::ExecutionStatus ExecutionStatus
 
typedef XmlRpcMethodGet()
 

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 XmlRpcMethodget ()
 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:

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:

<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 XmlRpcMethod* Get()

Member Enumeration Documentation

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
requestContextrequest context
paramsrequest param list
userDatauser data
responserequest response

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


sipXtackLib home page