[VCL-617] new XML-RPC methods

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.3
• Fix Version/s: 2.3.1, 2.4
• Component/s: web gui (frontend)
• Assignee: Aaron Coburn
• Reporter: Aaron Coburn
• Created: 16/Aug/12 20:07
• Updated: 07/Sep/12 14:37
• Resolved: 07/Sep/12 14:37

Description

I have written some code to expand the methods available to the XML-RPC interface. I have a particular interest in having the following methods available –

methods for modifying the privilege tree:

XMLRPCgetNodeTree(int rootNode=0)
XMLRPCaddNode(string nodeName, int parentID)
XMLRPCremoveNode(int nodeID)
XMLRPCnodeExists(string nodeName, int parentID)
XMLRPCaddResourceGroupPriv(string groupName, string resourceType, int nodeID, string permissions)
XMLRPCgetResourceGroupPriv(string groupName, string resourceType, int nodeID)
XMLRPCremoveResourceGroupPriv(string groupName, string resourceType, int nodeID, string permissions)
XMLRPCaddUserGroupPriv(string groupName, string affiliation, int nodeID, string permissions)
XMLRPCgetResourceGroupPriv(string groupName, string affiliation, int nodeID)
XMLRPCremoveUserGroupPriv(string groupName, string affiliation, int nodeID, string permissions)

methods for adding user and resource groups:

XMLRPCaddResourceGroup(string name, string managingGroup, string resourceType)
XMLRPCgetResourceGroups(string resourceType)
XMLRPCremoveResourceGroup(string name, string resourceType)
XMLRPCgetUserGroups(int groupType=0, int affiliationid=0)

methods for modifying image mappings:

XMLRPCaddImageToGroup(string groupName, int imageID)
XMLRPCremoveImageFromGroup(string groupName, int imageID)
XMLRPCgetGroupImages(string groupName)

The return values follow the structure of the existing interface, with the XMLRPCadd* and XMLRPCremove* functions returning a simple array('status' => 'success') on success. The get* functions return an additional array of data.

Before I submit the code, I thought it might be worthwhile to discuss the function interface – some of you may have opinions about how the methods are called, especially since this nearly doubles the number of existing API functions.