LiveSupport::Scheduler::CreateBackupCheckMethod Class Reference

#include <CreateBackupCheckMethod.h>

Inheritance diagram for LiveSupport::Scheduler::CreateBackupCheckMethod:

[legend]Collaboration diagram for LiveSupport::Scheduler::CreateBackupCheckMethod:

[legend]List of all members.

---

Detailed Description

An XML-RPC method object to check the progress of a backup creation process.

The name of the method when called through XML-RPC is "createBackupCheck".

The expected parameter is an XML-RPC structure with a single member:

• token - string - the token obtained from createBackupOpen

On success, returns an XML-RPC struct, with the following members:

• status - string - on of "success", "working" or "fault"
• url - string - if the status is "success", this contains a readable URL of the new backup archive
• path - string - if the status is "success", this contains the local access path of the new backup archive
• faultString - string - if the status is "fault", this contains the error message.

In case of an error, a standard XML-RPC fault response is generated, and a { faultCode, faultString } structure is returned. The possible errors are:

• 4101 - invalid argument format
• 4102 - missing token argument
• 4110 - error reported by the scheduler daemon
• 4111 - syntax error in the values returned by the scheduler daemon

Author:

Author

fgerlits

Version:

Revision

2329

Definition at line 104 of file CreateBackupCheckMethod.h.

Public Member Functions
	CreateBackupCheckMethod (void) throw ()
	A default constructor, for testing purposes.
	CreateBackupCheckMethod (Ptr< XmlRpc::XmlRpcServer >::Ref xmlRpcServer) throw ()
	Constuctor that registers the method with the server right away.
void	execute (XmlRpc::XmlRpcValue ¶meters, XmlRpc::XmlRpcValue &returnValue) throw (XmlRpc::XmlRpcException)
	Execute the createBackupOpen command on the Scheduler daemon.

---

Constructor & Destructor Documentation

LiveSupport::Scheduler::CreateBackupCheckMethod::CreateBackupCheckMethod

(

void

)

throw () [inline]

A default constructor, for testing purposes.

Definition at line 123 of file CreateBackupCheckMethod.h.

CreateBackupCheckMethod::CreateBackupCheckMethod

(

Ptr< XmlRpc::XmlRpcServer >::Ref

xmlRpcServer

)

throw ()

Constuctor that registers the method with the server right away.

Parameters:

xmlRpcServer

the XML-RPC server to register with.

Definition at line 70 of file CreateBackupCheckMethod.cxx.

---

Member Function Documentation

void CreateBackupCheckMethod::execute	(	XmlRpc::XmlRpcValue &	parameters,
		XmlRpc::XmlRpcValue &	returnValue
	)			throw (XmlRpc::XmlRpcException)

Execute the createBackupOpen command on the Scheduler daemon.

Parameters:

	parameters	XML-RPC function call parameters
	returnValue	the return value of the call (out parameter)

Definition at line 82 of file CreateBackupCheckMethod.cxx.

References LiveSupport::Core::XmlRpcException::what().

---

The documentation for this class was generated from the following files:

• CreateBackupCheckMethod.h
• CreateBackupCheckMethod.cxx

---