bool ProvisioningAgentXmlRpcAction::execute(const HttpRequestContext& rContext,
UtlSList& rParameters,
void* pProvisioningAgentInstance,
XmlRpcResponse& rResponse,
XmlRpcMethod::ExecutionStatus& rStatus)
{
rStatus = XmlRpcMethod::OK;
// Extract the request argument structure from the head of the SList.
UtlContainable *pRequestArgs = rParameters.at(0);
// Verify that a parameter list was given
if (pRequestArgs != NULL) {
// Verify that the parameter list is a structure ("UtlHashMap").
if (UtlString(pRequestArgs->getContainableType()) == "UtlHashMap") {
// Now call the Provisioning Agent.
ProvisioningAttrList requestAttributes(dynamic_cast<UtlHashMap*>(pRequestArgs));
ProvisioningAttrList* pResponseAttributes;
pResponseAttributes = ((ProvisioningAgent*)pProvisioningAgentInstance)->Action(requestAttributes);
if (pResponseAttributes == NULL) {
// Method failure. Report error back to client
rResponse.setFault(METHOD_DISPATCH_FAULT_CODE, METHOD_DISPATCH_FAULT_STRING);
}
else {
// Encode the response
rResponse.setResponse(dynamic_cast<UtlContainable*>(pResponseAttributes->getData()));
// and clean up the responsettributes list.
delete pResponseAttributes;
}
}
else {
// Missing parameter list. Report error back to client
rResponse.setFault(EXPECTED_STRUCT_FAULT_CODE, EXPECTED_STRUCT_FAULT_STRING);
}
}
else {
// Bad parameter list. Report error back to client
rResponse.setFault(EXPECTED_STRUCT_FAULT_CODE, EXPECTED_STRUCT_FAULT_STRING);
}
return true;
}
void ACDAudio::setAttributes(ProvisioningAttrList& rRequestAttributes)
{
mLock.acquire();
// Set the individual attributes
// name
rRequestAttributes.getAttribute(AUDIO_NAME_TAG, mName);
// local-store
rRequestAttributes.getAttribute(AUDIO_LOCAL_STORE_TAG, mLocalStore);
// uri
rRequestAttributes.getAttribute(AUDIO_URI_TAG, mUriString);
// description
rRequestAttributes.getAttribute(AUDIO_DESCRIPTION_TAG, mDescription);
mLock.release();
}
ProvisioningAttrList* ACDAudioManager::Delete(ProvisioningAttrList& rRequestAttributes)
{
ProvisioningAttrList* pResponse;
UtlString name;
osPrintf("{method} = delete\n{object-class} = acd-audio\n");
rRequestAttributes.dumpAttributes();
osPrintf("\n");
// Extract the instance index from the request attributes.
rRequestAttributes.getAttribute(AUDIO_NAME_TAG, name);
mLock.acquire();
// Verify that the instance has already been created.
TiXmlNode* pInstanceNode = findPSInstance(ACD_AUDIO_TAG, AUDIO_NAME_TAG, name);
if (pInstanceNode == NULL) {
// There is no instance.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "delete");
pResponse->setAttribute("result-code", ProvisioningAgent::UNKNOWN_OBJECT);
pResponse->setAttribute("result-text", "Unknown instance");
return pResponse;
}
// If Administrative State == ACTIVE, delete the ACDAudio object
// For now - do not allow this to be deleted on fly - for protection
#if 0
if (mpAcdServer->getAdministrativeState() == ACDServer::ACTIVE) {
deleteACDAudio(name);
}
#endif
// Remove the instance from the configuration file
deletePSInstance(ACD_AUDIO_TAG, AUDIO_NAME_TAG, name);
// Update the configuration file
OsSysLog::add(LOG_FACILITY, PRI_INFO, "ACDAudioManager::Delete - Updating the config file");
mpXmlConfigDoc->SaveFile();
mLock.release();
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "delete");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS");
return pResponse;
}
void ACDAudio::getAttributes(ProvisioningAttrList& rRequestAttributes, ProvisioningAttrList*& prResponse)
{
// See if there are any specific attributes listed in the request
if (rRequestAttributes.attributePresent(AUDIO_LOCAL_STORE_TAG) ||
rRequestAttributes.attributePresent(AUDIO_URI_TAG) ||
rRequestAttributes.attributePresent(AUDIO_DESCRIPTION_TAG)) {
// At least one attribute has been requested, go through list and retrieve
// name
if (rRequestAttributes.attributePresent(AUDIO_NAME_TAG)) {
prResponse->setAttribute(AUDIO_NAME_TAG, mName);
}
// local-store
if (rRequestAttributes.attributePresent(AUDIO_LOCAL_STORE_TAG)) {
prResponse->setAttribute(AUDIO_LOCAL_STORE_TAG, mLocalStore);
}
// uri
if (rRequestAttributes.attributePresent(AUDIO_URI_TAG)) {
prResponse->setAttribute(AUDIO_URI_TAG, mUriString);
}
// description
if (rRequestAttributes.attributePresent(AUDIO_DESCRIPTION_TAG)) {
prResponse->setAttribute(AUDIO_DESCRIPTION_TAG, mDescription);
}
}
else {
// No specific attributes were requested, send them all back
// name
prResponse->setAttribute(AUDIO_NAME_TAG, mName);
// local-store
prResponse->setAttribute(AUDIO_LOCAL_STORE_TAG, mLocalStore);
// uri
prResponse->setAttribute(AUDIO_URI_TAG, mUriString);
// description
prResponse->setAttribute(AUDIO_DESCRIPTION_TAG, mDescription);
}
}
ProvisioningAttrList* ACDAudioManager::Get(ProvisioningAttrList& rRequestAttributes)
{
ProvisioningAttrList* pResponse;
ProvisioningAttrList* pAudioInstance;
UtlString name;
UtlSList* pAudioList;
osPrintf("{method} = get\n{object-class} = acd-audio\n");
rRequestAttributes.dumpAttributes();
osPrintf("\n");
mLock.acquire();
// Extract the instance index from the request attributes.
if (rRequestAttributes.getAttribute(AUDIO_NAME_TAG, name)) {
// A specific instance has been specified, verify that it exists
ACDAudio* pAudioRef = getAcdAudioReference(name);
if (pAudioRef == NULL) {
// There is no instance.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "get");
pResponse->setAttribute("result-code", ProvisioningAgent::UNKNOWN_OBJECT);
pResponse->setAttribute("result-text", "Unknown instance");
return pResponse;
}
// Call the instance to get the requested attributes
pResponse = new ProvisioningAttrList;
try {
pAudioRef->getAttributes(rRequestAttributes, pResponse);
}
catch (UtlString error) {
// The request for attributes failed, send back the response
mLock.release();
pResponse->setAttribute("method-name", "get");
pResponse->setAttribute("result-code", ProvisioningAgent::FAILURE);
pResponse->setAttribute("result-text", error);
return pResponse;
}
// Send back the response
mLock.release();
pResponse->setAttribute("method-name", "get");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS");
pResponse->setAttribute("object-class", ACD_AUDIO_TAG);
pResponse->setAttribute(AUDIO_NAME_TAG, name);
return pResponse;
}
else {
// No specific instance was requested, send back a list of the available instances
// Find the first instance.
TiXmlNode* pInstanceNode = findPSInstance(ACD_AUDIO_TAG);
pAudioList = new UtlSList;
// Build up a list of instances
while (pInstanceNode != NULL) {
// Read the index parameter
getPSAttribute(pInstanceNode, AUDIO_NAME_TAG, name);
// Create the list entry
pAudioInstance = new ProvisioningAttrList;
pAudioInstance->setAttribute("object-class", ACD_AUDIO_TAG);
pAudioInstance->setAttribute(AUDIO_NAME_TAG, name);
pAudioList->append(pAudioInstance->getData());
// Get the next instance.
pInstanceNode = pInstanceNode->NextSibling();
}
// Send back the response
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "get");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS");
pResponse->setAttribute("object-class-list", pAudioList);
return pResponse;
}
}
ProvisioningAttrList* ACDAudioManager::Set(ProvisioningAttrList& rRequestAttributes)
{
ProvisioningAttrList* pResponse;
UtlString name;
UtlString uriString;
UtlString description;
bool localStore;
osPrintf("{method} = set\n{object-class} = acd-audio\n");
rRequestAttributes.dumpAttributes();
osPrintf("\n");
// Extract the instance index from the request attributes.
rRequestAttributes.getAttribute(AUDIO_NAME_TAG, name);
mLock.acquire();
// Verify that the instance has already been created.
TiXmlNode* pInstanceNode = findPSInstance(ACD_AUDIO_TAG, AUDIO_NAME_TAG, name);
if (pInstanceNode == NULL) {
// There is no instance.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "set");
pResponse->setAttribute("result-code", ProvisioningAgent::UNKNOWN_OBJECT);
pResponse->setAttribute("result-text", "Unknown instance");
return pResponse;
}
// Validate that the attribute types are correct, ignoring any that are missing
try {
rRequestAttributes.validateAttributeType(AUDIO_URI_TAG, ProvisioningAttrList::STRING);
rRequestAttributes.validateAttributeType(AUDIO_DESCRIPTION_TAG, ProvisioningAttrList::STRING);
rRequestAttributes.validateAttributeType(AUDIO_LOCAL_STORE_TAG, ProvisioningAttrList::BOOL);
}
catch (UtlString error) {
// One of the attributes is not set to the correct type
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "set");
pResponse->setAttribute("result-code", ProvisioningAgent::INVALID_ATTR);
pResponse->setAttribute("result-text", error);
return pResponse;
}
// If Administrative State == ACTIVE, update the ACDAudio object
if (mpAcdServer->getAdministrativeState() == ACDServer::ACTIVE) {
// Lookup the instance
ACDAudio* pAudioRef = getAcdAudioReference(name);
if (pAudioRef == NULL) {
// There is no instance.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "set");
pResponse->setAttribute("result-code", ProvisioningAgent::UNKNOWN_OBJECT);
pResponse->setAttribute("result-text", "Unknown instance");
return pResponse;
}
// Give the list of changed attributes to the object
try {
pAudioRef->setAttributes(rRequestAttributes);
}
catch (UtlString error) {
// The object rejected the request, return error.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "set");
pResponse->setAttribute("result-code", ProvisioningAgent::INVALID_ATTR);
pResponse->setAttribute("result-text", error);
return pResponse;
}
}
// Now save the individual attributes
// local-store
if (rRequestAttributes.getAttribute(AUDIO_LOCAL_STORE_TAG, localStore)) {
setPSAttribute(pInstanceNode, AUDIO_LOCAL_STORE_TAG, localStore);
}
// uri
if (rRequestAttributes.getAttribute(AUDIO_URI_TAG, uriString)) {
setPSAttribute(pInstanceNode, AUDIO_URI_TAG, uriString);
}
// description
if (rRequestAttributes.getAttribute(AUDIO_DESCRIPTION_TAG, description)) {
setPSAttribute(pInstanceNode, AUDIO_DESCRIPTION_TAG, description);
}
// Update the configuration file
OsSysLog::add(LOG_FACILITY, PRI_INFO, "ACDAudioManager::Set - Updating the config file");
mpXmlConfigDoc->SaveFile();
mLock.release();
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "set");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS");
return pResponse;
}
ProvisioningAttrList* ACDAudioManager::Create(ProvisioningAttrList& rRequestAttributes)
{
ProvisioningAttrList* pResponse;
UtlString name;
UtlString uriString;
UtlString description;
bool localStore;
osPrintf("{method} = create\n{object-class} = acd-audio\n");
rRequestAttributes.dumpAttributes();
osPrintf("\n");
// Verify that the required set of attributes are there.
try {
rRequestAttributes.validateAttribute(AUDIO_NAME_TAG, ProvisioningAttrList::STRING);
rRequestAttributes.validateAttribute(AUDIO_LOCAL_STORE_TAG, ProvisioningAttrList::BOOL);
rRequestAttributes.validateAttribute(AUDIO_URI_TAG, ProvisioningAttrList::STRING);
}
catch (UtlString error) {
// We're missing at least one mandatory attribute.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "create");
pResponse->setAttribute("result-code", ProvisioningAgent::MISSING_ATTR);
pResponse->setAttribute("result-text", error);
return pResponse;
}
// Extract the instance index from the request attributes.
rRequestAttributes.getAttribute(AUDIO_NAME_TAG, name);
mLock.acquire();
// Verify that an instance of this object has not already been created.
TiXmlNode* pInstanceNode = findPSInstance(ACD_AUDIO_TAG, AUDIO_NAME_TAG, name);
if (pInstanceNode != NULL) {
//The instance has already been created, send back the response.
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "create");
#ifdef CML
pResponse->setAttribute("result-code", ProvisioningAgent::ALREADY_EXISTS);
#else
pResponse->setAttribute("result-code", ProvisioningAgent::DUPLICATE);
#endif
pResponse->setAttribute("result-text", "Managed Object Instance already exists");
return pResponse;
}
// Validate that the optional attribute types are correct, ignoring any that are missing
try {
rRequestAttributes.validateAttributeType(AUDIO_DESCRIPTION_TAG, ProvisioningAttrList::STRING);
}
catch (UtlString error) {
// One of the optional attributes is not set to the correct type
mLock.release();
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "create");
pResponse->setAttribute("result-code", ProvisioningAgent::INVALID_ATTR);
pResponse->setAttribute("result-text", error);
return pResponse;
}
// Create the instance in the configuration file
pInstanceNode = createPSInstance(ACD_AUDIO_TAG, AUDIO_NAME_TAG, name);
if (pInstanceNode == NULL) {
mLock.release();
// Instance creation failed.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "create");
pResponse->setAttribute("result-code", ProvisioningAgent::UNDEFINED);
pResponse->setAttribute("result-text", "Managed Object Instance creation failed");
return pResponse;
}
// Now save the individual attributes
// local-store
if (rRequestAttributes.getAttribute(AUDIO_LOCAL_STORE_TAG, localStore)) {
setPSAttribute(pInstanceNode, AUDIO_LOCAL_STORE_TAG, localStore);
}
// uri (optional)
if (rRequestAttributes.getAttribute(AUDIO_URI_TAG, uriString)) {
setPSAttribute(pInstanceNode, AUDIO_URI_TAG, uriString);
}
// description (optional)
if (rRequestAttributes.getAttribute(AUDIO_DESCRIPTION_TAG, description)) {
setPSAttribute(pInstanceNode, AUDIO_DESCRIPTION_TAG, description);
}
// If Administrative State == ACTIVE, create the ACDAgent
if (mpAcdServer->getAdministrativeState() == ACDServer::ACTIVE) {
createACDAudio(name, localStore, uriString, description);
}
// Update the configuration file
OsSysLog::add(LOG_FACILITY, PRI_INFO, "ACDAudioManager::Create - Updating the config file");
mpXmlConfigDoc->SaveFile();
mLock.release();
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "create");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS");
return pResponse;
}
ProvisioningAttrList* XmlRpcSignIn::Action(ProvisioningAttrList& rRequestAttributes)
{
ProvisioningAttrList* pResponse;
UtlString uriString;
UtlString status;
osPrintf("{method} = action\n{object-class} = login\n");
rRequestAttributes.dumpAttributes();
osPrintf("\n");
// Extract the action attribute from the request
// operate on either sign-in or sign-out attributes
if (rRequestAttributes.getAttribute(XMLRPC_SIGN_IN_TAG, uriString)) {
// See if the Agent is not already signed-in
Url contactUrl(uriString);
mpSipPresenceMonitor->getState(contactUrl, status);
if (status.compareTo(STATUS_OPEN) == 0) {
// Already signed-in, return error
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS: User already signed-in");
return pResponse;
}
// Sign-in the Agent
mpSipPresenceMonitor->setStatus(contactUrl, StateChangeNotifier::PRESENT);
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS: sign-in");
return pResponse;
}
else if (rRequestAttributes.getAttribute(XMLRPC_SIGN_OUT_TAG, uriString)) {
// See if the Agent is not already signed-out
Url contactUrl(uriString);
mpSipPresenceMonitor->getState(contactUrl, status);
if (status.compareTo(STATUS_CLOSED) == 0) {
// Already signed-out, return error
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS: User already signed-out");
return pResponse;
}
// Sign-out the Agent
mpSipPresenceMonitor->setStatus(contactUrl, StateChangeNotifier::AWAY);
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", "SUCCESS: sign-out");
return pResponse;
}
else if (rRequestAttributes.getAttribute(XMLRPC_SIGN_IN_STATUS_TAG, uriString)) {
// Get the Agent status
Url contactUrl(uriString);
mpSipPresenceMonitor->getState(contactUrl, status);
// Build up the response.
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::SUCCESS);
pResponse->setAttribute("result-text", status);
return pResponse;
}
else {
// Unrecognized or missing action-object
pResponse = new ProvisioningAttrList;
pResponse->setAttribute("method-name", "action");
pResponse->setAttribute("result-code", ProvisioningAgent::FAILURE);
pResponse->setAttribute("result-text", "Invalid action operation");
return pResponse;
}
}
